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:

Checkbox

Import

import Checkbox from '@mui/joy/Checkbox';
// or
import { Checkbox } from '@mui/joy';

You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name JoyCheckbox can be used when providing default props or style overrides in the theme.

Props

Name	Type	Default	Description
checked	bool		If `true`, the component is checked.
checkedIcon	node	<CheckIcon />	The icon to display when the component is checked.
className	string		Class name applied to the root element.
color	'danger' \| 'info' \| 'neutral' \| 'primary' \| 'success' \| 'warning'	'neutral'	The color of the component. It supports those theme colors that make sense for this component.
defaultChecked	bool		The default checked state. Use when the component is not controlled.
disabled	bool		If `true`, the component is disabled.
disableIcon	bool	false	If `true`, the checked icon is removed and the selected variant is applied on the `action` element instead.
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	<IndeterminateIcon />	The icon to display when the component is indeterminate.
label	node		The label element next to the checkbox.
name	string		The `name` attribute of the input.
onChange	func		Callback fired when the state is changed. Signature: `function(event: React.ChangeEvent<HTMLInputElement>) => void` event: The event source of the callback. You can pull out the new value by accessing `event.target.value` (string). You can pull out the new checked state by accessing `event.target.checked` (boolean).
overlay	bool	false	If `true`, the root element's position is set to initial which allows the action area to fill the nearest positioned parent. This prop is useful for composing Checkbox with ListItem component.
readOnly	bool		If `true`, the component is read only.
required	bool		If `true`, the `input` element is required.
size	'sm' \| 'md' \| 'lg'	'md'	The size of the component.
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.
uncheckedIcon	node		The icon when `checked` is false.
value	Array<string> \| number \| string		The value of the component. The DOM API casts this to a string. The browser uses "on" as the default value.
variant	'outlined' \| 'plain' \| 'soft' \| 'solid'	'solid'	The variant to use.

The ref is forwarded to the root element.