Skip to content

Checkbox API

API reference docs for the React Checkbox component. Learn about the props, CSS, and other APIs of this exported module.

Demos

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

NameTypeDefaultDescription
checkedbool-

If true, the component is checked.

checkedIconnode<CheckIcon />

The icon to display when the component is checked.

classNamestring-

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.

componentelementType-

The component used for the root node. Either a string to use a HTML element or a component.

defaultCheckedbool-

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

disabledbool-

If true, the component is disabled.

disableIconboolfalse

If true, the checked icon is removed and the selected variant is applied on the action element instead.

indeterminateboolfalse

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.

indeterminateIconnode<IndeterminateIcon />

The icon to display when the component is indeterminate.

labelnode-

The label element next to the checkbox.

namestring-

The name attribute of the input.

onChangefunc-

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).
overlayboolfalse

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.

readOnlybool-

If true, the component is read only.

requiredbool-

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.

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

uncheckedIconnode-

The icon when checked is false.

valueArray<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 nameClass nameDefault componentDescription
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 nameRule nameDescription
.Mui-checkedState class applied to the input component's checked class.
.Mui-disabledState class applied to the input component's disabled class.
.Mui-focusVisibleClass name applied to the root element if the switch has visible focus
.MuiCheckbox-colorContextcolorContextClass name applied to the root element when color inversion is triggered.
.MuiCheckbox-colorDangercolorDangerClass name applied to the root element if color="danger".
.MuiCheckbox-colorNeutralcolorNeutralClass name applied to the root element if color="neutral".
.MuiCheckbox-colorPrimarycolorPrimaryClass name applied to the root element if color="primary".
.MuiCheckbox-colorSuccesscolorSuccessClass name applied to the root element if color="success".
.MuiCheckbox-colorWarningcolorWarningClass name applied to the root element if color="warning".
.MuiCheckbox-indeterminateindeterminateState class applied to the root element if indeterminate={true}.
.MuiCheckbox-sizeLgsizeLgClass name applied to the root element if size="lg".
.MuiCheckbox-sizeMdsizeMdClass name applied to the root element if size="md".
.MuiCheckbox-sizeSmsizeSmClass name applied to the root element if size="sm".
.MuiCheckbox-variantOutlinedvariantOutlinedClass name applied to the root element if variant="outlined".
.MuiCheckbox-variantSoftvariantSoftClass name applied to the root element if variant="soft".
.MuiCheckbox-variantSolidvariantSolidClass name applied to the root element if variant="solid".

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

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.