---
id: checkbox
scope: theming
---
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](/docs/styled-system/component-style#styling-multipart-components)
> 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.
```jsx live=false
import { checkboxAnatomy } from '@chakra-ui/anatomy'
import { createMultiStyleConfigHelpers } from '@chakra-ui/react'
const { definePartsStyle, defineMultiStyleConfig } =
createMultiStyleConfigHelpers(checkboxAnatomy.keys)
```
## Customizing the default theme
```jsx live=false
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:
```jsx live=false
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:
```jsx live=false
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
...
```
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](/docs/styled-system/cli).
## Adding a custom variant
Let's assume we want to include a custom circular variant. Here's how we can do
that:
```jsx live=false
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
...
```
## 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:
```jsx live=false
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:
...
```
## Showcase
import {
App,
Index,
CheckboxTheme,
} from 'configs/sandpack-contents/component-theming/checkbox'