1
0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-11-30 08:09:15 +01:00
metamask-extension/ui/components/component-library/button-primary
2023-02-22 09:42:06 -08:00
..
__snapshots__ Feat/16637/button housekeeping (#16872) 2023-01-13 13:58:09 -08:00
button-primary.constants.js feature: migrate design-system.ts (#17518) 2023-02-02 20:15:26 +00:00
button-primary.js feature: migrate design-system.ts (#17518) 2023-02-02 20:15:26 +00:00
button-primary.scss Feat/16637/button housekeeping (#16872) 2023-01-13 13:58:09 -08:00
button-primary.stories.js update to add end icon support (#17776) 2023-02-22 09:42:06 -08:00
button-primary.test.js update to add end icon support (#17776) 2023-02-22 09:42:06 -08:00
index.js button secondary housekeeping (#16495) 2022-11-15 12:48:24 -08:00
README.mdx fix broken stories and readme from TS update (#17703) 2023-02-14 11:33:04 -06:00

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