useToggleState

Provides state management for toggle components like checkboxes and switches.

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

API#

useToggleState(
  (props: ToggleStateOptions
)): ToggleState

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

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.

Name	Type	Description
`defaultSelected`	`boolean`	Whether the element should be selected (uncontrolled).
`isSelected`	`boolean`	Whether the element should be selected (controlled).
`onChange`	`( (isSelected: boolean )) => void`	Handler that is called when the element's selection state changes.
`isDisabled`	`boolean`	Whether the input is disabled.
`isReadOnly`	`boolean`	Whether the input can be selected but not changed by the user.