BlogPlaygroundOne

VAvatarGroup API


Props
name
type
default
string | number | boolean
false

Applies border styles to the child v-avatar components.

string | number
undefined

Sets the overlap gap between avatars. Negative values cause avatars to overlap.

boolean
false

Enables a hover animation on child avatars.

SelectItemKey
null

Props object that will be applied to each item component. true will treat the original object as raw props and pass it directly to the component.

(string | Record<string, any>)[]
[]

An array of strings or objects used for automatically generating children components.

string | number
undefined

The total number of avatars to display, including the overflow indicator. E.g. a limit of 3 with 5 items renders 2 avatars and a +3 overflow indicator.

string
undefined

Custom text to display in the overflow avatar. Defaults to +N where N is the number of hidden items.

boolean
false

Reverses the stacking order of the avatars.

string | number
undefined

Sets the size of all child avatars.

string | (new () => any) | FunctionalComponent
'div'

Specify a custom tag used on the root element.

boolean
false

Stacks avatars vertically instead of horizontally.

Slots
never
never
{ props: any; index: number }
{ overflow: number }
never

Custom content to be displayed after the avatar list.

The default Vue slot.

Customize each avatar item. Receives props and index.

Customize the overflow indicator. Receives the count of hidden items.

Custom content to be displayed before the avatar list.