1
0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-11-26 20:39:08 +01:00
metamask-extension/ui/components/component-library/button-primary/README.mdx

58 lines
1.5 KiB
Plaintext

import { Story, Canvas, ArgsTable } from '@storybook/addon-docs';
import { ButtonPrimary } from './button-primary';
# ButtonPrimary
The `ButtonPrimary` is an extension of `ButtonBase` to support primary styles.
<Canvas>
<Story id="components-componentlibrary-buttonprimary--default-story" />
</Canvas>
## Props
The `ButtonPrimary` accepts all props below as well as all [Box](/docs/components-ui-box--default-story#props) and [ButtonBase](/docs/components-componentlibrary-buttonbase--default-story#props) component props
<ArgsTable of={ButtonPrimary} />
### Size
Use the `size` prop and the `Size` object from `./ui/helpers/constants/design-system.js` to change the size of `ButtonPrimary`. Defaults to `Size.MD`
Optional: `BUTTON_SIZES` from `./button-base` object can be used instead of `Size`.
Possible sizes include:
- `Size.SM` 32px
- `Size.MD` 40px
- `Size.LG` 48px
<Canvas>
<Story id="components-componentlibrary-buttonprimary--size-story" />
</Canvas>
```jsx
import { Size } from '../../../helpers/constants/design-system';
import { ButtonPrimary } from '../../component-library';
<ButtonPrimary size={Size.SM} />
<ButtonPrimary size={Size.MD} />
<ButtonPrimary size={Size.LG} />
```
### Danger
Use the `danger` boolean prop to change the `ButtonPrimary` to danger color.
<Canvas>
<Story id="components-componentlibrary-buttonprimary--danger" />
</Canvas>
```jsx
import { ButtonPrimary } from '../../component-library';
<ButtonPrimary>Normal</ButtonPrimary>
<ButtonPrimary danger>Danger</ButtonPrimary>
```