Skip to content

Checkbox API

API reference docs for the React Checkbox component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Import

import Checkbox from '@mui/material/Checkbox';
// or
import { Checkbox } from '@mui/material';
Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the ButtonBase component are also available.

checked
checkedIcon
classes
color
defaultChecked
disabled
disableRipple
icon
id
indeterminate
indeterminateIcon
inputProps
inputRef
onChange
required
size
sx
value
The ref is forwarded to the root element.

Inheritance

While not explicitly documented above, the props of the ButtonBase component are also available in Checkbox. You can take advantage of this to target nested components.

Theme default props

You can use MuiCheckbox to change the default props of this component with the theme.

CSS

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.

.MuiCheckbox-root
.Mui-checkedSTATE
.Mui-disabledSTATE
.MuiCheckbox-indeterminate
.MuiCheckbox-colorPrimary
.MuiCheckbox-colorSecondary
.MuiCheckbox-sizeSmall
.MuiCheckbox-sizeMedium

You can override the style of the component using one of these customization options: