From 88e28e4279ce4ac53ad4bb7fa05a37c4a4c83a41 Mon Sep 17 00:00:00 2001 From: Alexey Sudilovskiy Date: Tue, 30 Jan 2024 00:46:57 +0100 Subject: [PATCH] docs: reflect api changes --- src/components/AvatarStack/README.md | 33 +++++++++------------------- 1 file changed, 10 insertions(+), 23 deletions(-) diff --git a/src/components/AvatarStack/README.md b/src/components/AvatarStack/README.md index 98cd947b88..8a5ae1bb3f 100644 --- a/src/components/AvatarStack/README.md +++ b/src/components/AvatarStack/README.md @@ -15,30 +15,17 @@ Stack of images with overlap over next image and optional control. This is usual Component is not limit you to what components to render, basic usage is: ```tsx - } - renderMore={(items) => } -/> + + + + + ``` ## Properties -| Name | Description | Type | Default | -| :----------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-----------------------------------------------------: | :-----: | -| displayCount | How much items should be visible | `number` | 2 | -| overlapSize | How much each item should overlap next one. `s` recommended for `UserAvatars` of sizes `xs`-`m`, `m` recomended for `l` size avatars and `l` overlap for `xl` avatars | `s`, `m`, `l` | `s` | -| className | Class name of root DOM node | `string` | | -| items | Array of items to render | `Object[]` | | -| renderItem | Render function for rendering `items`. First argument is item from `items` prop, and second argument is options with `itemClassName`, that should be applied for visible children, for correct alignment | `(item, options: {itemClassName: string}) => ReactNode` | | -| renderMore | Render function for rendering button, if there is a hidden items. Function receives this items as first argument | `(items) => reactNode` | | +| Name | Description | Type | Default | +| :---------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-----------: | :-----: | +| overlapSize | How much each item should overlap next one. `s` recommended for `UserAvatars` of sizes `xs`-`m`, `m` recomended for `l` size avatars and `l` overlap for `xl` avatars | `s`, `m`, `l` | `s` | +| className | Class name of root DOM node | `string` | | +| children | List of avatars, probably with some extra wrappers | `Object[]` | |