Checkbox

The Checkbox component is used in forms when a user needs to select multiple values from several options.

Native HTML checkboxes are 100% accessible by default, so we used a very common CSS technique to style the checkboxes.

Import#

Usage#

Basic usage of checkbox.

Editable Example

Disabled Checkbox#

Editable Example

Checkbox with custom color#

You can override the color scheme of the checkbox to any color key specified in theme.colors.

Editable Example

Checkbox sizes#

Pass the size prop to change the size of the Checkbox. Values can be either sm, md or lg.

Editable Example

Invalid Checkbox#

Editable Example

Changing the spacing#

We added the spacing prop to customize the spacing between the checkbox and label text

Changing the icon color and size#

You can customize the color and size of the check icon by passing the iconColor and iconSize prop.

Indeterminate#

Editable Example

CheckboxGroup#

Chakra exports a CheckboxGroup component to help manage the checked state of its children.

Editable Example

Hooks#

The useCheckbox hook is exported with state and focus management logic for use in creating tailor-made checkbox component for your application

The useCheckboxGroup hook is exported with state management logic for use in creating tailor-made checkbox group component for your application

Props#

Checkbox Props#

NameTypeDefaultDescription
idstringThe id assigned to input field
namestringThe name of the input field in a checkbox (Useful for form submission)
valuestring or numberThe value to be used in the checkbox input. This is the value that will be returned on form submission.
colorSchemestringThe color of the checkbox when it's checked. This should be one of the color keys in the theme (e.g."green", "red")
defaultIsCheckedbooleanIf true, the checkbox will be initially checked.
isCheckedbooleanIf true, the checkbox will be checked. You'll need to pass onChange to update it's value (since it's now controlled)
isIndeterminatebooleanIf true, the checkbox will be indeterminate. This only affects the icon shown inside checkbox
isFullWidthbooleanIf true, the checkbox should take up the full width of the parent.
sizesm, md, lgmdThe size (width and height) of the checkbox
isDisabledbooleanIf true, the checkbox will be disabled
isInvalidbooleanIf true, the checkbox is marked as invalid. Changes style of unchecked state.
childrenReact.ReactNodeThe children of the checkbox.
onChangefunctionFunction called when the state of the checkbox changes.
onBlurfunctionFunction called when you blur out of the checkbox.
onFocusfunctionFunction called when the checkbox receive focus.
aria-labelstringAn accessible label for the checkbox in event there's no visible label or children passed
aria-labelledbystringId that points to the label for the checkbox in event no children was passed

CheckboxGroup Props#

CheckboxGroup composes Box so you can pass all Box props.

NameTypeDefaultDescription
idstringThe id of the checkbox group.
valueArray<Checkbox["value"]>The value of the checkbox group
defaultValueArray<Checkbox["value"]>The initial value of the checkbox group
colorSchemestringThe color of the checkbox when it's checked. This should be one of the color keys in the theme (e.g."green", "red")
onChange(values: Array<Checkbox["value"]>): voidThe callback fired when any children Checkbox is checked or unchecked
childrenReact.ReactNodeThe content of the checkbox group. Must be the Checkbox component
spacingStyledSystem.MarginProps8pxThe space between each checkbox
sizesm, md, lgmdThe size of the checkbox, it's forwarded to all children checkbox.
Edit this page

Made byChakraandRock Content