Checkbox API

The API documentation of the Checkbox React component. Learn more about the props and the CSS customization points.

Import

import Checkbox from '@material-ui/core/Checkbox';
// or
import { Checkbox } from '@material-ui/core';

You can learn more about the difference by reading this guide.

Component name

The MuiCheckbox name can be used for providing default props or style overrides at the theme level.

Props

Name	Type	Default	Description
checked	bool		If true, the component is checked.
checkedIcon	node	<CheckBoxIcon />	The icon to display when the component is checked.
classes	object		Override or extend the styles applied to the component. See CSS API below for more details.
color	'default' | 'primary' | 'secondary'	'secondary'	The color of the component. It supports those theme colors that make sense for this component.
disabled	bool		If true, the checkbox will be disabled.
disableRipple	bool		If true, the ripple effect will be disabled.
icon	node	<CheckBoxOutlineBlankIcon />	The icon to display when the component is unchecked.
id	string		The id of the input element.
indeterminate	bool	false	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.
indeterminateIcon	node	<IndeterminateCheckBoxIcon />	The icon to display when the component is indeterminate.
inputProps	object		Attributes applied to the input element.
inputRef	ref		Pass a ref to the input element.
onChange	func		Callback fired when the state is changed. Signature: function(event: object) => void event: The event source of the callback. You can pull out the new checked state by accessing event.target.checked (boolean).
required	bool		If true, the input element will be required.
size	'medium' | 'small'	'medium'	The size of the checkbox. small is equivalent to the dense checkbox styling.
value	any		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.

Any other props supplied will be provided to the root element (IconButton).

CSS

Rule name	Global class	Description
root	.MuiCheckbox-root	Styles applied to the root element.
checked	.Mui-checked	Pseudo-class applied to the root element if checked={true}.
disabled	.Mui-disabled	Pseudo-class applied to the root element if disabled={true}.
indeterminate	.MuiCheckbox-indeterminate	Pseudo-class applied to the root element if indeterminate={true}.
colorPrimary	.MuiCheckbox-colorPrimary	Styles applied to the root element if color="primary".
colorSecondary	.MuiCheckbox-colorSecondary	Styles applied to the root element if color="secondary".

You can override the style of the component thanks to one of these customization points:

• With a rule name of the classes object prop.
• With a global class name.
• With a theme and an overrides property.

If that's not sufficient, you can check the implementation of the component for more detail.

Inheritance

The props of the IconButton component are also available. You can take advantage of this behavior to target nested components.

Demos

• Checkboxes
• Transfer List