1
0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-11-25 11:28:51 +01:00
metamask-extension/ui/components/component-library/button-link/README.mdx
Garrett Bear 1265731344
Feat/16637/button housekeeping (#16872)
* button housekeeping

* add iconsearch

* fix description

* readme update

* update disabled classnames

* buttonlink disabled class

* add disabled proptypes

* add constant exports

* update disabled style classes

* update snapshot for box pill classname

* add buttonTextProps

* update primarybutton background color to use box props

* update button secondary and link to use box props

* update tests
2023-01-13 13:58:09 -08:00

74 lines
2.0 KiB
Plaintext

import { Story, Canvas, ArgsTable } from '@storybook/addon-docs';
import { ButtonLink } from './button-link';
# ButtonLink
The `ButtonLink` is an extension of `ButtonBase` to support link styles.
<Canvas>
<Story id="ui-components-component-library-button-link-button-link-stories-js--default-story" />
</Canvas>
## Props
The `ButtonLink` 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={ButtonLink} />
### Size
Use the `size` prop and the `SIZES` object from `./ui/helpers/constants/design-system.js` to change the size of `ButtonLink`. Defaults to `SIZES.MD`
Optional: `BUTTON_SIZES` from `./button-base` object can be used instead of `SIZES`.
Possible sizes include:
- `SIZES.AUTO` inherits the font-size of the parent element.
- `SIZES.SM` 32px
- `SIZES.MD` 40px
- `SIZES.LG` 48px
<Canvas>
<Story id="ui-components-component-library-button-link-button-link-stories-js--size" />
</Canvas>
```jsx
import { SIZES } from '../../../helpers/constants/design-system';
import { ButtonLink } from '../../component-library';
<ButtonLink size={SIZES.AUTO} />
<ButtonLink size={SIZES.SM} />
<ButtonLink size={SIZES.MD} />
<ButtonLink size={SIZES.LG} />
```
### Danger
Use the `danger` boolean prop to change the `ButtonLink` to danger color.
<Canvas>
<Story id="ui-components-component-library-button-link-button-link-stories-js--danger" />
</Canvas>
```jsx
import { ButtonLink } from '../../component-library';
<ButtonLink>Normal</ButtonLink>
<ButtonLink danger>Danger</ButtonLink>
```
### Href
When an `href` prop is passed it will change the element to an anchor(`a`) tag.
<Canvas>
<Story id="ui-components-component-library-button-link-button-link-stories-js--href" />
</Canvas>
```jsx
import { ButtonLink } from '../../component-library';
<ButtonLink href="/">Anchor Element</ButtonLink>;
```