Checkbox

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

Import#

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

Usage#

<Checkbox.Root defaultChecked>
  <Checkbox.Control />
  <Checkbox.Label> Checkbox</Checkbox.Label>
</Checkbox.Root>

Disabling the checkbox#

<Stack gap={5} direction='row'>
  <Checkbox.Root disabled>
    <Checkbox.Control />
    <Checkbox.Label>Checkbox</Checkbox.Label>
  </Checkbox.Root>
  <Checkbox.Root disabled defaultChecked>
    <Checkbox.Control />
    <Checkbox.Label>Checkbox</Checkbox.Label>
  </Checkbox.Root>
</Stack>

Changing the color palette#

Pass the colorPalette prop to change the color of the Checkbox.

<Stack gap={5} direction='row'>
  <Checkbox.Root colorPalette='red' defaultChecked>
    <Checkbox.Control />
    <Checkbox.Label>Checkbox</Checkbox.Label>
  </Checkbox.Root>
  <Checkbox.Root colorPalette='green' defaultChecked>
    <Checkbox.Control />
    <Checkbox.Label>Checkbox</Checkbox.Label>
  </Checkbox.Root>
</Stack>

Changing the size#

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

<Stack gap={[1, 5]} direction={['column', 'row']}>
  <Checkbox.Root size='sm' colorPalette='red'>
    <Checkbox.Control />
    <Checkbox.Label>Checkbox</Checkbox.Label>
  </Checkbox.Root>
  <Checkbox.Root size='md' colorPalette='green' defaultChecked>
    <Checkbox.Control />
    <Checkbox.Label>Checkbox</Checkbox.Label>
  </Checkbox.Root>
  <Checkbox.Root size='lg' colorPalette='orange' defaultChecked>
    <Checkbox.Control />
    <Checkbox.Label>Checkbox</Checkbox.Label>
  </Checkbox.Root>
</Stack>

Making the checkbox invalid#

<Checkbox.Root invalid>
  <Checkbox.Control />
  <Checkbox.Label>Checkbox</Checkbox.Label>
</Checkbox.Root>

Changing the gap between the checkbox and label#

Use the gap prop to customize the spacing between the checkbox and label text.

<Checkbox.Root gap='1rem'>
  <Checkbox.Control />
  <Checkbox.Label>Checkbox</Checkbox.Label>
</Checkbox.Root>

Changing the rendered icon#

Use the Checkbox.Indicator component to customize the rendered icon when checked or indeterminate.

<Checkbox.Root iconColor='blue.400' iconSize='1rem'>
  <Checkbox.Control>
    <Checkbox.Indicator checked={<MdCheckCircle />} />
  </Checkbox.Control>
  <Checkbox.Label>Checkbox</Checkbox.Label>
</Checkbox.Root>

Indeterminate#

function IndeterminateExample() {
  const [checkedItems, setCheckedItems] = React.useState([false, false])

  const allChecked = checkedItems.every(Boolean)
  const indeterminate = checkedItems.some(Boolean) && !allChecked

  return (
    <>
      <Checkbox.Root
        checked={allChecked}
        indeterminate={indeterminate}
        onChange={(e) => setCheckedItems([e.target.checked, e.target.checked])}
      >
        <Checkbox.Control />
        <Checkbox.Label> Parent Checkbox</Checkbox.Label>
      </Checkbox.Root>
      <Stack paddingStart={6} marginTop={1} gap={1}>
        <Checkbox.Root
          checked={checkedItems[0]}
          onChange={(e) => setCheckedItems([e.target.checked, checkedItems[1]])}
        >
          <Checkbox.Control />
          <Checkbox.Label> Child Checkbox 1</Checkbox.Label>
        </Checkbox.Root>
        <Checkbox.Root
          checked={checkedItems[1]}
          onChange={(e) => setCheckedItems([checkedItems[0], e.target.checked])}
        >
          <Checkbox.Control />
          <Checkbox.Label> Child Checkbox 2</Checkbox.Label>
        </Checkbox.Root>
      </Stack>
    </>
  )
}

Managing a group of checkboxes#

Use the Checkbox.Group component to manage the checked state of its children checkboxes.

<Checkbox.Group colorPalette='green' defaultValue={['naruto', 'kakashi']}>
  <Stack gap={[1, 5]} direction={['column', 'row']}>
    <Checkbox.Root value='naruto'>
      <Checkbox.Control />
      <Checkbox.Label> Naruto</Checkbox.Label>
    </Checkbox.Root>
    <Checkbox.Root value='sasuke'>
      <Checkbox.Control />
      <Checkbox.Label> Sasuke</Checkbox.Label>
    </Checkbox.Root>
    <Checkbox.Root value='kakashi'>
      <Checkbox.Control />
      <Checkbox.Label> Kakashi</Checkbox.Label>
    </Checkbox.Root>
  </Stack>
</Checkbox.Group>

Hooks#

The useCheckbox hook is exported with state and focus management logic for use in creating tailor-made checkbox component for your application. Read more about the useCheckbox hook here.

The useCheckboxGroup hook is exported with state management logic for use in creating tailor-made checkbox group component for your application. Read more about the useCheckboxGroup hook here.

Props#

Checkbox Props#

CheckboxGroup Props#

Shared Style Props#

The following style props can be set on CheckboxGroup and they will be forwarded to all children Checkbox components.

Name	Type	Default	Description
colorScheme	`string`		The color of the checkbox when it is checked. This should be one of the color keys in the theme (e.g."green", "red").
children	`React.ReactNode`		The content of the checkbox group.
size	`sm`, `md`, `lg`	`md`	The size of the checkbox.
variant	`string`		The `variant` of the checkbox.

The Checkbox component is a multipart component. The styling needs to be applied to each part specifically.

To learn more about styling multipart components, visit the Component Style page.

Anatomy#

A: control
B: icon
C: container
D: label

Theming properties#

The properties that affect the theming of the Checkbox component are:

size: The size of the checkbox. Defaults to md.
colorScheme: The color scheme of the checkbox. Defaults to blue.

Theming utilities#

createMultiStyleConfigHelpers: a function that returns a set of utilities for creating style configs for a multipart component (definePartsStyle and defineMultiStyleConfig).
definePartsStyle: a function used to create multipart style objects.
defineMultiStyleConfig: a function used to define the style configuration for a multipart component.

import { checkboxAnatomy } from '@chakra-ui/anatomy'
import { createMultiStyleConfigHelpers } from '@chakra-ui/react'

const { definePartsStyle, defineMultiStyleConfig } =
  createMultiStyleConfigHelpers(checkboxAnatomy.keys)

Customizing the default theme#

import { checkboxAnatomy } from '@chakra-ui/anatomy'
import { createMultiStyleConfigHelpers } from '@chakra-ui/react'

const { definePartsStyle, defineMultiStyleConfig } =
  createMultiStyleConfigHelpers(checkboxAnatomy.keys)

const baseStyle = definePartsStyle({
  // define the part you're going to style
  label: {
    fontFamily: 'mono', // change the font family of the label
  },
  control: {
    padding: 3, // change the padding of the control
    borderRadius: 0, // change the border radius of the control
  },
})

export const checkboxTheme = defineMultiStyleConfig({ baseStyle })

After customizing the checkbox theme, we can import it in our theme file and add it in the components property:

import { extendTheme } from '@chakra-ui/react'
import { checkboxTheme } from './components/checkbox.ts'

export const theme = extendTheme({
  components: { Checkbox: checkboxTheme },
})

This is a crucial step to make sure that any changes that we make to the checkbox theme are applied.

Adding a custom size#

Let's assume we want to include an extra large checkbox size. Here's how we can do that:

import { checkboxAnatomy } from '@chakra-ui/anatomy'
import { createMultiStyleConfigHelpers, defineStyle } from '@chakra-ui/react'

const { definePartsStyle, defineMultiStyleConfig } =
  createMultiStyleConfigHelpers(checkboxAnatomy.keys)

const sizes = {
  xl: definePartsStyle({
    control: defineStyle({
      boxSize: 14
    }),
    label: defineStyle({
      fontSize: "2xl",
      marginLeft: 6
    })
  }),
}

export const checkboxTheme = defineMultiStyleConfig({ sizes })

// Now we can use the new `xl` size
<Checkbox size="xl">...</Checkbox>

Every time you're adding anything new to the theme, you'd need to run the CLI command to get proper autocomplete in your IDE. You can learn more about the CLI tool here.

Adding a custom variant#

Let's assume we want to include a custom circular variant. Here's how we can do that:

import { checkboxAnatomy } from '@chakra-ui/anatomy'
import { createMultiStyleConfigHelpers, defineStyle } from '@chakra-ui/react'

const { definePartsStyle, defineMultiStyleConfig } =
  createMultiStyleConfigHelpers(checkboxAnatomy.keys)

const circular = definePartsStyle({
  control: defineStyle({
    rounded: "full"
  })
})

export const checkboxTheme = defineMultiStyleConfig({
  variants: { circular },
})

// Now we can use the new `circular` variant
<Checkbox variant="circular">...</Checkbox>

Changing the default properties#

Let's assume we want to change the default size and variant of every checkbox in our app. Here's how we can do that:

import { checkboxAnatomy } from '@chakra-ui/anatomy'
import { createMultiStyleConfigHelpers, defineStyle } from '@chakra-ui/react'

const { defineMultiStyleConfig } = createMultiStyleConfigHelpers(
  checkboxAnatomy.keys,
)

export const checkboxTheme = defineMultiStyleConfig({
  defaultProps: {
    size: 'xl',
    variant: 'circular',
  },
})

// This saves you time, instead of manually setting the size and variant every time you use a checkbox:
<Checkbox size="xl" variant="circular">...</Checkbox>

Showcase#

import { Box, SimpleGrid, IconButton, Checkbox, useColorMode } from "@chakra-ui/react";
import { FaMoon, FaSun } from "react-icons/fa";

export default function App() {
  const { toggleColorMode, colorMode } = useColorMode();
  return (
    <Box position="relative">
      <SimpleGrid gap={12} p={12} columns={2}>
        <Checkbox>Themed Checkbox</Checkbox>
        <Checkbox size="xl">Themed XL Checkbox</Checkbox>
        <Checkbox variant="circular">Themed Circular Checkbox</Checkbox>
        <Checkbox variant="circular" size="xl">Themed XL Circular Checkbox</Checkbox>
        <Checkbox variant="circular" size="xl" colorScheme="red">Themed Red XL Circular Checkbox</Checkbox>
      </SimpleGrid>

      <IconButton
        aria-label="toggle theme"
        rounded="full"
        size="xs"
        position="absolute"
        bottom={4}
        left={4}
        onClick={toggleColorMode} icon={colorMode === "dark" ? <FaSun /> : <FaMoon />}
      />
    </Box>
  );
}

Open Sandbox

Edit this page on GitHub