mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-12-02 06:07:06 +01:00
a28d727caf
* add button component * add all button props * update tests * add button type prop * fix base button size const * add href prop to button base * Update ui/components/component-library/button/README.mdx Co-authored-by: George Marshall <george.marshall@consensys.net> * Update ui/components/component-library/button/README.mdx Co-authored-by: George Marshall <george.marshall@consensys.net> * update tests * Update ui/components/component-library/button-primary/button-primary.js Co-authored-by: George Marshall <george.marshall@consensys.net> * Update ui/components/component-library/button/README.mdx Co-authored-by: George Marshall <george.marshall@consensys.net> * Update ui/components/component-library/button/button.stories.js Co-authored-by: George Marshall <george.marshall@consensys.net> * Update ui/components/component-library/button/button.js Co-authored-by: George Marshall <george.marshall@consensys.net> * Update ui/components/component-library/button/button.stories.js Co-authored-by: George Marshall <george.marshall@consensys.net> * update button props on readme * linting issue fix Co-authored-by: George Marshall <george.marshall@consensys.net>
74 lines
2.1 KiB
Plaintext
74 lines
2.1 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 '../ui/component-library/button/button-link/button-link';
|
|
|
|
<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 `ButtonPrimary` to danger color.
|
|
|
|
<Canvas>
|
|
<Story id="ui-components-component-library-button-link-button-link-stories-js--danger" />
|
|
</Canvas>
|
|
|
|
```jsx
|
|
import { ButtonLink } from '../ui/component-library/button/button-link/button-link';
|
|
|
|
<ButtonLink>Normal</ButtonLink>
|
|
<ButtonLink danger>Danger</ButtonLink>
|
|
```
|
|
|
|
### Href
|
|
|
|
When an `href` is passed the tag element will switch to an `anchor`(`a`) tag.
|
|
|
|
<Canvas>
|
|
<Story id="ui-components-component-library-button-link-button-link-stories-js--href" />
|
|
</Canvas>
|
|
|
|
```jsx
|
|
import { ButtonLink } from '../ui/component-library/button/button-link/button-link';
|
|
|
|
<ButtonLink href="/">Href Example</ButtonLink>;
|
|
```
|