You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
37 lines
980 B
37 lines
980 B
2 years ago
|
import { Story, Canvas, ArgsTable } from '@storybook/addon-docs';
|
||
|
|
|
||
|
|
import { AvatarWithBadge } from './avatar-with-badge';
|
||
|
|
|
||
|
|
# AvatarWithBadge
|
||
|
|
|
||
|
|
The `AvatarWithBadge` is a wrapper component that adds badge display options to avatars.
|
||
|
|
|
||
|
|
<Canvas>
|
||
|
|
<Story id="ui-components-component-library-avatar-with-badge-avatar-with-badge-stories-js--default-story" />
|
||
|
|
</Canvas>
|
||
|
|
|
||
|
|
## Props
|
||
|
|
|
||
|
|
The `AvatarWithBadge` accepts all props below
|
||
|
|
|
||
|
|
<ArgsTable of={AvatarWithBadge} />
|
||
|
|
|
||
|
|
### Badge Position
|
||
|
|
|
||
|
|
Use the `badgePosition` prop to set the position of the badge, it can have two values `Top` and `Bottom`
|
||
|
|
|
||
|
|
<Canvas>
|
||
|
|
<Story id="ui-components-component-library-avatar-with-badge-avatar-with-badge-stories-js--badge-positions" />
|
||
|
|
</Canvas>
|
||
|
|
|
||
|
|
### Badge
|
||
|
|
|
||
|
|
Used to define the badge component to be rendered inside the `AvatarWithBadge`
|
||
|
|
|
||
|
|
### Badge Props
|
||
|
|
|
||
|
|
The required props to be passed to the badge.
|
||
|
|
|
||
|
|
### Children
|
||
|
|
|
||
|
|
The children to be rendered inside the AvatarWithBadge. Generally used with the `AvatarAccount`
|