metamask-extension/ui/components/component-library/button-primary/README.mdx

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 `SIZES` object from `./ui/helpers/constants/design-system.js` to change the size of `ButtonPrimary`. Defaults to `SIZES.MD`

Optional: `BUTTON_SIZES` from `./button-base` object can be used instead of `SIZES`.

Possible sizes include:

- `SIZES.SM` 32px
- `SIZES.MD` 40px
- `SIZES.LG` 48px

<Canvas>
  <Story id="components-componentlibrary-buttonprimary--size" />
</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>
```