mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-12-23 09:52:26 +01:00
23b412c13f
* 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
145 lines
3.6 KiB
Plaintext
145 lines
3.6 KiB
Plaintext
import { Story, Canvas, ArgsTable } from '@storybook/addon-docs';
|
|
import { ButtonBase } from './button-base';
|
|
|
|
### This is a base component. It should not be used in your feature code directly but as a "base" for other UI components
|
|
|
|
# ButtonBase
|
|
|
|
The `ButtonBase` is the base component for buttons.
|
|
|
|
<Canvas>
|
|
<Story id="ui-components-component-library-button-base-button-base-stories-js--default-story" />
|
|
</Canvas>
|
|
|
|
## Props
|
|
|
|
The `ButtonBase` accepts all props below as well as all [Box](/docs/ui-components-ui-box-box-stories-js--default-story#props) component props
|
|
|
|
<ArgsTable of={ButtonBase} />
|
|
|
|
### Size
|
|
|
|
Use the `size` prop and the `SIZES` object from `./ui/helpers/constants/design-system.js`
|
|
to change the size of `ButtonBase`. Defaults to `SIZES.MD`
|
|
|
|
Optional: `BUTTON_BASE_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-base-button-base-stories-js--size" />
|
|
</Canvas>
|
|
|
|
```jsx
|
|
import { SIZES } from '../../../helpers/constants/design-system';
|
|
import { ButtonBase } from '../../ui/components/component-library';
|
|
|
|
<ButtonBase size={SIZES.AUTO} />
|
|
<ButtonBase size={SIZES.SM} />
|
|
<ButtonBase size={SIZES.MD} />
|
|
<ButtonBase size={SIZES.LG} />
|
|
```
|
|
|
|
### Block
|
|
|
|
Use boolean `block` prop to quickly enable a full width block button
|
|
|
|
<Canvas>
|
|
<Story id="ui-components-component-library-button-base-button-base-stories-js--block" />
|
|
</Canvas>
|
|
|
|
```jsx
|
|
import { DISPLAY } from '../../../helpers/constants/design-system';
|
|
import { ButtonBase } from '../../ui/components/component-library';
|
|
|
|
<ButtonBase>Default Button</ButtonBase>
|
|
<ButtonBase block>Block Button</ButtonBase>
|
|
```
|
|
|
|
### As
|
|
|
|
Use the `as` box prop to change the element of `ButtonBase`. 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-base-button-base-stories-js--as" />
|
|
</Canvas>
|
|
|
|
```jsx
|
|
import { ButtonBase } from '../../ui/components/component-library';
|
|
|
|
|
|
<ButtonBase as="button">Button Element</ButtonBase>
|
|
<ButtonBase as="a" href="#">
|
|
Anchor Element
|
|
</ButtonBase>
|
|
```
|
|
|
|
### 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-base-button-base-stories-js--href" />
|
|
</Canvas>
|
|
|
|
```jsx
|
|
import { ButtonBase } from '../../ui/components/component-library';
|
|
|
|
<ButtonBase href="/metamask">Anchor Element</ButtonBase>;
|
|
```
|
|
|
|
### Disabled
|
|
|
|
Use the boolean `disabled` prop to disable button
|
|
|
|
<Canvas>
|
|
<Story id="ui-components-component-library-button-base-button-base-stories-js--disabled" />
|
|
</Canvas>
|
|
|
|
```jsx
|
|
import { ButtonBase } from '../../ui/components/component-library';
|
|
|
|
<ButtonBase disabled>Disabled Button</ButtonBase>;
|
|
```
|
|
|
|
### Loading
|
|
|
|
Use the boolean `loading` prop to set loading spinner
|
|
|
|
<Canvas>
|
|
<Story id="ui-components-component-library-button-base-button-base-stories-js--loading" />
|
|
</Canvas>
|
|
|
|
```jsx
|
|
import { ButtonBase } from '../../ui/components/component-library';
|
|
|
|
<ButtonBase loading>Loading Button</ButtonBase>;
|
|
```
|
|
|
|
### Icon
|
|
|
|
Use the `icon` prop and the `ICON_NAMES` object from `./ui/components/component-library` to select icon.
|
|
|
|
<Canvas>
|
|
<Story id="ui-components-component-library-button-base-button-base-stories-js--icon" />
|
|
</Canvas>
|
|
|
|
```jsx
|
|
import { ButtonBase } from '../../ui/components/component-library';
|
|
import { ICON_NAMES } from '../icon';
|
|
|
|
<ButtonBase icon={ICON_NAMES.ADD_SQUARE_FILLED}>Button</ButtonBase>;
|
|
```
|