mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-11-29 15:50:28 +01:00
87 lines
2.2 KiB
Plaintext
87 lines
2.2 KiB
Plaintext
import { Story, Canvas, ArgsTable } from '@storybook/addon-docs';
|
|
|
|
import { AvatarAccount } from './avatar-account';
|
|
import { AvatarBase } from '../';
|
|
|
|
# AvatarAccount
|
|
|
|
The `AvatarAccount` is a type of avatar reserved for representing accounts.
|
|
|
|
<Canvas>
|
|
<Story id="components-componentlibrary-avataraccount--default-story" />
|
|
</Canvas>
|
|
|
|
## Props
|
|
|
|
The `AvatarAccount` accepts all props below as well as all [Box](/docs/components-ui-box--default-story#props) component props
|
|
|
|
<ArgsTable of={AvatarAccount} />
|
|
|
|
`AvatarAccount` accepts all [AvatarBase](/docs/components-componentlibrary-avatarbase--default-story))
|
|
component props
|
|
|
|
<ArgsTable of={AvatarBase} />
|
|
|
|
### Size
|
|
|
|
Use the `size` prop and the `Size` object from `./ui/helpers/constants/design-system.js` to change the size of `AvatarAccount`
|
|
|
|
Optional: `AVATAR_ACCOUNT_SIZES` from `./ui/components/component-library` object can be used instead of `SIZES`
|
|
|
|
Possible sizes include:
|
|
|
|
- `Size.XS` 16px
|
|
- `Size.SM` 24px
|
|
- `Size.MD` 32px
|
|
- `Size.LG` 40px
|
|
- `Size.XL` 48px
|
|
|
|
Defaults to `SIZES.MD`
|
|
|
|
<Canvas>
|
|
<Story id="components-componentlibrary-avataraccount--size" />
|
|
</Canvas>
|
|
|
|
```jsx
|
|
import { Size } from '../../../helpers/constants/design-system';
|
|
import { AvatarAccount } from '../ui/component-library';
|
|
|
|
<AvatarAccount size={Size.XS} />
|
|
<AvatarAccount size={Size.SM} />
|
|
<AvatarAccount size={Size.MD} />
|
|
<AvatarAccount size={Size.LG} />
|
|
<AvatarAccount size={Size.XL} />
|
|
```
|
|
|
|
### Type
|
|
|
|
Use the `type` prop for the avatar to be rendered, it can either be a Jazzicon or a Blockie
|
|
|
|
<Canvas>
|
|
<Story id="components-componentlibrary-avataraccount--type" />
|
|
</Canvas>
|
|
|
|
```jsx
|
|
import { TYPES } from './avatar-account.constants';
|
|
import { AvatarAccount } from '../ui/component-library';
|
|
|
|
<AvatarAccount type={TYPES.JAZZICON} />
|
|
<AvatarAccount type={TYPES.BLOCKIES} />
|
|
```
|
|
|
|
### Address
|
|
|
|
Use the required `address` for generating images
|
|
|
|
<Canvas>
|
|
<Story id="components-componentlibrary-avataraccount--address" />
|
|
</Canvas>
|
|
|
|
```jsx
|
|
import { TYPES } from './avatar-account.constants';
|
|
import { AvatarAccount } from '../ui/component-library';
|
|
|
|
<AvatarAccount type={TYPES.JAZZICON} address="0x5CfE73b6021E818B776b421B1c4Db2474086a7e1" />
|
|
<AvatarAccount type={TYPES.BLOCKIES} address="0x0" />
|
|
```
|