Button

Buttons highlight actions available on a screen.

GitHub Storybook

yarn add @workday/canvas-kit-react

Sources

GitHub Storybook

Install

yarn add @workday/canvas-kit-react

Anatomy

Container (Conditional): Houses the contents of the Button. Visual appearance differs based on button type.
Label (Conditional): Specific text describing the action. Refer to the Buttons and Calls to Action section of the Content Style Guide.
Icon (Conditional): Supplementary visual indicator that can be positioned alone or added to the left or right of the label. Supplemental icons are used to promote the purpose of the Button.

Usage Guidance

Buttons should indicate an action.
They should be discoverable, easy to identify, and specific.
Make Buttons look and feel clickable.
Icons can be used alone or added to the left or right of the label. If used, the icon should signify what the Button does.
Use icon-only variants in dense environments or when space is limited.
Use accessible tooltips with icon-only variants to help explain ambiguous icons for everyone.
When deciding which Button to use, consider the level of priority of the action, as well as how much visual emphasis the Button should have in the context of the page it will live on. Be intentional and refer to the examples below to determine which is right for your use case.

When to Use Something Else

Use Hyperlinks within a paragraph to navigate to another page. See the Button or Hyperlink section of the Buttons and Calls to Action pattern for more information and best practices.
Consider using checkbox, switch, or segmented control when a component is needed that can capture 2 togglable states.

Examples

PrimaryButton

Primary Buttons are high emphasis. Use once per screen to draw attention to the highest priority action. Multiple primary buttons make it confusing for the user to understand what action they should take. Not all screens require a Primary Button.

Primary Buttons have four sizes: extraSmall, small, medium, and large. Icons are supported for every size and can be positioned at the start or end with the iconPosition prop.

The example below shows multiple instances of a PrimaryButton with various icon configurations.

Primary Buttons also have an inverse variant. While it looks similar to the default Secondary Button, the default outline as well as the hover and focus states are different. Use this variant when you need to place a Primary Button on a dark or colorful background such as blueberry400.

SecondaryButton

Secondary Buttons have a medium level of emphasis. Use them for non-critical actions. Secondary Buttons can be used on most pages without restrictions and work well for multiple actions of equal weight. They can be used in conjunction with a Primary Button or independently.

Secondary Buttons have four sizes: extraSmall, small, medium, and large. Icons are supported for every size and can be positioned at the start or end with the iconPosition prop.

The example below shows multiple instances of a SecondaryButton with various icon configurations.

Secondary Buttons also have an inverse variant. Use this when you need to place a Secondary Button on a dark or colorful background such as blueberry400.

TertiaryButton

Tertiary Buttons have the lowest emphasis. Use for less important actions that the user may not often be looking to do. Tertiary Buttons have lower prominence as its container is not visible until it is interacted with. Use Tertiary Buttons for supplemental actions such as “View More”, “Read More” or “Select a File”. Tertiary Buttons are frequently used on Cards.

Tertiary Buttons have four sizes: extraSmall, small, medium and large. Icons are supported for every size and can be positioned at the start or end with the iconPosition prop.

The example below shows multiple instances of a TertiaryButton with various icon configurations.

Tertiary Buttons also have an inverse variant. Use this when you need to place a Tertiary Button on a dark or colorful background such as blueberry400.

DeleteButton

Use sparingly for destructive actions that will result in data loss, can’t be undone, or will have significant consequences. They commonly appear in confirmation dialogs as the final confirmation before deleting.

Custom Styles

We understand that there are instances in which consumers might need to adjust styles for specific use cases. All of our buttons extend our lower level base button props which extends style properties that come from Box. Below are some examples in which you can overwrite styles for all of our buttons. Please use this sparingly and try to adhere to the design system.

Accessible Use of the `as` Prop

Like many of our components, Buttons accept an as prop, which lets you change the underlying semantic element - usually an <a>, or a <button>. This should be done with caution to ensure the best accessibility. Generally, <button> elements should be used for actions, and <a> elements should be used for navigation.

Component API

PrimaryButton

Primary Buttons have four sizes: extraSmall, small, medium, and large. Icons are supported for every size and can be positioned at the start or end with the iconPosition prop.

Layout Component

PrimaryButton supports all props from thelayout component.

Props

Props extend from button. Changing the as prop will change the element interface.

Name	Type	Description	Default
`variant`	`'inverse'`	The variant of the PrimaryButton.
`size`		There are four button sizes: `extraSmall`, `small`, `medium`, and `large`. If no size is provided, it will default to `medium`.	`'medium'`
`icon`		The icon of the Button. Note: not displayed at `small` size
`iconPosition`		Button icon positions can either be `start` or `end`. If no value is provided, it defaults to `start`.	`'start'`
`shouldMirrorIcon`	`boolean`	If set to `true`, transform the icon's x-axis to mirror the graphic	`false`
`children`	`ReactNode`
`theme`
`grow`	`boolean`	True if the component should grow to its container's width. False otherwise.
`fill`		The fill color of the SystemIcon. This overrides `color`.
`color`		The color of the SystemIcon. This defines `accent` and `fill`. `color` may be overriden by `accent` and `fill`.
`styles`
`shouldMirror`	`boolean`	If set to `true`, transform the SVG's x-axis to mirror the graphic	`false`
`background`		The background color of the SystemIcon.
`accent`		The accent color of the SystemIcon. This overrides `color`.
`accentHover`		The accent color of the SystemIcon on hover. This overrides `colorHover`.
`backgroundHover`		The background color of the SystemIcon on hover.
`colorHover`		The hover color of the SystemIcon. This defines `accentHover` and `fillHover`. `colorHover` may be overriden by `accentHover` and `fillHover`.
`fillHover`		The fill color of the SystemIcon on hover. This overrides `colorHover`.
`colors`		Override default colors of a button. The default will depend on the button type
`fillIcon`	`boolean`	Whether the icon should received filled (colored background layer) or regular styles. Corresponds to `toggled` in ToolbarIconButton
`as`	`React.ElementType`	Optional override of the default element used by the component. Any valid tag or Component. If you provided a Component, this component should forward the ref using `React.forwardRef`and spread extra props to a root element. Note: Not all elements make sense and some elements may cause accessibility issues. Change this value with care.	`button`
`ref`	`React.Ref<R = button>`	Optional ref. If the component represents an element, this ref will be a reference to the real DOM element of the component. If `as` is set to an element, it will be that element. If `as` is a component, the reference will be to that component (or element if the component uses `React.forwardRef`).

SecondaryButton

Secondary Buttons have four sizes: extraSmall, small, medium, and large. Icons are supported for every size and can be positioned at the start or end with the iconPosition prop.

Layout Component

SecondaryButton supports all props from thelayout component.

Props

Props extend from button. Changing the as prop will change the element interface.

Name	Type	Description	Default
`variant`	`'inverse' \| undefined`	The variant of the SecondaryButton.
`size`		There are four button sizes: `extraSmall`, `small`, `medium`, and `large`. If no size is provided, it will default to `medium`.	`'medium'`
`icon`		The icon of the Button. Note: not displayed at `small` size
`iconPosition`		Button icon positions can either be `start` or `end`. If no value is provided, it defaults to `start`.	`'start'`
`shouldMirrorIcon`	`boolean`	If set to `true`, transform the icon's x-axis to mirror the graphic	`false`
`children`	`ReactNode`
`theme`
`grow`	`boolean`	True if the component should grow to its container's width. False otherwise.
`fill`		The fill color of the SystemIcon. This overrides `color`.
`color`		The color of the SystemIcon. This defines `accent` and `fill`. `color` may be overriden by `accent` and `fill`.
`styles`
`shouldMirror`	`boolean`	If set to `true`, transform the SVG's x-axis to mirror the graphic	`false`
`background`		The background color of the SystemIcon.
`accent`		The accent color of the SystemIcon. This overrides `color`.
`accentHover`		The accent color of the SystemIcon on hover. This overrides `colorHover`.
`backgroundHover`		The background color of the SystemIcon on hover.
`colorHover`		The hover color of the SystemIcon. This defines `accentHover` and `fillHover`. `colorHover` may be overriden by `accentHover` and `fillHover`.
`fillHover`		The fill color of the SystemIcon on hover. This overrides `colorHover`.
`colors`		Override default colors of a button. The default will depend on the button type
`fillIcon`	`boolean`	Whether the icon should received filled (colored background layer) or regular styles. Corresponds to `toggled` in ToolbarIconButton
`as`	`React.ElementType`	Optional override of the default element used by the component. Any valid tag or Component. If you provided a Component, this component should forward the ref using `React.forwardRef`and spread extra props to a root element. Note: Not all elements make sense and some elements may cause accessibility issues. Change this value with care.	`button`
`ref`	`React.Ref<R = button>`	Optional ref. If the component represents an element, this ref will be a reference to the real DOM element of the component. If `as` is set to an element, it will be that element. If `as` is a component, the reference will be to that component (or element if the component uses `React.forwardRef`).

TertiaryButton

Tertiary Buttons have four sizes: extraSmall, small, medium and large. Icons are supported for every size and can be positioned at the start or end with the iconPosition prop.

Layout Component

TertiaryButton supports all props from thelayout component.

Props

Props extend from button. Changing the as prop will change the element interface.

Name	Type	Description	Default
`variant`	`'inverse' \| undefined`	The variant of the TertiaryButton.
`size`		There are four button sizes: `extraSmall`, `small`, `medium`, and `large`. If no size is provided, it will default to `medium`.	`'medium'`
`iconPosition`		Button icon positions can either be `start` or `end`. If no value is provided, it defaults to `start`.	`'start'`
`icon`		The icon of the TertiaryButton.
`shouldMirrorIcon`	`boolean`	If set to `true`, transform the icon's x-axis to mirror the graphic	`false`
`allCaps`	`boolean`	If set to `true`, transform text to all letters uppercase
`children`	`ReactNode`
`isThemeable`	`boolean`	If set to `true`, make icon button available to use theme colors instead of default	`false`
`theme`
`fill`		The fill color of the SystemIcon. This overrides `color`.
`color`		The color of the SystemIcon. This defines `accent` and `fill`. `color` may be overriden by `accent` and `fill`.
`styles`
`shouldMirror`	`boolean`	If set to `true`, transform the SVG's x-axis to mirror the graphic	`false`
`background`		The background color of the SystemIcon.
`accent`		The accent color of the SystemIcon. This overrides `color`.
`accentHover`		The accent color of the SystemIcon on hover. This overrides `colorHover`.
`backgroundHover`		The background color of the SystemIcon on hover.
`colorHover`		The hover color of the SystemIcon. This defines `accentHover` and `fillHover`. `colorHover` may be overriden by `accentHover` and `fillHover`.
`fillHover`		The fill color of the SystemIcon on hover. This overrides `colorHover`.
`colors`		Override default colors of a button. The default will depend on the button type
`fillIcon`	`boolean`	Whether the icon should received filled (colored background layer) or regular styles. Corresponds to `toggled` in ToolbarIconButton
`grow`	`boolean`	True if the component should grow to its container's width. False otherwise.
`as`	`React.ElementType`	Optional override of the default element used by the component. Any valid tag or Component. If you provided a Component, this component should forward the ref using `React.forwardRef`and spread extra props to a root element. Note: Not all elements make sense and some elements may cause accessibility issues. Change this value with care.	`button`
`ref`	`React.Ref<R = button>`	Optional ref. If the component represents an element, this ref will be a reference to the real DOM element of the component. If `as` is set to an element, it will be that element. If `as` is a component, the reference will be to that component (or element if the component uses `React.forwardRef`).

DeleteButton

Layout Component

DeleteButton supports all props from thelayout component.

Props

Props extend from button. Changing the as prop will change the element interface.

Name	Type	Description	Default
`size`	`'small' \| 'medium' \| 'large'`	The size of the Button.	`'medium'`
`children`	`ReactNode`
`theme`
`grow`	`boolean`	True if the component should grow to its container's width. False otherwise.
`fill`		The fill color of the SystemIcon. This overrides `color`.
`color`		The color of the SystemIcon. This defines `accent` and `fill`. `color` may be overriden by `accent` and `fill`.
`styles`
`shouldMirror`	`boolean`	If set to `true`, transform the SVG's x-axis to mirror the graphic	`false`
`background`		The background color of the SystemIcon.
`icon`		The icon to display from `@workday/canvas-system-icons-web`.
`accent`		The accent color of the SystemIcon. This overrides `color`.
`accentHover`		The accent color of the SystemIcon on hover. This overrides `colorHover`.
`backgroundHover`		The background color of the SystemIcon on hover.
`colorHover`		The hover color of the SystemIcon. This defines `accentHover` and `fillHover`. `colorHover` may be overriden by `accentHover` and `fillHover`.
`fillHover`		The fill color of the SystemIcon on hover. This overrides `colorHover`.
`colors`		Override default colors of a button. The default will depend on the button type
`fillIcon`	`boolean`	Whether the icon should received filled (colored background layer) or regular styles. Corresponds to `toggled` in ToolbarIconButton
`as`	`React.ElementType`	Optional override of the default element used by the component. Any valid tag or Component. If you provided a Component, this component should forward the ref using `React.forwardRef`and spread extra props to a root element. Note: Not all elements make sense and some elements may cause accessibility issues. Change this value with care.	`button`
`ref`	`React.Ref<R = button>`	Optional ref. If the component represents an element, this ref will be a reference to the real DOM element of the component. If `as` is set to an element, it will be that element. If `as` is a component, the reference will be to that component (or element if the component uses `React.forwardRef`).

Specifications

Given	When	Then
given primary buttons are rendered		it should not have any axe errors
given primary buttons are rendered		it should render the correct text
given delete buttons are rendered		it should not have any axe errors
given delete buttons are rendered		it should render the correct text

Source: Button.spec.ts

Accessibility Guidelines

How Buttons Impact the Accessible Experience

When buttons are disabled on the UI, color contrast guidelines do not apply to disabled components. Minimum contrast guidelines set in WCAG 2.1 explicitly state disabled components are exempt from the guideline.

When identical buttons are used repeatedly on a screen, users must correctly identify the context around the buttons that cannot be distinguished from one another.

For example: Pencil icon buttons used repeatedly on a profile screen, each designed to edit a section of the profile. Providing uniquely descriptive names (e.g. “Edit photo”, “Edit contact info”) for each icon button can be valuable for screen reader users.

When icons are used inside of buttons containing text, a text alternative is only necessary when the icon is communicating something about the button.

For example: A ‘+’ icon used in a skill pill named “communication” signals an action that is not expressed in the text.
On the other hand: An icon of an eye used to decorate a “View Details” button is redundant and should be hidden from screen readers.

Keyboard Interaction

Each Button should have a focus indicator that is highly visible against the background and against the non-focused state. Refer to Accessible Colors for more information.

Buttons should support the following keyboard interactions:

Tab: Focus on a button
Enter or Space: Activate the button

Buttons should communicate the following to users:

The intended purpose, or function, of the Button
If applicable, the toggle state of the Button when it has 2 states
If applicable, an instruction that the Button will open a menu

Design Annotations Needed

Write accessible name for icon-only button variants. Read more about non-text content.

Implementation Markup Needed

An aria-label string is required for icon-only buttons and accessible tooltips can show the icon's name for everyone.
If the button has 2 toggle states, an aria-pressed attribute is required.
If the button has an attached menu, an aria-haspopup=”true” attribute is required.
[Included in component] Decorative <svg> icons are hidden from assistive technology with role=”presentation” and focusable=”false”.

Content Guidelines

See the Buttons and Calls to Action page in the UI Text section of the Content Style Guide for button language guidelines.
When writing Tooltips to pair with icon-only variants, refer to the Tooltips section of the Content Style Guide.

Can't Find What You Need?

Check out our FAQ section which may help you find the information you're looking for.

FAQ Section

Button

Anatomy

Usage Guidance

When to Use Something Else

Examples

PrimaryButton

SecondaryButton

TertiaryButton

DeleteButton

Custom Styles

Accessible Use of the as Prop

Component API

PrimaryButton

Layout Component

Props

SecondaryButton

Layout Component

Props

TertiaryButton

Layout Component

Props

DeleteButton

Layout Component

Props

Specifications

Accessibility Guidelines

How Buttons Impact the Accessible Experience

Keyboard Interaction

Screen Reader Interaction

Design Annotations Needed

Implementation Markup Needed

Content Guidelines

Can't Find What You Need?

Accessible Use of the `as` Prop