@hanzo/ui

Avatar Group

import { AvatarGroup } from '@hanzo/ui'

No examples yet.

Types

export type AvatarGroupProps = Omit<ComponentProps<typeof XStack>, 'children'> & {
  /** The avatars, in order. */
  avatars: ReactNode[]
  /** How many are drawn before the rest become "+N". */
  maxVisible?: number
  /** Everyone, when the list supplied is a page of a larger set. */
  total?: number
  /** Draw the overflow yourself, given how many are hidden. */
  renderOverflow?: (hidden: number) => ReactNode
  overflowShape?: AvatarShape
  /** Which neighbour is on top: `right` draws each later avatar over the one before. */
  overlap?: 'right' | 'left'
  overlapOffset?: number
}

Exports

AvatarGrouptype AvatarGroupProps