mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-12-02 06:07:06 +01:00
4fcbaae32f
* added housekeeping for avatar network * fixed alt * updated story in Readme * fixed indentation and added network src * updated SIZES for avatar network * updated snapshot * updated docs and props * updated name of avatar * removed comments * updated avatar network component * updated readme * updated story for badge * added constants to the root |
||
|---|---|---|
| .. | ||
| avatar-with-badge.constants.js | ||
| avatar-with-badge.js | ||
| avatar-with-badge.scss | ||
| avatar-with-badge.stories.js | ||
| avatar-with-badge.test.js | ||
| index.js | ||
| README.mdx | ||
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-position" />
</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`