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/button-secondary/README.mdx
George Marshall 23b412c13f
Component library adding global index and other housekeeping (#16441)
* Adding global index.js file

* Removing style prop from button base

* Fixing comment on generate-icon-names.js file

* Re-ordering sass imports to atomic structure

* Updating component paths code examples of MDX docs
2022-11-16 14:15:08 -08:00

58 lines
1.7 KiB
Plaintext

import { Story, Canvas, ArgsTable } from '@storybook/addon-docs';
import { ButtonSecondary } from './button-secondary';
# ButtonSecondary
The `ButtonSecondary` is an extension of `ButtonBase` to support secondary styles.
<Canvas>
<Story id="ui-components-component-library-button-secondary-button-secondary-stories-js--default-story" />
</Canvas>
## Props
The `ButtonSecondary` 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={ButtonSecondary} />
### Size
Use the `size` prop and the `SIZES` object from `./ui/helpers/constants/design-system.js` to change the size of `ButtonSecondary`. 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-secondary-button-secondary-stories-js--size" />
</Canvas>
```jsx
import { SIZES } from '../../../helpers/constants/design-system';
import { ButtonSecondary } from '../../ui/components/component-library';
<ButtonSecondary size={SIZES.SM} />
<ButtonSecondary size={SIZES.MD} />
<ButtonSecondary size={SIZES.LG} />
```
### Danger
Use the `danger` boolean prop to change the `ButtonSecondary` to danger color.
<Canvas>
<Story id="ui-components-component-library-button-secondary-button-secondary-stories-js--danger" />
</Canvas>
```jsx
import { ButtonSecondary } from '../../ui/components/component-library';
<ButtonSecondary>Normal</ButtonSecondary>
<ButtonSecondary danger>Danger</ButtonSecondary>
```