# @fayegram-ai/faye-ui/display/avatar-group

Public exports and dependency-resolved component properties, with usage and rendering guidance.

## Import

```tsx
import { AvatarGroup } from '@fayegram-ai/faye-ui/display/avatar-group';
```

[Usage and behavior guide](/docs/display/) · [API JSON](/api/packages/display/avatar-group.json)

This entry has no declared client boundary; individual exported behavior still follows its rendering contract.

## Public exports

| Name | Kind | Resolved declaration type |
|---|---|---|
| `AvatarGroup` | value | `({ profile, max, children, total, remainderLabel, className, ...props }: HTMLAttributes<HTMLDivElement> & { profile?: ComponentProfile; max?: number; total?: number; remainderLabel?: (count: number) => string; children: ReactNode; }) => import("react").JSX.Element` |

## AvatarGroup

Public component; use the linked family guide for complete composition and behavior.

Dependency-resolved declaration properties. Common React/native HTML attributes are omitted from the table; use the full declaration and React/native references. Generic and union restrictions remain authoritative in TypeScript.

### Properties

| Property | Required | Type | Meaning |
|---|---|---|---|
| `children` | Yes | `ReactNode` | See the usage contract and declaration. |
| `max` | No | `number \| undefined` | See the usage contract and declaration. |
| `profile` | No | `ComponentProfile \| undefined` | See the usage contract and declaration. |
| `remainderLabel` | No | `((count: number) => string) \| undefined` | See the usage contract and declaration. |
| `total` | No | `number \| undefined` | See the usage contract and declaration. |



## Defaults and customization

Descriptor defaults: `{}`. Parts: `root`, `remainder`. Explicit instance props take precedence over configured defaults.

Use semantic tokens, public part hooks and customization sheets. Keep visual configuration separate from application state.

## State, events and accessibility

For interactive controls, pair a controlled value/open prop with its corresponding change callback; default props initialize uncontrolled state. Keep application validation and submission policy explicit. Name controls with visible labels, name icon-only actions on the button, and preserve focus and dismissal behavior when replacing parts. Use native form names and submit/reset types where supported. See the usage guide for component-specific behavior and live examples.

## Declaration authority

Generated from `packages/faye-ui/dist/display/avatar-group.d.ts` after the semantic package build. Common native/React attributes are intentionally omitted from property tables. Generic overloads, discriminated unions and complete inherited attributes remain authoritative in installed TypeScript declarations. [React DOM attributes](https://react.dev/reference/react-dom/components/common) and [Base UI component contracts](https://base-ui.com/react/overview/quick-start) describe the inherited foundations.