useCheckbox

useCheckbox is a custom hook used to provide checkbox functionality, as well as state and focus management to custom checkbox components when using it.

Import#

import { useCheckbox } from '@chakra-ui/react'

Return value#

The useCheckbox hook returns following props

Name	Type	Description
`state`	`CheckboxState`	An object that contains all props defining the current state of a checkbox.
`getCheckboxProps`	`PropGetter`	A function to get the props of the checkbox.
`getInputProps`	`PropGetter`	A function to get the props of the input field.
`getLabelProps`	`PropGetter`	A function to get the props of the checkbox label.
`htmlProps`	`{}`	An object with all htmlProps.

Usage#

function Example() {
  const CustomCheckbox = (props) => {
    const { state, getCheckboxProps, getInputProps, getLabelProps, htmlProps } =
      useCheckbox(props)

    return (
      <chakra.label
        display='flex'
        flexDirection='row'
        alignItems='center'
        gridColumnGap={2}
        maxW='36'
        bg='green.50'
        border='1px solid'
        borderColor='green.500'
        rounded='lg'
        px={3}
        py={1}
        cursor='pointer'
        {...htmlProps}
      >
        <input {...getInputProps()} hidden />
        <Flex
          alignItems='center'
          justifyContent='center'
          border='2px solid'
          borderColor='green.500'
          w={4}
          h={4}
          {...getCheckboxProps()}
        >
          {state.isChecked && <Box w={2} h={2} bg='green.500' />}
        </Flex>
        <Text {...getLabelProps()}>Click me</Text>
      </chakra.label>
    )
  }

  return (
    <div>
      <CustomCheckbox />
    </div>
  )
}

Parameters#

The useCheckbox hook accepts an object with the following properties:

`aria-describedby`

Type

string

`aria-invalid`

Type

true

`aria-label`

Description

Defines the string that labels the checkbox element.

Type

string

`aria-labelledby`

Description

Refers to the id of the element that labels the checkbox element.

Type

string

`defaultChecked`

Description

If true, the checkbox will be initially checked.

Type

boolean

`defaultIsChecked`

Description

If true, the checkbox will be initially checked. @deprecated Please use the defaultChecked prop, which mirrors default React checkbox behavior.

Type

boolean

`id`

Description

id assigned to input

Type

string

`isChecked`

Description

If true, the checkbox will be checked. You'll need to pass onChange to update its value (since it is now controlled)

Type

boolean

`isDisabled`

Description

If true, the checkbox will be disabled

Type

boolean

`isFocusable`

Description

If true and isDisabled is passed, the checkbox will remain tabbable but not interactive

Type

boolean

`isIndeterminate`

Description

If true, the checkbox will be indeterminate. This only affects the icon shown inside checkbox and does not modify the isChecked property.

Type

boolean

`isInvalid`

Description

If true, the checkbox is marked as invalid. Changes style of unchecked state.

Type

boolean

`isReadOnly`

Description

If true, the checkbox will be readonly

Type

boolean

`isRequired`

Description

If true, the checkbox input is marked as required, and required attribute will be added

Type

boolean

`name`

Description

The name of the input field in a checkbox (Useful for form submission).

Type

string

`onBlur`

Description

The callback invoked when the checkbox is blurred (loses focus)

Type

((event: FocusEvent<HTMLInputElement, Element>) => void)

`onChange`

Description

The callback invoked when the checked state of the Checkbox changes.

Type

((event: ChangeEvent<HTMLInputElement>) => void)

`onFocus`

Description

The callback invoked when the checkbox is focused

Type

((event: FocusEvent<HTMLInputElement, Element>) => void)

`tabIndex`

Type

number

`value`

Description

The value to be used in the checkbox input. This is the value that will be returned on form submission.

Type

string | number