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/picker-network/README.mdx
Nidhi Kumari a1c5224997
housekeeping for picker-network (#16982)
* updated test in picker-network

* fixed import order in README

* fixed global import path

* fixed formatting
2023-01-05 15:30:42 -08:00

47 lines
1.4 KiB
Plaintext

import { Story, Canvas, ArgsTable } from '@storybook/addon-docs';
import { PickerNetwork } from './picker-network';
# PickerNetwork
The `PickerNetwork` is used for the action of changing a network.
<Canvas>
<Story id="ui-components-component-library-picker-network-picker-network-stories-js--default-story" />
</Canvas>
## Props
The `PickerNetwork` accepts all props below as well as all [Box](/docs/ui-components-ui-box-box-stories-js--default-story#props) component props.
<ArgsTable of={PickerNetwork} />
### Label
Use the `label` prop for the text content of the `PickerNetwork` component
<Canvas>
<Story id="ui-components-component-library-picker-network-picker-network-stories-js--label" />
</Canvas>
```jsx
import { PickerNetwork } from '../../ui/component-library';
<PickerNetwork label="Arbitrum One" />
<PickerNetwork label="Polygon Mainnet" />
<PickerNetwork label="Optimism" />
```
### Src
Use the `src` prop with an image url to render the `AvatarNetwork`. Use the `avatarNetworkProps` to pass additional props to the `AvatarNetwork` component.
<Canvas>
<Story id="ui-components-component-library-picker-network-picker-network-stories-js--src" />
</Canvas>
```jsx
import { PickerNetwork } from '../../ui/component-library';
<PickerNetwork src="./images/arbitrum.svg" />
<PickerNetwork src="./images/matic-token.png" />
<PickerNetwork src="./images/optimism.svg" />
```