Checkbox

Checkboxes give users binary choices when presented with multiple options in a series.

Checkbox API

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

Props of the native component are also available.

Name	Type	Default	Description
checked	bool	undefined	If `true`, the component is checked.
className	func \| string	-	Class names applied to the element or a function that returns them based on the component's state.
defaultChecked	bool	false	The default checked state. Use when the component is not controlled.
disabled	bool	false	If `true`, the component is disabled.
indeterminate	bool	false	If `true`, the checkbox will be indeterminate.
name	string	undefined	Name of the underlying input element.
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).
readOnly	bool	false	If `true`, the component is read only.
render	func	-	A function to customize rendering of the component.
required	bool	false	If `true`, the `input` element is required.

The ref is forwarded to the root element.

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

import { CheckboxIndicator } from '@mui/base/Checkbox';
// or
import { CheckboxIndicator } from '@mui/base';

Props of the native component are also available.

Name	Type	Default	Description
className	func \| string	-	Class names applied to the element or a function that returns them based on the component's state.
keepMounted	bool	false	If `true`, the indicator stays mounted when unchecked. Useful for CSS animations.
render	func	-	A function to customize rendering of the component.

The ref is forwarded to the root element.

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