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.


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


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

Component name

The name MuiCheckbox can be used when providing default props or style overrides in the theme.


Props of the ButtonBase component are also available.

If true, the component is checked.
checkedIconnode<CheckBoxIcon />
The icon to display when the component is checked.
Override or extend the styles applied to the component. See CSS API below for more details.
| 'primary'
| 'secondary'
| 'error'
| 'info'
| 'success'
| 'warning'
| string
The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.
The default checked state. Use when the component is not controlled.
If true, the component is disabled.
If true, the ripple effect is disabled.
iconnode<CheckBoxOutlineBlankIcon />
The icon to display when the component is unchecked.
The id of the input element.
If true, the component appears indeterminate. This does not set the native input element to indeterminate due to inconsistent behavior across browsers. However, we set a data-indeterminate attribute on the input.
indeterminateIconnode<IndeterminateCheckBoxIcon />
The icon to display when the component is indeterminate.
Attributes applied to the input element.
Pass a ref to the input element.
Callback fired when the state is changed.

function(event: React.ChangeEvent<HTMLInputElement>) => void
event: The event source of the callback. You can pull out the new checked state by accessing (boolean).
If true, the input element is required.
| 'small'
| string
The size of the component. small is equivalent to the dense checkbox styling.
| object
| bool>
| func
| object
The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.
The value of the component. The DOM API casts this to a string. The browser uses "on" as the default value.

The ref is forwarded to the root element.


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


Rule nameGlobal classDescription
root.MuiCheckbox-rootStyles applied to the root element.
checked.Mui-checkedState class applied to the root element if checked={true}.
disabled.Mui-disabledState class applied to the root element if disabled={true}.
indeterminate.MuiCheckbox-indeterminateState class applied to the root element if indeterminate={true}.
colorPrimary.MuiCheckbox-colorPrimaryStyles applied to the root element if color="primary".
colorSecondary.MuiCheckbox-colorSecondaryStyles applied to the root element if color="secondary".

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