Skip to content

Checkbox API

API documentation for the React Checkbox component. Learn about the available props, and the CSS API.


import Checkbox from '@material-ui/core/Checkbox';
// or
import { Checkbox } from '@material-ui/core';
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.


checkedboolfalseIf true, the component is checked.
checkedIconnode<CheckBoxIcon />The icon to display when the component is checked.
classesobjectOverride or extend the styles applied to the component. See CSS API below for more details.
| 'primary'
| 'secondary'
'secondary'The color of the component. It supports those theme colors that make sense for this component.
defaultCheckedboolfalseThe default checked state. Use when the component is not controlled.
disabledboolfalseIf true, the component is disabled.
disableRippleboolfalseIf true, the ripple effect is disabled.
iconnode<CheckBoxOutlineBlankIcon />The icon to display when the component is unchecked.
idstringThe id of the input element.
indeterminateboolfalseIf 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.
inputPropsobjectAttributes applied to the input element.
inputRefrefPass a ref to the input element.
onChangefuncCallback fired when the state is changed.

function(event: object) => void
event: The event source of the callback. You can pull out the new checked state by accessing (boolean).
requiredboolfalseIf true, the input element is required.
| 'small'
'medium'The size of the component. small is equivalent to the dense checkbox styling.
sxobjectThe system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.
valueanyThe 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.
Any other props supplied will be provided to the root element (IconButton).


While not explicitly documented above, the props of the IconButton 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-checkedPseudo-class applied to the root element if checked={true}.
disabled.Mui-disabledPseudo-class applied to the root element if disabled={true}.
indeterminate.MuiCheckbox-indeterminatePseudo-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: