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

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.

NameTypeDefaultDescription
checkedbool-

If true, the component is checked.

checkedIconnode<CheckBoxIcon />

The icon to display when the component is checked.

classesobject-

Override or extend the styles applied to the component.

See CSS classes API below for more details.

color'default'
| 'primary'
| 'secondary'
| 'error'
| 'info'
| 'success'
| 'warning'
| string
'primary'

The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.

defaultCheckedbool-

The default checked state. Use when the component is not controlled.

disabledboolfalse

If true, the component is disabled.

disableRippleboolfalse

If true, the ripple effect is disabled.

iconnode<CheckBoxOutlineBlankIcon />

The icon to display when the component is unchecked.

idstring-

The id of the input element.

indeterminateboolfalse

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.

inputPropsobject-

Attributes applied to the input element.

inputRefref-

Pass a ref to the input element.

onChangefunc-

Callback fired when the state is changed.

Signature:function(event: React.ChangeEvent) => void
  • event The event source of the callback. You can pull out the new checked state by accessing event.target.checked (boolean).
requiredboolfalse

If true, the input element is required.

size'medium'
| 'small'
| string
'medium'

The size of the component. small is equivalent to the dense checkbox styling.

sxArray<func
| 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.

valueany-

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.

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 classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class nameRule nameDescription
.Mui-checkedState class applied to the root element if checked={true}.
.Mui-disabledState class applied to the root element if disabled={true}.
.MuiCheckbox-colorPrimarycolorPrimaryState class applied to the root element if color="primary".
.MuiCheckbox-colorSecondarycolorSecondaryState class applied to the root element if color="secondary".
.MuiCheckbox-indeterminateindeterminateState class applied to the root element if indeterminate={true}.
.MuiCheckbox-rootrootClass name applied to the root element.
.MuiCheckbox-sizeMediumsizeMediumState class applied to the root element if size="medium".
.MuiCheckbox-sizeSmallsizeSmallState class applied to the root element if size="small".

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

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.