Button

Buttons allow users to perform an action or to navigate to another page. They have multiple styles for various needs, and are ideal for calling attention to where a user needs to do something in order to move forward in a flow.

installyarn add @react-spectrum/button
version3.0.0-rc.2
usageimport {Button} from '@react-spectrum/button'
View guidelines
Spectrum
View repository
GitHub
View package
NPM

Example#

<Button variant="cta">Save</Button>
<Button variant="cta">Save</Button>
<Button variant="cta">
  Save
</Button>

Content#

Buttons can have a label, and icon, or both. An icon is provided by passing an icon component to the icon prop. A visible label can be provided by passing children.

import {Text} from '@react-spectrum/text';

<Button variant="primary">Label only</Button>
<Button variant="primary">
  <Bell />
  <Text>Icon + Label</Text>
</Button>
<Button variant="primary" aria-label="Icon only">
  <Bell />
</Button>
import {Text} from '@react-spectrum/text';

<Button variant="primary">Label only</Button>
<Button variant="primary">
  <Bell />
  <Text>Icon + Label</Text>
</Button>
<Button variant="primary" aria-label="Icon only">
  <Bell />
</Button>
import {Text} from '@react-spectrum/text';

<Button variant="primary">
  Label only
</Button>
<Button variant="primary">
  <Bell />
  <Text>
    Icon + Label
  </Text>
</Button>
<Button
  variant="primary"
  aria-label="Icon only">
  <Bell />
</Button>

Accessibility#

If no visible label is provided (e.g. an icon only button), an alternative text label must be provided to identify the control for accessibility. This should be added using the aria-label prop.

Internationalization#

In order to internationalize a button, a localized string should be passed to the children or aria-label prop.

Events#

Buttons support user interactions via mouse, keyboard, and touch. You can handle all of these via the onPress prop.

The following example uses an onPress handler to update a counter stored in React state.

function Example() {
  let [count, setCount] = React.useState(0);

  return (
    <Button variant="primary" onPress={() => setCount((c) => c + 1)}>
      {count} Dogs
    </Button>
  );
}

function Example() {
  let [count, setCount] = React.useState(0);

  return (
    <Button
      variant="primary"
      onPress={() => setCount((c) => c + 1)}>
      {count} Dogs
    </Button>
  );
}

function Example() {
  let [
    count,
    setCount
  ] = React.useState(0);

  return (
    <Button
      variant="primary"
      onPress={() =>
        setCount(
          (c) => c + 1
        )
      }>
      {count} Dogs
    </Button>
  );
}

Props#

NameTypeDefaultDescription
variant'cta' | 'overBackground' | 'primary' | 'secondary' | 'negative'—The visual style of the button.
isQuietboolean—Whether the button should be displayed with a quiet style.
type'button' | 'submit' | 'reset''button'The behavior of the button when used in an HTML form.
isDisabledboolean—Whether the button is disabled
childrenReactNode—The content to display in the button.
autoFocusboolean—Whether the element should receive focus on render
elementTypestring | JSXElementConstructor<any>'button'The HTML element or React element used to render the button, e.g. 'div', 'a', or RouterLink.
hrefstring—A URL to link to if elementType="a".
targetstring—The target window for the link.
Events
NameTypeDefaultDescription
onPress( (e: PressEvent )) => void—Handler that is called when the press is released over the target.
onPressStart( (e: PressEvent )) => void—Handler that is called when a press interaction starts.
onPressEnd( (e: PressEvent )) => void—Handler that is called when a press interaction ends, either over the target or when the pointer leaves the target.
onPressChange( (isPressed: boolean )) => void—Handler that is called when the press state changes.
onPressUp( (e: PressEvent )) => void—Handler that is called when a press is released over the target, regardless of whether it started on the target or not.
onFocus( (e: FocusEvent )) => void—Handler that is called when the element receives focus.
onBlur( (e: FocusEvent )) => void—Handler that is called when the element loses focus.
onFocusChange( (isFocused: boolean )) => void—Handler that is called when the element's focus status changes.
onKeyDown( (e: KeyboardEvent )) => void—Handler that is called when a key is pressed.
onKeyUp( (e: KeyboardEvent )) => void—Handler that is called when a key is released.
Layout
NameTypeDefaultDescription
flexstring | number | boolean—When used in a flex layout, specifies how the element will grow or shrink to fit the space available. See MDN.
flexGrownumber—When used in a flex layout, specifies how the element will grow to fit the space available. See MDN.
flexShrinknumber—When used in a flex layout, specifies how the element will shrink to fit the space available. See MDN.
flexBasisnumber | string—When used in a flex layout, specifies the initial main size of the element. See MDN.
alignSelf'auto' | 'normal' | 'start' | 'end' | 'center' | 'flex-start' | 'flex-end' | 'self-start' | 'self-end' | 'stretch'—Overrides the alignItems property of a flex or grid container. See MDN.
justifySelf'auto' | 'normal' | 'start' | 'end' | 'flex-start' | 'flex-end' | 'self-start' | 'self-end' | 'center' | 'left' | 'right' | 'stretch'—Specifies how the element is justified inside a flex or grid container. See MDN.
ordernumber—The layout order for the element within a flex or grid container. See MDN.
gridAreastring—When used in a grid layout, specifies the named grid area that the element should be placed in within the grid. See MDN.
gridColumnstring—When used in a grid layout, specifies the column the element should be placed in within the grid. See MDN.
gridRowstring—When used in a grid layout, specifies the row the element should be placed in within the grid. See MDN.
gridColumnStartstring—When used in a grid layout, specifies the starting column to span within the grid. See MDN.
gridColumnEndstring—When used in a grid layout, specifies the ending column to span within the grid. See MDN.
gridRowStartstring—When used in a grid layout, specifies the starting row to span within the grid. See MDN.
gridRowEndstring—When used in a grid layout, specifies the ending row to span within the grid. See MDN.
Spacing
NameTypeDefaultDescription
marginDimensionValue—The margin for all four sides of the element. See MDN.
marginTopDimensionValue—The margin for the top side of the element. See MDN.
marginBottomDimensionValue—The margin for the bottom side of the element. See MDN.
marginStartDimensionValue—The margin for the logical start side of the element, depending on layout direction. See MDN.
marginEndDimensionValue—The margin for the logical end side of an element, depending on layout direction. See MDN.
marginXDimensionValue—The margin for both the left and right sides of the element. See MDN.
marginYDimensionValue—The margin for both the top and bottom sides of the element. See MDN.
Sizing
NameTypeDefaultDescription
widthDimensionValue—The width of the element. See MDN.
minWidthDimensionValue—The minimum width of the element. See MDN.
maxWidthDimensionValue—The maximum width of the element. See MDN.
heightDimensionValue—The height of the element. See MDN.
minHeightDimensionValue—The minimum height of the element. See MDN.
maxHeightDimensionValue—The maximum height of the element. See MDN.
Positioning
NameTypeDefaultDescription
position'static' | 'relative' | 'absolute' | 'fixed' | 'sticky'—Specifies how the element is positioned. See MDN.
topDimensionValue—The top position for the element. See MDN.
bottomDimensionValue—The bottom position for the element. See MDN.
leftDimensionValue—The left position for the element. See MDN. Consider using start instead for RTL support.
rightDimensionValue—The right position for the element. See MDN. Consider using start instead for RTL support.
startDimensionValue—The logical start position for the element, depending on layout direction. See MDN.
endDimensionValue—The logical end position for the element, depending on layout direction. See MDN.
zIndexnumber—The stacking order for the element. See MDN.
isHiddenboolean—Hides the element.
Accessibility
NameTypeDefaultDescription
idstring—
tabIndexnumber—
aria-expandedboolean—Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-haspopupboolean | 'menu' | 'listbox' | 'tree' | 'grid' | 'dialog'—Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-controlsstring—Identifies the element (or elements) whose contents or presence are controlled by the current element.
aria-pressedboolean—Indicates the current "pressed" state of toggle buttons.
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the object.
Advanced
NameTypeDefaultDescription
UNSAFE_classNamestring—Sets the CSS className for the element. Only use as a last resort. Use style props instead.
UNSAFE_styleCSSProperties—Sets inline style for the element. Only use as a last resort. Use style props instead.

Visual options#

Call to action#

View guidelines

<Button variant="cta">Save</Button>
<Button variant="cta">Save</Button>
<Button variant="cta">
  Save
</Button>

Primary#

View guidelines

<Button variant="primary">Save</Button>
<Button variant="primary" isQuiet>Save</Button>
<Button variant="primary">Save</Button>
<Button variant="primary" isQuiet>Save</Button>
<Button variant="primary">
  Save
</Button>
<Button
  variant="primary"
  isQuiet>
  Save
</Button>

Secondary#

View guidelines

<Button variant="secondary">Save</Button>
<Button variant="secondary" isQuiet>Save</Button>
<Button variant="secondary">Save</Button>
<Button variant="secondary" isQuiet>Save</Button>
<Button variant="secondary">
  Save
</Button>
<Button
  variant="secondary"
  isQuiet>
  Save
</Button>

Over background#

View guidelines

<View backgroundColor="positive" padding="size-300">
  <Button variant="overBackground">Save</Button>
  <Button variant="overBackground" isQuiet>Save</Button>
</View>
<View backgroundColor="positive" padding="size-300">
  <Button variant="overBackground">Save</Button>
  <Button variant="overBackground" isQuiet>Save</Button>
</View>
<View
  backgroundColor="positive"
  padding="size-300">
  <Button variant="overBackground">
    Save
  </Button>
  <Button
    variant="overBackground"
    isQuiet>
    Save
  </Button>
</View>

Negative#

View guidelines

<Button variant="negative">Save</Button>
<Button variant="negative" isQuiet>Save</Button>
<Button variant="negative">Save</Button>
<Button variant="negative" isQuiet>Save</Button>
<Button variant="negative">
  Save
</Button>
<Button
  variant="negative"
  isQuiet>
  Save
</Button>