mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-11-30 16:18:07 +01:00
98 lines
3.3 KiB
Plaintext
98 lines
3.3 KiB
Plaintext
import { Story, Canvas, ArgsTable } from '@storybook/addon-docs';
|
|
|
|
import { AvatarBase } from '../';
|
|
import { AvatarIcon } from './avatar-icon';
|
|
|
|
# AvatarIcon
|
|
|
|
The `AvatarIcon` is an avatar component that renders only an icon inside and is built off the [AvatarBase](/docs/components-componentlibrary-avatarbase--default-story)) component
|
|
|
|
<Canvas>
|
|
<Story id="components-componentlibrary-avataricon--default-story" />
|
|
</Canvas>
|
|
|
|
## Props
|
|
|
|
The `AvatarIcon` accepts all props below as well as all [Box](/docs/components-ui-box--default-story#props) component props
|
|
|
|
<ArgsTable of={AvatarIcon} />
|
|
|
|
`AvatarIcon` 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 `AvatarIcon`
|
|
|
|
Optional: `AVATAR_ICON_SIZES` from `./ui/components/component-library` object can be used instead of `Size`
|
|
|
|
Possible sizes include:
|
|
|
|
- `Size.XS` 16px
|
|
- `Size.SM` 24px
|
|
- `Size.MD` 32px
|
|
- `Size.LG` 40px
|
|
- `Size.XL` 48px
|
|
|
|
Defaults to `Size.MD`
|
|
|
|
<Canvas>
|
|
<Story id="components-componentlibrary-avataricon--size-story" />
|
|
</Canvas>
|
|
|
|
```jsx
|
|
import { Size } from '../../../helpers/constants/design-system';
|
|
import { AvatarIcon, IconName } from '../ui/component-library';
|
|
|
|
<AvatarIcon {...args} size={Size.XS} />
|
|
<AvatarIcon {...args} size={Size.SM} />
|
|
<AvatarIcon {...args} size={Size.MD} />
|
|
<AvatarIcon {...args} size={Size.LG} />
|
|
<AvatarIcon {...args} size={Size.XL} />
|
|
```
|
|
|
|
### Icon Name<span style={{ color: 'red' }}>\*</span>
|
|
|
|
Use the required `iconName` prop with `IconName` enum from `./ui/components/component-library` to select icon
|
|
|
|
Use the [IconSearch](/story/components-componentlibrary-icon--default-story) story to find the icon you want to use.
|
|
|
|
<Canvas>
|
|
<Story id="components-componentlibrary-avataricon--icon-name-story" />
|
|
</Canvas>
|
|
|
|
```jsx
|
|
import { AvatarIcon, IconName } from '../ui/component-library';
|
|
|
|
<AvatarIcon iconName={IconName.SwapHorizontal} />
|
|
<AvatarIcon iconName={IconName.Confirmation} />
|
|
<AvatarIcon iconName={IconName.Info} />
|
|
<AvatarIcon iconName={IconName.Warning} />
|
|
<AvatarIcon iconName={IconName.Danger} />
|
|
```
|
|
|
|
### Color and Background Color
|
|
|
|
Use the `color` and `backgroundColor` props with the `IconColor` and `BackgroundColor` object from `./ui/helpers/constants/design-system.js` to change the icon color and background color of `AvatarIcon`
|
|
|
|
`color` default: `IconColor.primaryDefault`
|
|
`backgroundColor` default: `BackgroundColor.primaryMuted`
|
|
|
|
<Canvas>
|
|
<Story id="components-componentlibrary-avataricon--color-and-background-color" />
|
|
</Canvas>
|
|
|
|
```jsx
|
|
import { BackgroundColor, IconColor } from '../../../helpers/constants/design-system';
|
|
import { AvatarIcon } from '../ui/component-library';
|
|
|
|
<AvatarIcon color={IconColor.primaryDefault} backgroundColor={BackgroundColor.primaryMuted} />
|
|
<AvatarIcon color={IconColor.primaryInverse} backgroundColor={BackgroundColor.primaryDefault} />
|
|
<AvatarIcon color={IconColor.successDefault} backgroundColor={BackgroundColor.successMuted} />
|
|
<AvatarIcon color={IconColor.infoDefault} backgroundColor={BackgroundColor.infoMuted} />
|
|
<AvatarIcon color={IconColor.warningDefault} backgroundColor={BackgroundColor.warningMuted} />
|
|
<AvatarIcon color={IconColor.errorDefault} backgroundColor={BackgroundColor.errorMuted} />
|
|
```
|