useCheckboxGroupState

Provides state management for a checkbox group component. Provides a name for the group, and manages selection and focus state.

install	`yarn add react-stately`
version	3.23.0
usage	`import {useCheckboxGroupState} from 'react-stately'`

API#

useCheckboxGroupState(
  (props: CheckboxGroupProps
)): CheckboxGroupState

Name	Type	Description
`value`	`readonly string[]`	Current selected values.
`isDisabled`	`boolean`	Whether the checkbox group is disabled.
`isReadOnly`	`boolean`	Whether the checkbox group is read only.
`validationState`	`ValidationState`	The current validation state of the checkbox group.

Method	Description
`isSelected( (value: string )): boolean`	Returns whether the given value is selected.
`setValue( (value: string[] )): void`	Sets the selected values.
`addValue( (value: string )): void`	Adds a value to the set of selected values.
`removeValue( (value: string )): void`	Removes a value from the set of selected values.
`toggleValue( (value: string )): void`	Toggles a value in the set of selected values.

Name	Type	Default	Description
`value`	`string[]`	—	The current value (controlled).
`defaultValue`	`string[]`	—	The default value (uncontrolled).
`onChange`	`( (value: T )) => void`	—	Handler that is called when the value changes.
`isDisabled`	`boolean`	—	Whether the input is disabled.
`isReadOnly`	`boolean`	—	Whether the input can be selected but not changed by the user.
`label`	`ReactNode`	—	The content to display as the label.
`description`	`ReactNode`	—	A description for the field. Provides a hint such as specific requirements for what to choose.
`errorMessage`	`ReactNode`	—	An error message for the field.
`validationState`	`ValidationState`	—	Whether the input should display its "valid" or "invalid" visual styling.
`isRequired`	`boolean`	—	Whether user input is required on the input before form submission. Often paired with the `necessityIndicator` prop to add a visual indicator to the input.
`validationBehavior`	`'aria' \| 'native'`	`'aria'`	Whether `isRequired` should use native HTML form validation to prevent form submission when a value is missing, or only mark the field as required via ARIA.
`onValidationChange`	`( (state: FormValidationEvent )) => void`	—	Handler that is called when input validation changes.

Name	Type	Description
`isInvalid`	`boolean`	Whether the input is invalid.
`errorMessage`	`string`	The current error message for the input if it is invalid, otherwise an empty string.
`validationDetails`	`ValidityState`	The native validation details for the input.