alpha

ToggleButton

A toggle button allows a user to toggle a selection on or off, for example switching between two states or modes.

install	`yarn add react-aria-components`
version	1.0.0-alpha.6
usage	`import {ToggleButton} from 'react-aria-components'`

View ARIA pattern

Example#

import {ToggleButton} from 'react-aria-components';

<ToggleButton>Pin</ToggleButton>

import {ToggleButton} from 'react-aria-components';

<ToggleButton>Pin</ToggleButton>

import {ToggleButton} from 'react-aria-components';

<ToggleButton>
  Pin
</ToggleButton>

Show CSS

.react-aria-ToggleButton {
  --deselected-border-color: var(--spectrum-global-color-gray-400);
  --deselected-border-color-pressed: var(--spectrum-global-color-gray-500);
  --deselected-background-color: var(--spectrum-global-color-gray-50);
  --deselected-background-color-pressed: var(--spectrum-global-color-gray-100);
  --selected-color: slateblue;
  --selected-color-pressed: lch(from slateblue calc(l - 10%) c h);
  --text-color: var(--spectrum-alias-text-color);
  --text-color-selected: white;

  color: var(--text-color);
  background: var(--deselected-background-color);
  border: 1px solid var(--deselected-border-color);
  border-radius: 4px;
  appearance: none;
  vertical-align: middle;
  font-size: 1.2rem;
  text-align: center;
  margin: 0;
  outline: none;
  padding: 4px 12px;

  &[data-pressed] {
    box-shadow: inset 0 1px 2px rgb(0 0 0 / 0.1);
    background: var(--deselected-background-color-pressed);
    border-color: var(--deselected-border-color-pressed);
  }

  &[aria-pressed=true] {
    background: var(--selected-color);
    border-color: var(--selected-color);
    color: var(--text-color-selected);

    &[data-pressed] {
      background: var(--selected-color-pressed);
      border-color: var(--selected-color-pressed);
    }
  }

  &[data-focus-visible] {
    border-color: var(--selected-color);
    box-shadow: 0 0 0 1px var(--selected-color);
  }

  &:disabled {
    opacity: 0.4;
  }
}

@media (forced-colors: active) {
  .react-aria-ToggleButton {
    forced-color-adjust: none;

    --deselected-border-color: ButtonBorder;
    --deselected-border-color-pressed: ButtonBorder;
    --deselected-background-color: ButtonFace;
    --deselected-background-color-pressed: ButtonFace;
    --selected-color: Highlight;
    --selected-color-pressed: Highlight;
    --text-color: ButtonText;
    --text-color-selected: HighlightText;

    &:disabled {
      opacity: 1;
      --deselected-border-color: GrayText;
      --selected-color: GrayText;
      --text-color: GrayText;
    }
  }
}

.react-aria-ToggleButton {
  --deselected-border-color: var(--spectrum-global-color-gray-400);
  --deselected-border-color-pressed: var(--spectrum-global-color-gray-500);
  --deselected-background-color: var(--spectrum-global-color-gray-50);
  --deselected-background-color-pressed: var(--spectrum-global-color-gray-100);
  --selected-color: slateblue;
  --selected-color-pressed: lch(from slateblue calc(l - 10%) c h);
  --text-color: var(--spectrum-alias-text-color);
  --text-color-selected: white;

  color: var(--text-color);
  background: var(--deselected-background-color);
  border: 1px solid var(--deselected-border-color);
  border-radius: 4px;
  appearance: none;
  vertical-align: middle;
  font-size: 1.2rem;
  text-align: center;
  margin: 0;
  outline: none;
  padding: 4px 12px;

  &[data-pressed] {
    box-shadow: inset 0 1px 2px rgb(0 0 0 / 0.1);
    background: var(--deselected-background-color-pressed);
    border-color: var(--deselected-border-color-pressed);
  }

  &[aria-pressed=true] {
    background: var(--selected-color);
    border-color: var(--selected-color);
    color: var(--text-color-selected);

    &[data-pressed] {
      background: var(--selected-color-pressed);
      border-color: var(--selected-color-pressed);
    }
  }

  &[data-focus-visible] {
    border-color: var(--selected-color);
    box-shadow: 0 0 0 1px var(--selected-color);
  }

  &:disabled {
    opacity: 0.4;
  }
}

@media (forced-colors: active) {
  .react-aria-ToggleButton {
    forced-color-adjust: none;

    --deselected-border-color: ButtonBorder;
    --deselected-border-color-pressed: ButtonBorder;
    --deselected-background-color: ButtonFace;
    --deselected-background-color-pressed: ButtonFace;
    --selected-color: Highlight;
    --selected-color-pressed: Highlight;
    --text-color: ButtonText;
    --text-color-selected: HighlightText;

    &:disabled {
      opacity: 1;
      --deselected-border-color: GrayText;
      --selected-color: GrayText;
      --text-color: GrayText;
    }
  }
}

.react-aria-ToggleButton {
  --deselected-border-color: var(--spectrum-global-color-gray-400);
  --deselected-border-color-pressed: var(--spectrum-global-color-gray-500);
  --deselected-background-color: var(--spectrum-global-color-gray-50);
  --deselected-background-color-pressed: var(--spectrum-global-color-gray-100);
  --selected-color: slateblue;
  --selected-color-pressed: lch(from slateblue calc(l - 10%) c h);
  --text-color: var(--spectrum-alias-text-color);
  --text-color-selected: white;

  color: var(--text-color);
  background: var(--deselected-background-color);
  border: 1px solid var(--deselected-border-color);
  border-radius: 4px;
  appearance: none;
  vertical-align: middle;
  font-size: 1.2rem;
  text-align: center;
  margin: 0;
  outline: none;
  padding: 4px 12px;

  &[data-pressed] {
    box-shadow: inset 0 1px 2px rgb(0 0 0 / 0.1);
    background: var(--deselected-background-color-pressed);
    border-color: var(--deselected-border-color-pressed);
  }

  &[aria-pressed=true] {
    background: var(--selected-color);
    border-color: var(--selected-color);
    color: var(--text-color-selected);

    &[data-pressed] {
      background: var(--selected-color-pressed);
      border-color: var(--selected-color-pressed);
    }
  }

  &[data-focus-visible] {
    border-color: var(--selected-color);
    box-shadow: 0 0 0 1px var(--selected-color);
  }

  &:disabled {
    opacity: 0.4;
  }
}

@media (forced-colors: active) {
  .react-aria-ToggleButton {
    forced-color-adjust: none;

    --deselected-border-color: ButtonBorder;
    --deselected-border-color-pressed: ButtonBorder;
    --deselected-background-color: ButtonFace;
    --deselected-background-color-pressed: ButtonFace;
    --selected-color: Highlight;
    --selected-color-pressed: Highlight;
    --text-color: ButtonText;
    --text-color-selected: HighlightText;

    &:disabled {
      opacity: 1;
      --deselected-border-color: GrayText;
      --selected-color: GrayText;
      --text-color: GrayText;
    }
  }
}

Features#

Toggle buttons are similar to action buttons, but support an additional selection state that is toggled when a user presses the button. There is no built-in HTML element that represents a toggle button, so React Aria implements it using ARIA attributes.

Styleable – Hover, press, keyboard focus, and selection states are provided for easy styling. These states only apply when interacting with an appropriate input device, unlike CSS pseudo classes.
Accessible – Uses a native <button> element with the aria-pressed attribute, and supports the Space and Enter keys to toggle the selection state.
Cross-browser – Mouse, touch, keyboard, and focus interactions are normalized to ensure consistency across browsers and devices.

Read our blog post about the complexities of building buttons that work well across devices and interaction methods to learn more.

Anatomy#

Toggle buttons consist of a clickable area usually containing a textual label or an icon that users can click to toggle a selection state. In addition, keyboard users may toggle the state using the Space or Enter keys.

If a visual label is not provided (e.g. an icon only button), then an aria-label or aria-labelledby prop must be passed to identify the button to assistive technology.

Props#

Name	Type	Default	Description
`isSelected`	`boolean`	—	Whether the element should be selected (controlled).
`defaultSelected`	`boolean`	—	Whether the element should be selected (uncontrolled).
`isDisabled`	`boolean`	—	Whether the button is disabled.
`autoFocus`	`boolean`	—	Whether the element should receive focus on render.
`type`	`'button' \| 'submit' \| 'reset'`	`'button'`	The behavior of the button when used in an HTML form.
`children`	`ReactNode \| ( (values: ToggleButtonRenderProps )) => ReactNode`	—	The children of the component. A function may be provided to alter the children based on component state.
`className`	`string \| ( (values: ToggleButtonRenderProps )) => string`	—	The CSS className for the element. A function may be provided to compute the class based on component state.
`style`	`CSSProperties \| ( (values: ToggleButtonRenderProps )) => CSSProperties`	—	The inline style for the element. A function may be provided to compute the style based on component state.

Events

Name	Type	Default	Description
`onChange`	`( (isSelected: boolean )) => void`	—	Handler that is called when the element's selection state changes.
`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<Target> )) => void`	—	Handler that is called when the element receives focus.
`onBlur`	`( (e: FocusEvent<Target> )) => 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

Name	Type	Default	Description
`slot`	`string`	—	A slot name for the component. Slots allow the component to receive props from a parent component.

Accessibility

Name	Type	Default	Description
`id`	`string`	—	The element's unique identifier. See MDN.
`excludeFromTabOrder`	`boolean`	—	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.
`aria-expanded`	`boolean \| 'true' \| 'false'`	—	Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
`aria-haspopup`	`boolean \| 'menu' \| 'listbox' \| 'tree' \| 'grid' \| 'dialog' \| 'true' \| 'false'`	—	Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
`aria-controls`	`string`	—	Identifies the element (or elements) whose contents or presence are controlled by the current element.
`aria-pressed`	`boolean \| 'true' \| 'false' \| 'mixed'`	—	Indicates the current "pressed" state of toggle buttons.
`aria-label`	`string`	—	Defines a string value that labels the current element.
`aria-labelledby`	`string`	—	Identifies the element (or elements) that labels the current element.
`aria-describedby`	`string`	—	Identifies the element (or elements) that describes the object.
`aria-details`	`string`	—	Identifies the element (or elements) that provide a detailed, extended description for the object.

Styling#

React Aria components can be styled in many ways, including using CSS classes, inline styles, utility classes (e.g. Tailwind), CSS-in-JS (e.g. Styled Components), etc. By default, all components include a builtin className attribute which can be targeted using CSS selectors. These follow the react-aria-ComponentName naming convention.

.react-aria-ToggleButton {
  /* ... */
}

.react-aria-ToggleButton {
  /* ... */
}

.react-aria-ToggleButton {
  /* ... */
}

A custom className can also be specified on any component. This overrides the default className provided by React Aria with your own.

<ToggleButton className="my-button">
  {/* ... */}
</ToggleButton>

<ToggleButton className="my-button">
  {/* ... */}
</ToggleButton>

<ToggleButton className="my-button">
  {/* ... */}
</ToggleButton>

In addition, some components support multiple UI states (e.g. focused, placeholder, readonly, etc.). React Aria components expose states using DOM attributes, which you can target in CSS selectors. These are ARIA attributes wherever possible, or data attributes when a relevant ARIA attribute does not exist. For example:

.react-aria-ToggleButton[aria-pressed=true] {
  /* ... */
}

.react-aria-ToggleButton[aria-pressed=true] {
  /* ... */
}

.react-aria-ToggleButton[aria-pressed=true] {
  /* ... */
}

The className and style props also accept functions which receive states for styling. This lets you dynamically determine the classes or styles to apply, which is useful when using utility CSS libraries like Tailwind.

<ToggleButton
  className={({ isSelected }) => isSelected ? 'bg-blue-600' : 'bg-gray-600'}
/>

<ToggleButton
  className={({ isSelected }) =>
    isSelected ? 'bg-blue-600' : 'bg-gray-600'}
/>

<ToggleButton
  className={(
    { isSelected }
  ) =>
    isSelected
      ? 'bg-blue-600'
      : 'bg-gray-600'}
/>

Render props may also be used as children to alter what elements are rendered based on the current state. For example, you could render swap an icon depending on the selection state.

<ToggleButton>
  {({isSelected}) => (
    <>
      {isSelected ? <PinnedIcon /> : <UnpinnedIcon />}
      Pin
    </>
  )}
</ToggleButton>

<ToggleButton>
  {({isSelected}) => (
    <>
      {isSelected ? <PinnedIcon /> : <UnpinnedIcon />}
      Pin
    </>
  )}
</ToggleButton>

<ToggleButton>
  {(
    { isSelected }
  ) => (
    <>
      {isSelected
        ? (
          <PinnedIcon />
        )
        : (
          <UnpinnedIcon />
        )}
      Pin
    </>
  )}
</ToggleButton>

The states, selectors, and render props for ToggleButton are documented below.

Name	CSS Selector	Description
`isSelected`	`[aria-pressed=true]`	Whether the button is currently selected.
`state`	`—`	State of the toggle button.
`isHovered`	`[data-hovered]`	Whether the button is currently hovered with a mouse.
`isPressed`	`[data-pressed]`	Whether the button is currently in a pressed state.
`isFocused`	`:focus`	Whether the button is focused, either via a mouse or keyboard.
`isFocusVisible`	`[data-focus-visible]`	Whether the button is keyboard focused.
`isDisabled`	`:disabled`	Whether the button is disabled.

Usage#

Controlled selection state#

A default selection state for a toggle button can be set using the defaultSelected prop, or controlled with the isSelected prop. The onChange event is fired when the user presses the button, toggling the boolean. See React's documentation on uncontrolled components for more info.

function Example() {
  let [isSelected, setSelected] = React.useState(false);

  return (
    <ToggleButton
      isSelected={isSelected}
      onChange={setSelected}
      aria-label="Star">
      ★
    </ToggleButton>
  );
}

function Example() {
  let [isSelected, setSelected] = React.useState(false);

  return (
    <ToggleButton
      isSelected={isSelected}
      onChange={setSelected}
      aria-label="Star">
      ★
    </ToggleButton>
  );
}

function Example() {
  let [
    isSelected,
    setSelected
  ] = React.useState(
    false
  );

  return (
    <ToggleButton
      isSelected={isSelected}
      onChange={setSelected}
      aria-label="Star"
    >
      ★
    </ToggleButton>
  );
}

Disabled#

A ToggleButton can be disabled using the isDisabled prop.

<ToggleButton isDisabled>Pin</ToggleButton>

<ToggleButton isDisabled>Pin</ToggleButton>

<ToggleButton
  isDisabled
>
  Pin
</ToggleButton>

Advanced customization#

Hooks#

If you need to customize things further, such as accessing internal state or customizing DOM structure, you can drop down to the lower level Hook-based API. See useToggleButton for more details.

Method	Description
`setSelected( (isSelected: boolean )): void`	Updates selection state.
`toggle(): void`	Toggle the selection state.

Name	Type	Description
`type`	`'pressstart' \| 'pressend' \| 'pressup' \| 'press'`	The type of press event being fired.
`pointerType`	`PointerType`	The pointer type that triggered the press event.
`target`	`Element`	The target element of the press event.
`shiftKey`	`boolean`	Whether the shift keyboard modifier was held during the press event.
`ctrlKey`	`boolean`	Whether the ctrl keyboard modifier was held during the press event.
`metaKey`	`boolean`	Whether the meta keyboard modifier was held during the press event.
`altKey`	`boolean`	Whether the alt keyboard modifier was held during the press event.

Method	Description
`continuePropagation(): void`	By default, press events stop propagation to parent elements. In cases where a handler decides not to handle a specific event, it can call `continuePropagation()` to allow a parent to handle it.