IAvatarGroupProps

interface
Component Props

Full props contract for <OrigamAvatarGroup> — stacked / inline row of avatars with overflow management, expand-on-hover/click, and the full design surface (color, border, elevation, spacing, density, size, rounded).

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

Inheritance

Extends

Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.

API

Properties

Every property declared by this interface, with its type, optionality and default.

items
Array<IAvatarProps>
Array of avatar descriptor objects. Each item accepts the full IAvatarProps surface.
max
number
Maximum number of avatars to display before showing a +N overflow indicator.
expandOnHover
boolean
Spread the avatar stack when the group is hovered.
expandOnClick
boolean
Spread the avatar stack when the group is clicked.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Avatar group with max and expand-on-hover

vue