This page is still being migrated to our new website. In the meantime, you can explore the new React Aria Components docs here.

useToggleState

Provides state management for toggle components like checkboxes and switches.

install	`yarn add react-stately`
version	3.43.0
usage	`import {useToggleState} from 'react-stately'`

API#

useToggleState(
  (props: ToggleStateOptions
)): ToggleState

Name	Type	Description
`isSelected`	`boolean`	Whether the toggle is selected.
`defaultSelected`	`boolean`	Whether the toggle is selected by default.

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

See the docs for useCheckbox in react-aria for an example of useToggleState.