Also available as vitreui— the same library under a shorter name.npm i vitreui
Skip to content

Avatar Group

Overlapping avatars with an overflow count label.

Group: Data Display · Import path: @orionshub/lucent/avatar-group · Client component — ships a "use client" boundary.

Import

tsx
import { AvatarGroup } from '@orionshub/lucent'
import '@orionshub/lucent/styles.css' // once, at your app root

Examples

Overflow count

Overflow count
Show source
tsx
export function AvatarGroupBasic() {
  return (
    <AvatarGroup max={3}>
      <Avatar fallback="AB" alt="Ada B" />
      <Avatar fallback="CD" alt="Carl D" />
      <Avatar fallback="EF" alt="Eve F" />
      <Avatar fallback="GH" alt="Gus H" />
      <Avatar fallback="IJ" alt="Ivy J" />
    </AvatarGroup>
  )
}

Props

PropTypeDefaultDescription
childrenReact.ReactNode
maxnumber | undefinedMaximum avatars to show before collapsing into a "+N" chip.

Guidance

One-time CSS import

Import the compiled stylesheet once at your app root: import '@orionshub/lucent/styles.css'. Components ship stable class names and read design tokens from CSS custom properties — there is no style runtime. See CSS Import.

Transparency & solid mode

Every glass surface reads --lucent-glass-opacity (0.60–1.0). Dial it at runtime with setGlassOpacity(), or switch to setContrast('solid') for a fully opaque, high-contrast rendering. See Transparency & Solid Mode.

RTL

Authored with CSS logical properties — set dir="rtl" on a parent (or the document) and layout mirrors with no JS. Toggle RTL from the glass-controls panel to preview. See RTL Support.

SSR / Next.js

Client component — ships a "use client" boundary. All components are safe to import in a Server Component tree; interactive ones carry their own "use client" boundary. See SSR & Next.js.

Released under the MIT License.