Skip to content

Commit 3fbf7e2

Browse files
committed
chore: expand description
1 parent 1f713f0 commit 3fbf7e2

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

src/components/AvatarStack/types.ts

+18-1
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,26 @@ export interface AvatarStackProps {
1616
* | `xl` | `l` |
1717
*/
1818
overlapSize?: AvatarStackOverlapSize;
19+
/**
20+
* Size for control displaying count of extra avatars
21+
*/
1922
size?: AvatarSize;
2023
className?: string;
21-
/** Avatars and optionally `<AvatarStack.MoreButton/>` */
24+
/**
25+
* Children would be wrapped for "stacking"
26+
* @example
27+
* <AvatarStack>
28+
* <Avatar/>
29+
* <Tooltip content="Some info"><Avatar/></Tooltip>
30+
* </AvatarStack>
31+
*/
2232
children?: React.ReactNode;
33+
/**
34+
* Custom render for control displaying extra data
35+
* @example
36+
* <AvatarStack renderMoreButton={({count}) => <Button>+{count}</Button>}>
37+
* <Avatar/>
38+
* </AvatarStack>
39+
*/
2340
renderMoreButton?: (options: {count: number}) => React.ReactElement;
2441
}

0 commit comments

Comments
 (0)