index.en-US.md 1.1 KB
Newer Older
sin's avatar
sin committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
---
title: AvatarList
order: 1
cols: 1
---

A list of user's avatar for project or group member list frequently. If a large or small AvatarList is desired, set the `size` property to either `large` or `small` and `mini` respectively. Omit the `size` property for a AvatarList with the default size.

## API

### AvatarList

| Property         | Description           | Type                               | Default   |
| ---------------- | --------------------- | ---------------------------------- | --------- |
| size             | size of list          | `large``small``mini`, `default` | `default` |
| maxLength        | max items to show     | number                             | -         |
| excessItemsStyle | the excess item style | CSSProperties                      | -         |

### AvatarList.Item

| Property | Description                                  | Type      | Default |
| -------- | -------------------------------------------- | --------- | ------- |
| tips     | title tips for avatar item                   | ReactNode | -       |
| src      | the address of the image for an image avatar | string    | -       |