useToggleState

Provides state management for toggle components like checkboxes and switches.

install	`yarn add react-stately`
version	3.27.1
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.
`value`	`string`	The value of the input element, used when submitting an HTML form. See MDN.
`isDisabled`	`boolean`	Whether the input is disabled.
`isReadOnly`	`boolean`	Whether the input can be selected but not changed by the user.
`isRequired`	`boolean`	Whether user input is required on the input before form submission.
`isInvalid`	`boolean`	Whether the input value is invalid.
`autoFocus`	`boolean`	Whether the element should receive focus on render.
`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.