1
0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-12-02 06:07:06 +01:00
metamask-extension/ui/components/component-library/button-primary
Garrett Bear 12aa200ad0
15090: add primary button (#16079)
* 15090: add primary button

* updates

* add button base props

* add button base props to primary

* remove button base props and improve classname test

* update box shadow animation

* fix anchor test and update documentation

* fix button base iconProps proptype
2022-10-05 21:51:02 -07:00
..
button-primary.constants.js 15090: add primary button (#16079) 2022-10-05 21:51:02 -07:00
button-primary.js 15090: add primary button (#16079) 2022-10-05 21:51:02 -07:00
button-primary.scss 15090: add primary button (#16079) 2022-10-05 21:51:02 -07:00
button-primary.stories.js 15090: add primary button (#16079) 2022-10-05 21:51:02 -07:00
button-primary.test.js 15090: add primary button (#16079) 2022-10-05 21:51:02 -07:00
index.js 15090: add primary button (#16079) 2022-10-05 21:51:02 -07:00
README.mdx 15090: add primary button (#16079) 2022-10-05 21:51:02 -07: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="ui-components-component-library-button-primary-button-primary-stories-js--default-story" />
</Canvas>

## Props

The `ButtonPrimary` accepts all props below as well as all [Box](/docs/ui-components-ui-box-box-stories-js--default-story#props) and [ButtonBase](/docs/ui-components-component-library-button-base-button-base-stories-js--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="ui-components-component-library-button-primary-button-primary-stories-js--size" />
</Canvas>

```jsx
import { SIZES } from '../../../helpers/constants/design-system';
import { ButtonPrimary } from '../ui/component-library/button/button-primary/button-primary';

<ButtonPrimary size={SIZES.SM} />
<ButtonPrimary size={SIZES.MD} />
<ButtonPrimary size={SIZES.LG} />
```

### Type

Use the `type` prop and the `BUTTON_TYPES` object from `./ui/helpers/constants/design-system.js` to change the context of `ButtonPrimary`.

<Canvas>
  <Story id="ui-components-component-library-button-primary-button-primary-stories-js--type" />
</Canvas>

```jsx
import { ButtonPrimary } from '../ui/component-library/button/button-primary/button-primary';

<ButtonPrimary>Normal</ButtonPrimary>
<ButtonPrimary danger>Danger</ButtonPrimary>
```