diff --git a/src/components/AvatarList/demo/simple.md b/src/components/AvatarList/demo/simple.md index f531e1625a07233ec2174dc3afb137456f4553e3..e941aea9b5d9614c11edb84cc9f7975a6087e455 100644 --- a/src/components/AvatarList/demo/simple.md +++ b/src/components/AvatarList/demo/simple.md @@ -1,9 +1,11 @@ --- order: 0 -title: 基础样例 +title: + zh-CN: 基础样例 + en-US: Basic Usage --- -简单的用户头像列表。 +Simplest of usage. ````jsx import AvatarList from 'ant-design-pro/lib/AvatarList'; diff --git a/src/components/AvatarList/index.en-US.md b/src/components/AvatarList/index.en-US.md new file mode 100644 index 0000000000000000000000000000000000000000..58daaf968f450a2aac91ae2b52899941ba372941 --- /dev/null +++ b/src/components/AvatarList/index.en-US.md @@ -0,0 +1,22 @@ +--- +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` | + +### AvatarList.Item + +| Property | Description | Type | Default | +|----------|------------------------------------------|-------------|-------| +| tips | title tips for avatar item | ReactNode\/string | - | +| src | the address of the image for an image avatar | string | - | diff --git a/src/components/AvatarList/index.md b/src/components/AvatarList/index.zh-CN.md similarity index 92% rename from src/components/AvatarList/index.md rename to src/components/AvatarList/index.zh-CN.md index dc0f7518229158c3c410ff5d37733f48c8f5c8ab..c229a5df3445f92f5fe17adcd883f67e4dad6f4f 100644 --- a/src/components/AvatarList/index.md +++ b/src/components/AvatarList/index.zh-CN.md @@ -1,7 +1,5 @@ --- -title: - en-US: AvatarList - zh-CN: 用户头像列表 +title: AvatarList subtitle: 用户头像列表 order: 1 cols: 1