1
0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-12-23 09:52:26 +01:00
metamask-extension/ui/components/component-library/avatar-network/README.mdx
George Marshall 3117890b30
AvatarBase font-size logic (#18203)
* Updating AvatarBase to use Text component instead of Box and adding font size logic based on avatar size

* Updating snaps
2023-03-17 10:06:59 -07:00

128 lines
3.5 KiB
Plaintext

import { Story, Canvas, ArgsTable } from '@storybook/addon-docs';
import { AvatarNetwork } from './avatar-network';
# AvatarNetwork
The `AvatarNetwork` is a component responsible for display of the image of a given network
<Canvas>
<Story id="components-componentlibrary-avatarnetwork--default-story" />
</Canvas>
## Props
The `AvatarNetwork` accepts all props below as well as all [Box](/docs/components-ui-box--default-story#props) component props
<ArgsTable of={AvatarNetwork} />
### Size
Use the `size` prop to set the size of the `AvatarNetwork`.
Possible sizes include:
- `xs` 16px
- `sm` 24px
- `md` 32px
- `lg` 40px
- `xl` 48px
Defaults to `md`
The fallback display of the `AvatarNetwork` is a circle with the initial letter of the network name. The size of the initial letter is calculated based on the size of the `AvatarNetwork` component.
<Canvas>
<Story id="components-componentlibrary-avatarnetwork--size-story" />
</Canvas>
```jsx
import { Size } from '../../../helpers/constants/design-system';
import { AvatarNetwork } from '../../component-library';
<AvatarNetwork size={Size.XS} />
<AvatarNetwork size={Size.SM} />
<AvatarNetwork size={Size.MD} />
<AvatarNetwork size={Size.LG} />
<AvatarNetwork size={Size.XL} />
```
### Name
Use the `name` prop to set the initial letter of the `AvatarNetwork`. This will be used as the fallback display if no image url is passed to the `src` prop.
Use `Text` component props to change the `variant`, `font-weight`, `font-family`, etc.
<Canvas>
<Story id="components-componentlibrary-avatarnetwork--name" />
</Canvas>
```jsx
import { AvatarNetwork } from '../../component-library';
<AvatarNetwork name="Arbitrum One" />;
```
### Src
Use the `src` prop to set the image to be rendered of the `AvatarNetwork`.
<Canvas>
<Story id="components-componentlibrary-avatarnetwork--src" />
</Canvas>
```jsx
import { AvatarNetwork } from '../../component-library';
<AvatarNetwork src="./images/matic-token.png" />
<AvatarNetwork src="./images/arbitrum.svg" />
<AvatarNetwork src="./images/optimism.svg" />
<AvatarNetwork src="./images/avax-token.png" />
<AvatarNetwork src="./images/palm.svg" />
<AvatarNetwork src="./images/bsc-filled.svg" />
<AvatarNetwork src="./images/fantom-opera.svg" />
<AvatarNetwork src="./images/harmony-one.svg" />
<AvatarNetwork src="./images/aurora.png" />
```
### Show Halo
Use the `showHalo` prop to display the component with halo effect. Only works if an image url is supplied to `src`
<Canvas>
<Story id="components-componentlibrary-avatarnetwork--show-halo" />
</Canvas>
```jsx
import { AvatarNetwork } from '../../component-library';
<AvatarNetwork src="./images/arbitrum.svg" showHalo />;
```
### Color, Background Color And Border Color
Use the `color`, `backgroundColor` and `borderColor` props to set the text color, background-color and border-color of the `AvatarNetwork`.
<Canvas>
<Story id="components-componentlibrary-avatarnetwork--color-background-color-and-border-color" />
</Canvas>
```jsx
import { TextColor,
BackgroundColor,
BorderColor } from '../../../helpers/constants/design-system';
import { AvatarNetwork } from '../../component-library';
<AvatarNetwork
backgroundColor={BackgroundColor.goerli}
borderColor={BorderColor.goerli}
name="G"
color={Color.goerliInverse}
>
G
</AvatarNetwork>
<AvatarNetwork
backgroundColor={BackgroundColor.sepolia}
borderColor={BorderColor.sepolia}
name="S"
color={Color.goerliInverse}
>
S
</AvatarNetwork>
```