Skip to content
Edit this page

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.

checked

If true, the component is checked.

Type:

bool
checkedIcon

The icon to display when the component is checked.

Type:

node

Default:

<CheckBoxIcon />
classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:

object
color

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

Type:

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

Default:

'primary'
defaultChecked

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

Type:

bool
disabled

If true, the component is disabled.

Type:

bool

Default:

false
disableRipple

If true, the ripple effect is disabled.

Type:

bool

Default:

false
icon

The icon to display when the component is unchecked.

Type:

node

Default:

<CheckBoxOutlineBlankIcon />
id

The id of the input element.

Type:

string
indeterminate

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.

Type:

bool

Default:

false
indeterminateIcon

The icon to display when the component is indeterminate.

Type:

node

Default:

<IndeterminateCheckBoxIcon />
inputProps

Attributes applied to the input element.

Type:

object
inputRef

Pass a ref to the input element.

Type:

ref
onChange

Callback fired when the state is changed.

Type:

func

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

If true, the input element is required.

Type:

bool

Default:

false
size

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

Type:

'medium' | 'small' | string

Default:

'medium'
sx

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:

Array<func | object | bool> | func | object
value

The value of the component. The DOM API casts this to a string. The browser uses "on" as the default value.

Type:

any
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.


.MuiCheckbox-rootroot

Class name applied to the root element.

.Mui-checkedcheckedSTATE

State class applied to the root element if checked={true}.

.Mui-disableddisabledSTATE

State class applied to the root element if disabled={true}.

.MuiCheckbox-indeterminateindeterminate

State class applied to the root element if indeterminate={true}.

.MuiCheckbox-colorPrimarycolorPrimary

State class applied to the root element if color="primary".

.MuiCheckbox-colorSecondarycolorSecondary

State class applied to the root element if color="secondary".

.MuiCheckbox-sizeSmallsizeSmall

State class applied to the root element if size="small".

.MuiCheckbox-sizeMediumsizeMedium

State class applied to the root element if size="medium".

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