Button
Buttons highlight actions available on a screen.
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.
Here is a basic example of a Primary Button. Buttons can be customized with several props to change the size, add an icon, etc.
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.
Component API
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: | 'medium' |
icon | | The icon of the Button.
Note: not displayed at | |
iconPosition | | Button icon positions can either be | 'start' |
shouldMirrorIcon | boolean | If set to | false |
children | ReactNode | ||
theme | | ||
grow | boolean | True if the component should grow to its container's width. False otherwise. | |
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 | |
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 Note: Not all elements make sense and some elements may cause accessibility issues. Change this value with care. | button |
ref | React.Ref | Optional ref. If the component represents an element, this ref will be a reference to the real DOM element of the component. If |
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.
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.
Component API
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: | 'medium' |
icon | | The icon of the Button.
Note: not displayed at | |
iconPosition | | Button icon positions can either be | 'start' |
shouldMirrorIcon | boolean | If set to | false |
children | ReactNode | ||
theme | | ||
grow | boolean | True if the component should grow to its container's width. False otherwise. | |
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 | |
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 Note: Not all elements make sense and some elements may cause accessibility issues. Change this value with care. | button |
ref | React.Ref | Optional ref. If the component represents an element, this ref will be a reference to the real DOM element of the component. If |
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.
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.