UNPKG

@blueprintjs/core

Version:
86 lines (56 loc) 3 kB
@# Buttons Buttons trigger actions when clicked. You may render a button as either a `<button>` or `<a>` HTML element using the `<Button>` and `<AnchorButton>` components, respectively. @reactExample ButtonsExample @## AnchorButton vs Button The two button components generate different HTML tags. They each look the same, but they have different semantic behaviors according to the HTML spec. ```tsx <AnchorButton text="Click" /> ``` ```html <a class="@ns-button" role="button" tabindex={0}>Click</a> ``` --- ```tsx <Button icon="refresh" /> ``` ```html <button class="@ns-button" type="button"><svg class="@ns-icon">...</svg></button> ``` <div class="@ns-callout @ns-intent-danger @ns-icon-error @ns-callout-has-body-content"> <h5 class="@ns-heading"> Disabled __Button__ elements prevent all interaction </h5> Use __AnchorButton__ if you need mouse interaction events (such as hovering) on a disabled button. __Button__ uses the native `disabled` attribute on the `<button>` tag so the browser disables all interactions. __AnchorButton__ uses the class `.@ns-disabled` because `<a>` tags do not support the `disabled` attribute. As a result, the __AnchorButton__ component will prevent *only* the `onClick` handler when disabled but permit other events. </div> @## Adding icons __Button__ and __AnchorButton__ support `icon` and `rightIcon` props to place an icon on either end of their children. Icons can also be supplied as child elements using the [__Icon__](#core/components/icon) component. @reactExample ButtonsIconsExample @## Props interface The two button components each support arbitrary HTML attributes for their underlying DOM element (`<button>` and `<a>` respectively). These attributes may override the components' default values, such as `role` on `<AnchorButton>`. @interface ButtonSharedProps @## CSS API <div class="@ns-callout @ns-intent-warning @ns-icon-warning-sign @ns-callout-has-body-content"> <h5 class="@ns-heading"> Deprecated API: use `<Button>` or `<AnchorButton>` </h5> CSS APIs for Blueprint components are considered deprecated, as they are verbose, error-prone, and they often fall out of sync as the design system is updated. You should use the React component APIs instead. </div> Use the `@ns-button` class to access button styles. You should implement buttons using the `<button>` or `<a>` tags rather than `<div>` for accessibility. * Make sure to include `type="button"` on `<button>` tags (use `type="submit"` to submit a `<form>`) and `role="button"` on `<a>` tags for accessibility. * Add the attribute `tabindex="0"` to make `<a>` tags focusable. `<button>` elements are focusable by default. * For buttons implemented with `<a>` tags, add `tabindex="-1"` to disabled buttons to prevent the user from focusing them by pressing <kbd>tab</kbd> on the keyboard. (This does not happen in the example below.) * Note that `<a>` tags do not respond to the `:disabled` attribute; use `.@ns-disabled` instead. @css button