Skip to content

AvatarStack: document variant and shape props in docs and Storybook #7769

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
liuliu-dev wants to merge 1 commit into
base: main
Choose a base branch
from
+19 −1
Open

AvatarStack: document variant and shape props in docs and Storybook #7769

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions packages/react/src/AvatarStack/AvatarStack.docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,18 @@
"defaultValue": "false",
"description": "Do not spread the avatars on hover"
},
{
"name": "variant",
"type": "'cascade' | 'stack'",
"defaultValue": "'cascade'",
"description": "The style of overlapping avatars. 'cascade' increases the overlap for 3rd+ avatars, while 'stack' uses a uniform overlap."
},
{
"name": "shape",
"type": "'circle' | 'square'",
"defaultValue": "'circle'",
"description": "The shape of the avatars."
},
{
"name": "size",
"type": "number | { narrow?: number; regular?: number; wide?: number; }",
Expand Down
8 changes: 7 additions & 1 deletion packages/react/src/AvatarStack/AvatarStack.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,13 @@ export const Default = () => (
)

export const Playground: StoryFn<Args> = args => (
<AvatarStack size={parseSizeFromArgs(args)} alignRight={args.alignRight} disableExpand={args.disableExpand}>
<AvatarStack
size={parseSizeFromArgs(args)}
alignRight={args.alignRight}
disableExpand={args.disableExpand}
variant={args.variant}
shape={args.shape}
>
<Avatar alt="Primer logo" src="https://avatars.githubusercontent.com/primer" />
<Avatar alt="GitHub logo" src="https://avatars.githubusercontent.com/github" />
<Avatar alt="Atom logo" src="https://avatars.githubusercontent.com/atom" />
Expand Down
Loading