metamask-extension/ui/components/component-library/avatar-icon/README.mdx

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 `SIZES` 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 `SIZES`

Possible sizes include:

- `SIZES.XS` 16px
- `SIZES.SM` 24px
- `SIZES.MD` 32px
- `SIZES.LG` 40px
- `SIZES.XL` 48px

Defaults to `SIZES.MD`

<Canvas>
  <Story id="components-componentlibrary-avataricon--size" />
</Canvas>

```jsx
import { SIZES } from '../../../helpers/constants/design-system';
import { AvatarIcon, ICON_NAMES } from '../ui/component-library';

<AvatarIcon size={SIZES.XS} />
<AvatarIcon size={SIZES.SM} />
<AvatarIcon size={SIZES.MD} />
<AvatarIcon size={SIZES.LG} />
<AvatarIcon size={SIZES.XL} />
```

### Icon Name<span style={{ color: 'red' }}>\*</span>

Use the required `iconName` prop with `ICON_NAMES` object 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" />
</Canvas>

```jsx
import { AvatarIcon, ICON_NAMES } from '../ui/component-library';

<AvatarIcon iconName={ICON_NAMES.SWAP_HORIZONTAL_OUTLINE} />
<AvatarIcon iconName={ICON_NAMES.CHECK_CIRCLE_ON_FILLED} />
<AvatarIcon iconName={ICON_NAMES.INFO_FILLED} />
<AvatarIcon iconName={ICON_NAMES.WARNING_FILLED} />
<AvatarIcon iconName={ICON_NAMES.DANGER_FILLED} />
```

### Color and Background Color

Use the `color` and `backgroundColor` props with the `COLORS` object from `./ui/helpers/constants/design-system.js` to change the icon color and background color of `AvatarIcon`

`color` default: `COLORS.COLORS.PRIMARY_DEFAULT`
`backgroundColor` default: `COLORS.COLORS.PRIMARY_MUTED`

<Canvas>
  <Story id="components-componentlibrary-avataricon--color-and-background-color" />
</Canvas>

```jsx
import { COLORS } from '../../../helpers/constants/design-system';
import { AvatarIcon } from '../ui/component-library';

<AvatarIcon color={COLORS.PRIMARY_DEFAULT} backgroundColor={BACKGROUND_COLORS.PRIMARY_MUTED} />
<AvatarIcon color={COLORS.PRIMARY_INVERSE} backgroundColor={BACKGROUND_COLORS.PRIMARY_DEFAULT} />
<AvatarIcon color={COLORS.SUCCESS_DEFAULT} backgroundColor={BACKGROUND_COLORS.SUCCESS_MUTED} />
<AvatarIcon color={COLORS.INFO_DEFAULT} backgroundColor={BACKGROUND_COLORS.INFO_MUTED} />
<AvatarIcon color={COLORS.WARNING_DEFAULT} backgroundColor={BACKGROUND_COLORS.WARNING_MUTED} />
<AvatarIcon color={COLORS.ERROR_DEFAULT} backgroundColor={BACKGROUND_COLORS.ERROR_MUTED} />
```