Types

Link copied to clipboard
interface ComponentsProps

Properties

Link copied to clipboard
abstract override var children: ReactNode?

The avatars to stack.

Link copied to clipboard

Override or extend the styles applied to the component.

Link copied to clipboard
abstract var component: ElementType<*>?

The component used for the root node. Either a string to use a HTML element or a component.

Link copied to clipboard

The extra props for the slot components. You can override the existing props or add new ones.

Link copied to clipboard
abstract var key: Key?
Link copied to clipboard
abstract var max: Number?

Max avatars to show before +x.

Link copied to clipboard
abstract var renderSurplus: (surplus: Number) -> ReactNode?

custom renderer of extraAvatars

Link copied to clipboard
Link copied to clipboard
abstract var slots: AvatarGroupSlots?
Link copied to clipboard
abstract var spacing: Union?

Spacing between avatars.

Link copied to clipboard
abstract override var sx: SxProps<Theme>?

The system prop that allows defining system overrides as well as additional CSS styles.

Link copied to clipboard
abstract var total: Number?

The total number of avatars. Used for calculating the number of extra avatars.

Link copied to clipboard

The variant to use.

Functions

Link copied to clipboard
open inline fun <P : Props> child(type: ElementType<P>, props: P)
Link copied to clipboard
open inline operator fun <P : Props> ElementType<P>.invoke()
open inline operator fun <P : Props> ElementType<P>.invoke(noinline block: P.() -> Unit)
open inline operator fun <T> Provider<T>.invoke(value: T, noinline block: ChildrenBuilder.() -> Unit)
Link copied to clipboard
open inline operator fun Char.unaryPlus()
open inline operator fun String?.unaryPlus()
open inline operator fun ReactNode?.unaryPlus()
open inline operator fun Props?.unaryPlus()