Skip to content

Commit 1f713f0

Browse files
committed
chore: expand description
1 parent a3ee561 commit 1f713f0

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

src/components/AvatarStack/types.ts

+8-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,14 @@ export type AvatarStackOverlapSize = 's' | 'm' | 'l';
77
export interface AvatarStackProps {
88
/** Amount of avatars to be shown before more button. Default 3. */
99
max?: number;
10-
/** How much each avatar should overlap next one */
10+
/**
11+
* How much each avatar should overlap next one
12+
* | Avatar sizes | Recommended overlap |
13+
* | :----------: | :-----------------: |
14+
* | `xs`-`m` | `s` |
15+
* | `l` | `m` |
16+
* | `xl` | `l` |
17+
*/
1118
overlapSize?: AvatarStackOverlapSize;
1219
size?: AvatarSize;
1320
className?: string;

0 commit comments

Comments
 (0)