# AvatarGroup Documentation

## Installation

```bash
jsrepo add ui/avatar-group
```

## Components

### Root

The root component of the avatar group.

#### Props

| Prop | Type | Default Value | Required | Bindable | Description |
|------|------|--------------|----------|----------|-------------|
| ref | HTMLDivElement | null | false | true | A reference to the avatar group element. |
| children | Snippet | - | false | false | The content of the avatar group. |
| orientation | "vertical" | "horizontal" | horizontal | false | false | The orientation of the avatar group |

### Member

A member of the avatar group.

#### Props

| Prop | Type | Default Value | Required | Bindable | Description |
|------|------|--------------|----------|----------|-------------|


### Etc

Displays a number of additional members not displayed by the avatar group.

#### Props

| Prop | Type | Default Value | Required | Bindable | Description |
|------|------|--------------|----------|----------|-------------|
| ref | HTMLDivElement | null | false | true | A reference to the avatar group etc element. |
| children | Snippet | - | false | false | The content of the avatar group etc. |
| plus | number | - | true | false | The plus number shown next to the avatar group |