Checkbox API
The API documentation of the Checkbox React component. Learn more about the properties and the CSS customization points.
import Checkbox from '@material-ui/core/Checkbox';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 | enum: 'primary' | 'secondary' | 'default' |
'secondary' | The color of the component. It supports those theme colors that make sense for this component. |
| disabled | bool | If true, the switch 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 | union: func | object |
This property can be used to pass a ref callback to the input element. |
|
| onChange | func | Callback fired when the state is changed. Signature: function(event: object, checked: boolean) => voidevent: The event source of the callback. You can pull out the new value by accessing event.target.checked.checked: The checked value of the switch |
|
| type | string | The input component property type. |
|
| value | any | The value of the component. The DOM API casts this to a string. |
The ref is forwarded to the root element.
Any other properties supplied will be provided to the root element (IconButton).
CSS
You can override all the class names injected by Material-UI thanks to the classes property.
This property accepts the following keys:
| Name | Description |
|---|---|
| root | Styles applied to the root element. |
| checked | Styles applied to the root element if checked={true}. |
| disabled | Styles applied to the root element if disabled={true}. |
| indeterminate | Styles applied to the root element if indeterminate={true}. |
| colorPrimary | Styles applied to the root element if color="primary". |
| colorSecondary | Styles applied to the root element if color="secondary". |
Have a look at the overriding styles with classes section and the implementation of the component for more detail.
If using the overrides key of the theme,
you need to use the following style sheet name: MuiCheckbox.
Inheritance
The properties of the IconButton component are also available. You can take advantage of this behavior to target nested components.
Notes
The component can cause issues in StrictMode.