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';

Learn about the difference by reading this guide on minimizing bundle size.

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' \| 'neutral' \| 'primary' \| 'success' \| 'warning' \| string	'neutral'	The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.
component	elementType	-	The component used for the root node. Either a string to use a HTML element or a 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) => 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. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.
slotProps	{ action?: func \| object, checkbox?: func \| object, input?: func \| object, label?: func \| object, root?: func \| object }	{}	The props used for each slot inside.
slots	{ action?: elementType, checkbox?: elementType, input?: elementType, label?: elementType, root?: elementType }	{}	The components used for each slot inside. See Slots API below for more details.
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 global variant to use. To learn how to add your own variants, check out Themed components—Extend variants.

The ref is forwarded to the root element.

Theme default props

You can use JoyCheckbox to change the default props of this component with the theme.

Slots

To learn how to customize the slot, check out the Overriding component structure guide.

Slot name	Class name	Default component	Description
root	.MuiCheckbox-root	`'span'`	The component that renders the root.
checkbox	.MuiCheckbox-checkbox	`'span'`	The component that renders the checkbox.
action	.MuiCheckbox-action	`'span'`	The component that renders the action.
input	.MuiCheckbox-input	`'input'`	The component that renders the input.
label	.MuiCheckbox-label	`'label'`	The component that renders the label.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class name	Rule name	Description
.Mui-checked		State class applied to the input component's `checked` class.
.Mui-disabled		State class applied to the input component's disabled class.
.Mui-focusVisible		Class name applied to the root element if the switch has visible focus
.MuiCheckbox-colorContext	colorContext	Class name applied to the root element when color inversion is triggered.
.MuiCheckbox-colorDanger	colorDanger	Class name applied to the root element if `color="danger"`.
.MuiCheckbox-colorNeutral	colorNeutral	Class name applied to the root element if `color="neutral"`.
.MuiCheckbox-colorPrimary	colorPrimary	Class name applied to the root element if `color="primary"`.
.MuiCheckbox-colorSuccess	colorSuccess	Class name applied to the root element if `color="success"`.
.MuiCheckbox-colorWarning	colorWarning	Class name applied to the root element if `color="warning"`.
.MuiCheckbox-indeterminate	indeterminate	State class applied to the root element if `indeterminate={true}`.
.MuiCheckbox-sizeLg	sizeLg	Class name applied to the root element if `size="lg"`.
.MuiCheckbox-sizeMd	sizeMd	Class name applied to the root element if `size="md"`.
.MuiCheckbox-sizeSm	sizeSm	Class name applied to the root element if `size="sm"`.
.MuiCheckbox-variantOutlined	variantOutlined	Class name applied to the root element if `variant="outlined"`.
.MuiCheckbox-variantSoft	variantSoft	Class name applied to the root element if `variant="soft"`.
.MuiCheckbox-variantSolid	variantSolid	Class name applied to the root element if `variant="solid"`.

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.

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.