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-link
2023-01-25 23:41:13 +05:30
..
__snapshots__ Feat/16637/button housekeeping (#16872) 2023-01-13 13:58:09 -08:00
button-link.constants.js Feat/15089/add button link (#16115) 2022-10-13 15:39:22 -07:00
button-link.js Feat/16637/button housekeeping (#16872) 2023-01-13 13:58:09 -08:00
button-link.scss Feat/16637/button housekeeping (#16872) 2023-01-13 13:58:09 -08:00
button-link.stories.js Added storybook check to CI (#17092) 2023-01-21 00:57:46 +05:30
button-link.test.js fix icon names (#17391) 2023-01-25 23:41:13 +05:30
index.js Feat/16507/button link housekeeping (#16518) 2022-11-18 12:36:33 -08:00
README.mdx Added storybook check to CI (#17092) 2023-01-21 00:57:46 +05:30

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="components-componentlibrary-buttonlink--default-story" />
</Canvas>

## Props

The `ButtonLink` 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={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="components-componentlibrary-buttonlink--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="components-componentlibrary-buttonlink--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="components-componentlibrary-buttonlink--href" />
</Canvas>

```jsx
import { ButtonLink } from '../../component-library';

<ButtonLink href="/">Anchor Element</ButtonLink>;
```