A Button uses the following components:
A button can use different variants.
Primary - For the principal call to action on the page. Primary buttons should only appear once per screen — not including the application header, modal or side panel.
Secondary - For secondary actions on each page. Secondary buttons can be used in conjunction with a primary button or on its own. Paired with a Primary button, the secondary button usually performs the negative action of the set, such as “Cancel.”
Upsell - For upsell actions that relate to upgrading an account or a plan. Use the upsell button to distinguish it from an existing primary button. In some cases, a primary button can be used instead when the general context of the page is about upselling.
Danger - For actions that could have destructive effects on the user’s data.
Ghost-[primary|secondary|danger] - For less prominent, and sometimes independent, actions. Ghost buttons can be used in isolation or paired with a primary button when there are multiple calls to action. Ghost buttons can also be used for subtasks on a page where a primary button for the main and final action is present.
A button can vary in size.
A button can be disabled.
A button can show a loading indicator. The button text is hidden but the button maintains the width that it would have if the text were visible.
Buttons can indicate that a quick progress task is taking place (e.g., saving settings on a server). After a 1 second delay, an indeterminate spinner will be displayed in place of the button label and icon.
A button can be expanded to full width to fill its parent container.
A button can contain only an icon. An accessible name must be provided through aria-label prop. See also WCAG practices.
A button can contain icons.
Nonstandard end icons can be provided to handle special cases. However, think twice before adding end icons, start icons should be your go-to.
The visual style of the button.
A button can vary in size.
Whether or not the button takes up the width of its container.
A button can show a loading indicator.
The props for the Spinner.
The element to associate the button with. The value of this attribute must be the id of a in the same document.
The inline style for the element. A function may be provided to compute the style based on component state.
The children of the component. A function may be provided to alter the children based on component state.
Whether the button is disabled.
Whether the element should receive focus on render.
The behavior of the button when used in an HTML form.
The URL that processes the information submitted by the button. Overrides the action attribute of the button's form owner.
Indicates how to encode the form data that is submitted.
Indicates the HTTP method used to submit the form.
Indicates that the form is not to be validated when it is submitted.
Overrides the target attribute of the button's form owner.
Submitted as a pair with the button's value as part of the form data.
The value associated with the button's name when it's submitted with the form data.
The CSS className for the element. A function may be provided to compute the class based on component state.
Handler that is called when the press is released over the target.
Handler that is called when a press interaction starts.
Handler that is called when a press interaction ends, either over the target or when the pointer leaves the target.
Handler that is called when the press state changes.
Handler that is called when a press is released over the target, regardless of whether it started on the target or not.
Not recommended – use onPress instead. onClick is an alias for onPress
provided for compatibility with other libraries. onPress provides
additional event details for non-mouse interactions.
Handler that is called when the element receives focus.
Handler that is called when the element loses focus.
Handler that is called when the element's focus status changes.
Handler that is called when a key is pressed.
Handler that is called when a key is released.
Handler that is called when a hover interaction starts.
Handler that is called when a hover interaction ends.
Handler that is called when the hover state changes.
A slot name for the component. Slots allow the component to receive props from a parent component.
An explicit null value indicates that the local props completely override all props received from a parent.
Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
Identifies the element (or elements) whose contents or presence are controlled by the current element.
Indicates the current "pressed" state of toggle buttons.
Indicates whether this element represents the current item within a container or set of related elements.
Whether to prevent focus from moving to the button when pressing it.
Caution, this can make the button inaccessible and should only be used when alternative keyboard interaction is provided, such as ComboBox's MenuTrigger or a NumberField's increment/decrement control.
Whether to exclude the element from the sequential tab order. If true, the element will not be focusable via the keyboard by tabbing. This should be avoided except in rare scenarios where an alternative means of accessing the element or its functionality via the keyboard is available.
The element's unique identifier. See MDN.
Defines a string value that labels the current element.
Identifies the element (or elements) that labels the current element.
Identifies the element (or elements) that describes the object.
Identifies the element (or elements) that provide a detailed, extended description for the object.
Coming from Orbiter, you should be aware of the following changes:
onClick has been renamed to onPress to be closer to the React Aria API.Counter is no longer allowed as a specialized slot.ButtonAsLink is renamed to LinkButton.IconButton is now integrated into the Button component.as(Button, ReactRouterLink) is now integrated into the Button component.