mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-12-05 07:24:56 +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>
179 lines
4.5 KiB
Plaintext
179 lines
4.5 KiB
Plaintext
import { Story, Canvas, ArgsTable } from '@storybook/addon-docs';
|
|
import { Button } from './button';
|
|
|
|
# Button
|
|
|
|
The `Button` is used for user actions it unifies `ButtonPrimary`, `ButtonSecondary` and `ButtonLink`
|
|
|
|
<Canvas>
|
|
<Story id="ui-components-component-library-button-button-stories-js--default-story" />
|
|
</Canvas>
|
|
|
|
## Props
|
|
|
|
The `Button` accepts all props below as well as all [ButtonPrimary](/ui-components-component-library-button-primary-button-primary-stories-js--default-story), [ButtonSecondary](/ui-components-component-library-button-secondary-button-secondary-stories-js--default-story), [ButtonLink](/ui-components-component-library-button-link-button-link-stories-js--default-story), and [Box](/docs/ui-components-ui-box-box-stories-js--default-story#props) component props
|
|
|
|
<ArgsTable of={Button} />
|
|
|
|
### Type
|
|
|
|
Use the `type` prop and the `BUTTON_TYPES` object from `./button.constants.js` to change the `Button` type.
|
|
|
|
Possible types include:
|
|
|
|
- `BUTTON_TYPES.PRIMARY`
|
|
- `BUTTON_TYPES.SECONDARY`
|
|
- `BUTTON_TYPES.LINK`
|
|
|
|
<Canvas>
|
|
<Story id="ui-components-component-library-button-button-stories-js--type" />
|
|
</Canvas>
|
|
|
|
```jsx
|
|
import { Button, BUTTON_TYPES } from '../ui/component-library/button';
|
|
|
|
<Button type={BUTTON_TYPES.PRIMARY}>Button Primary</Button>
|
|
<Button type={BUTTON_TYPES.SECONDARY}>Button Secondary</Button>
|
|
<Button type={BUTTON_TYPES.LINK}>Button Link</Button>
|
|
```
|
|
|
|
### Size
|
|
|
|
Use the `size` prop and the `SIZES` object from `./ui/helpers/constants/design-system.js` to change the size of `Button`. Defaults to `SIZES.MD`
|
|
|
|
Optional: `BUTTON_SIZES` from `./button` 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-button-stories-js--size" />
|
|
</Canvas>
|
|
|
|
```jsx
|
|
import { SIZES } from '../../../helpers/constants/design-system';
|
|
import { Button } from '../ui/component-library/button/button/button';
|
|
|
|
<Button size={SIZES.AUTO} />
|
|
<Button size={SIZES.SM} />
|
|
<Button size={SIZES.MD} />
|
|
<Button size={SIZES.LG} />
|
|
```
|
|
|
|
### Danger
|
|
|
|
Use the `danger` boolean prop to change the `Button` to danger color.
|
|
|
|
<Canvas>
|
|
<Story id="ui-components-component-library-button-button-stories-js--danger" />
|
|
</Canvas>
|
|
|
|
```jsx
|
|
import { Button } from '../ui/component-library/button/button/button';
|
|
|
|
<Button>Normal</Button>
|
|
<Button danger>Danger</Button>
|
|
```
|
|
|
|
### Href
|
|
|
|
When an `href` is passed the tag element will switch to an `anchor`(`a`) tag.
|
|
|
|
<Canvas>
|
|
<Story id="ui-components-component-library-button-button-stories-js--href" />
|
|
</Canvas>
|
|
|
|
```jsx
|
|
import { Button } from '../ui/component-library/button/button/button';
|
|
|
|
<Button href="/">Href Example</Button>;
|
|
```
|
|
|
|
### Block
|
|
|
|
Use boolean `block` prop to quickly enable a full width block button
|
|
|
|
<Canvas>
|
|
<Story id="ui-components-component-library-button-button-stories-js--block" />
|
|
</Canvas>
|
|
|
|
```jsx
|
|
import { DISPLAY } from '../../../helpers/constants/design-system';
|
|
import { Button } from '../ui/component-library';
|
|
|
|
<Button>Default Button</Button>
|
|
<Button block>Block Button</Button>
|
|
```
|
|
|
|
### As
|
|
|
|
Use the `as` box prop to change the element of `Button`. Defaults to `button`.
|
|
|
|
When an `href` prop is passed it will change the element to an anchor(`a`) tag.
|
|
|
|
Button `as` options:
|
|
|
|
- `button`
|
|
- `a`
|
|
|
|
<Canvas>
|
|
<Story id="ui-components-component-library-button-button-stories-js--as" />
|
|
</Canvas>
|
|
|
|
```jsx
|
|
import { Button } from '../ui/component-library';
|
|
|
|
|
|
<Button as="button">Button Element</Button>
|
|
<Button as="a" href="#">
|
|
Anchor Element
|
|
</Button>
|
|
```
|
|
|
|
### Disabled
|
|
|
|
Use the boolean `disabled` prop to disable button
|
|
|
|
<Canvas>
|
|
<Story id="ui-components-component-library-button-button-stories-js--disabled" />
|
|
</Canvas>
|
|
|
|
```jsx
|
|
import { Button } from '../ui/component-library';
|
|
|
|
<Button disabled>Disabled Button</Button>;
|
|
```
|
|
|
|
### Loading
|
|
|
|
Use the boolean `loading` prop to set loading spinner
|
|
|
|
<Canvas>
|
|
<Story id="ui-components-component-library-button-button-stories-js--loading" />
|
|
</Canvas>
|
|
|
|
```jsx
|
|
import { Button } from '../ui/component-library';
|
|
|
|
<Button loading>Loading Button</Button>;
|
|
```
|
|
|
|
### Icon
|
|
|
|
Use the `icon` prop and the `ICON_NAMES` object from `./ui/components/component-library/icon` to select icon.
|
|
|
|
<Canvas>
|
|
<Story id="ui-components-component-library-button-button-stories-js--icon" />
|
|
</Canvas>
|
|
|
|
```jsx
|
|
import { Button } from '../ui/component-library';
|
|
import { ICON_NAMES } from '../icon';
|
|
|
|
<Button icon={ICON_NAMES.ADD_SQUARE_FILLED}>Button</Button>;
|
|
```
|