import { Story, Canvas, ArgsTable } from '@storybook/addon-docs'; import { Button } from './button'; import { ButtonBase } from '../button-base'; import { ButtonLink } from '../button-link'; # Button The `Button` is used for user actions. It unifies `ButtonPrimary`, `ButtonSecondary` and `ButtonLink`. ## Props ### Variant Use the `variant` prop and the `ButtonVariant` enum from `./ui/components/component-library` to change the `Button` variant. Possible variants include: - `ButtonVariant.Primary` (default) - `ButtonVariant.Secondary` - `ButtonVariant.Link` ```jsx import { Button, ButtonVariant } from '../ui/component-library/button'; ``` ### Size Use the `size` prop and the `ButtonSize` enum from `./ui/components/component-library` to change the size of `Button`. Defaults to `Buttonsize.Md` Possible sizes include: - `Buttonsize.Inherit` inherits the font-size of the parent element. For [ButtonLink](/docs/components-componentlibrary-buttonlink--default-story) uses only - `Buttonsize.Auto` inherits auto height, but keeps the same button font-size. For [ButtonLink](/docs/components-componentlibrary-buttonlink--default-story) uses only - `Buttonsize.Sm` 32px - `Buttonsize.Md` 40px - `Buttonsize.Lg` 48px ```jsx import { Button, ButtonSize } from '../../component-library'; ``` ### Href When an `href` prop is passed it will change the element to an anchor(`a`) tag. ```jsx import { Button } from '../../component-library'; ; ``` ### Block Use boolean `block` prop to quickly enable a full width block button ```jsx import { Button } from '../../component-library'; ``` ### 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` ```jsx import { Button } from '../../component-library'; ``` ### Disabled Use the boolean `disabled` prop to disable button ```jsx import { Button } from '../../component-library'; ; ``` ### Loading Use the boolean `loading` prop to set loading spinner ```jsx import { Button } from '../../component-library'; ; ``` ### Icon Name Use the `startIconName` and/or `endIconName` prop and the `IconName` enum from `./ui/components/component-library/icon` to select icon. Use the [IconSearch](/story/components-componentlibrary-icon--default-story) story to find the icon you want to use. ```jsx import { Button, IconName } from '../../component-library'; ; ``` ```jsx import { Button, IconName } from '../../component-library'; ; ```