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.

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' \| '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.
defaultChecked	bool		The default checked state. Use when the component is not controlled.
disabled	bool	false	If `true`, the component is disabled.
disableRipple	bool	false	If `true`, the ripple effect is 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: React.ChangeEvent) => void` `event` The event source of the callback. You can pull out the new checked state by accessing `event.target.checked` (boolean).
required	bool	false	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.
sx	Array<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.
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.

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.

Global class	Rule name	Description
.MuiCheckbox-root	root	Class name applied to the root element.
.Mui-checked	checked	State class applied to the root element if `checked={true}`.
.Mui-disabled	disabled	State class applied to the root element if `disabled={true}`.
.MuiCheckbox-indeterminate	indeterminate	State class applied to the root element if `indeterminate={true}`.
.MuiCheckbox-colorPrimary	colorPrimary	State class applied to the root element if `color="primary"`.
.MuiCheckbox-colorSecondary	colorSecondary	State class applied to the root element if `color="secondary"`.
.MuiCheckbox-sizeSmall	sizeSmall	State class applied to the root element if `size="small"`.
.MuiCheckbox-sizeMedium	sizeMedium	State class applied to the root element if `size="medium"`.

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

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.

Have any feedback about this new API display design?

We've heard from you and iterated on making the design of API content documentation more scalable and easier to parse! We value your input, so please don't hesitate to share any additional feedback you may have.