{ "props": { "checked": { "type": { "name": "bool" } }, "checkedIcon": { "type": { "name": "node" }, "default": "" }, "classes": { "type": { "name": "object" }, "additionalInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'default'
| 'primary'
| 'secondary'
| 'error'
| 'info'
| 'success'
| 'warning'
| string" }, "default": "'primary'" }, "defaultChecked": { "type": { "name": "bool" } }, "disabled": { "type": { "name": "bool" }, "default": "false" }, "disableRipple": { "type": { "name": "bool" }, "default": "false" }, "icon": { "type": { "name": "node" }, "default": "" }, "id": { "type": { "name": "string" } }, "indeterminate": { "type": { "name": "bool" }, "default": "false" }, "indeterminateIcon": { "type": { "name": "node" }, "default": "" }, "inputProps": { "type": { "name": "object" }, "deprecated": true, "deprecationInfo": "Use slotProps.input instead. This prop will be removed in a future major release. See Migrating from deprecated APIs for more details." }, "onChange": { "type": { "name": "func" }, "signature": { "type": "function(event: React.ChangeEvent) => void", "describedArgs": ["event"] } }, "required": { "type": { "name": "bool" }, "default": "false" }, "size": { "type": { "name": "union", "description": "'medium'
| 'small'
| string" }, "default": "'medium'" }, "slotProps": { "type": { "name": "shape", "description": "{ input?: func
| object, root?: func
| object }" }, "default": "{}" }, "slots": { "type": { "name": "shape", "description": "{ input?: elementType, root?: elementType }" }, "default": "{}" }, "sx": { "type": { "name": "union", "description": "Array<func
| object
| bool>
| func
| object" }, "additionalInfo": { "sx": true } }, "value": { "type": { "name": "any" } } }, "name": "Checkbox", "imports": [ "import Checkbox from '@mui/material/Checkbox';", "import { Checkbox } from '@mui/material';" ], "slots": [ { "name": "root", "description": "The component that renders the root slot.", "default": "SwitchBase", "class": "MuiCheckbox-root" }, { "name": "input", "description": "The component that renders the input slot.", "default": "SwitchBase's input", "class": null } ], "classes": [ { "key": "checked", "className": "Mui-checked", "description": "State class applied to the root element if `checked={true}`.", "isGlobal": true }, { "key": "colorPrimary", "className": "MuiCheckbox-colorPrimary", "description": "State class applied to the root element if `color=\"primary\"`.", "isGlobal": false }, { "key": "colorSecondary", "className": "MuiCheckbox-colorSecondary", "description": "State class applied to the root element if `color=\"secondary\"`.", "isGlobal": false }, { "key": "disabled", "className": "Mui-disabled", "description": "State class applied to the root element if `disabled={true}`.", "isGlobal": true }, { "key": "indeterminate", "className": "MuiCheckbox-indeterminate", "description": "State class applied to the root element if `indeterminate={true}`.", "isGlobal": false }, { "key": "sizeMedium", "className": "MuiCheckbox-sizeMedium", "description": "State class applied to the root element if `size=\"medium\"`.", "isGlobal": false }, { "key": "sizeSmall", "className": "MuiCheckbox-sizeSmall", "description": "State class applied to the root element if `size=\"small\"`.", "isGlobal": false } ], "spread": true, "themeDefaultProps": true, "muiName": "MuiCheckbox", "forwardsRefTo": "HTMLSpanElement", "filename": "/packages/mui-material/src/Checkbox/Checkbox.js", "inheritance": { "component": "ButtonBase", "pathname": "/material-ui/api/button-base/" }, "demos": "", "cssComponent": false }