react-test/docs/pages/joy-ui/api/checkbox.json

{
  "props": {
    "checked": { "type": { "name": "bool" } },
    "checkedIcon": { "type": { "name": "node" }, "default": "<CheckIcon />" },
    "className": { "type": { "name": "string" } },
    "color": {
      "type": {
        "name": "union",
        "description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'<br>&#124;&nbsp;string"
      },
      "default": "'neutral'",
      "additionalInfo": { "joy-color": true }
    },
    "component": { "type": { "name": "elementType" } },
    "defaultChecked": { "type": { "name": "bool" } },
    "disabled": { "type": { "name": "bool" } },
    "disableIcon": { "type": { "name": "bool" }, "default": "false" },
    "indeterminate": { "type": { "name": "bool" }, "default": "false" },
    "indeterminateIcon": { "type": { "name": "node" }, "default": "<IndeterminateIcon />" },
    "label": { "type": { "name": "node" } },
    "name": { "type": { "name": "string" } },
    "onChange": {
      "type": { "name": "func" },
      "signature": {
        "type": "function(event: React.ChangeEvent<HTMLInputElement>) => void",
        "describedArgs": ["event"]
      }
    },
    "overlay": { "type": { "name": "bool" }, "default": "false" },
    "readOnly": { "type": { "name": "bool" } },
    "required": { "type": { "name": "bool" } },
    "size": {
      "type": { "name": "enum", "description": "'sm'<br>&#124;&nbsp;'md'<br>&#124;&nbsp;'lg'" },
      "default": "'md'",
      "additionalInfo": { "joy-size": true }
    },
    "slotProps": {
      "type": {
        "name": "shape",
        "description": "{ action?: func<br>&#124;&nbsp;object, checkbox?: func<br>&#124;&nbsp;object, input?: func<br>&#124;&nbsp;object, label?: func<br>&#124;&nbsp;object, root?: func<br>&#124;&nbsp;object }"
      },
      "default": "{}"
    },
    "slots": {
      "type": {
        "name": "shape",
        "description": "{ action?: elementType, checkbox?: elementType, input?: elementType, label?: elementType, root?: elementType }"
      },
      "default": "{}",
      "additionalInfo": { "slotsApi": true }
    },
    "sx": {
      "type": {
        "name": "union",
        "description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
      },
      "additionalInfo": { "sx": true }
    },
    "uncheckedIcon": { "type": { "name": "node" } },
    "value": {
      "type": {
        "name": "union",
        "description": "Array&lt;string&gt;<br>&#124;&nbsp;number<br>&#124;&nbsp;string"
      }
    },
    "variant": {
      "type": {
        "name": "enum",
        "description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'"
      },
      "default": "'solid'",
      "additionalInfo": { "joy-variant": true }
    }
  },
  "name": "Checkbox",
  "imports": ["import Checkbox from '@mui/joy/Checkbox';", "import { Checkbox } from '@mui/joy';"],
  "slots": [
    {
      "name": "root",
      "description": "The component that renders the root.",
      "default": "'span'",
      "class": "MuiCheckbox-root"
    },
    {
      "name": "checkbox",
      "description": "The component that renders the checkbox.",
      "default": "'span'",
      "class": "MuiCheckbox-checkbox"
    },
    {
      "name": "action",
      "description": "The component that renders the action.",
      "default": "'span'",
      "class": "MuiCheckbox-action"
    },
    {
      "name": "input",
      "description": "The component that renders the input.",
      "default": "'input'",
      "class": "MuiCheckbox-input"
    },
    {
      "name": "label",
      "description": "The component that renders the label.",
      "default": "'label'",
      "class": "MuiCheckbox-label"
    }
  ],
  "classes": [
    {
      "key": "checked",
      "className": "Mui-checked",
      "description": "State class applied to the input component's `checked` class.",
      "isGlobal": true
    },
    {
      "key": "colorContext",
      "className": "MuiCheckbox-colorContext",
      "description": "Class name applied to the root element when color inversion is triggered.",
      "isGlobal": false
    },
    {
      "key": "colorDanger",
      "className": "MuiCheckbox-colorDanger",
      "description": "Class name applied to the root element if `color=\"danger\"`.",
      "isGlobal": false
    },
    {
      "key": "colorNeutral",
      "className": "MuiCheckbox-colorNeutral",
      "description": "Class name applied to the root element if `color=\"neutral\"`.",
      "isGlobal": false
    },
    {
      "key": "colorPrimary",
      "className": "MuiCheckbox-colorPrimary",
      "description": "Class name applied to the root element if `color=\"primary\"`.",
      "isGlobal": false
    },
    {
      "key": "colorSuccess",
      "className": "MuiCheckbox-colorSuccess",
      "description": "Class name applied to the root element if `color=\"success\"`.",
      "isGlobal": false
    },
    {
      "key": "colorWarning",
      "className": "MuiCheckbox-colorWarning",
      "description": "Class name applied to the root element if `color=\"warning\"`.",
      "isGlobal": false
    },
    {
      "key": "disabled",
      "className": "Mui-disabled",
      "description": "State class applied to the input component's disabled class.",
      "isGlobal": true
    },
    {
      "key": "focusVisible",
      "className": "Mui-focusVisible",
      "description": "Class name applied to the root element if the switch has visible focus",
      "isGlobal": true
    },
    {
      "key": "indeterminate",
      "className": "MuiCheckbox-indeterminate",
      "description": "State class applied to the root element if `indeterminate={true}`.",
      "isGlobal": false
    },
    {
      "key": "sizeLg",
      "className": "MuiCheckbox-sizeLg",
      "description": "Class name applied to the root element if `size=\"lg\"`.",
      "isGlobal": false
    },
    {
      "key": "sizeMd",
      "className": "MuiCheckbox-sizeMd",
      "description": "Class name applied to the root element if `size=\"md\"`.",
      "isGlobal": false
    },
    {
      "key": "sizeSm",
      "className": "MuiCheckbox-sizeSm",
      "description": "Class name applied to the root element if `size=\"sm\"`.",
      "isGlobal": false
    },
    {
      "key": "variantOutlined",
      "className": "MuiCheckbox-variantOutlined",
      "description": "Class name applied to the root element if `variant=\"outlined\"`.",
      "isGlobal": false
    },
    {
      "key": "variantSoft",
      "className": "MuiCheckbox-variantSoft",
      "description": "Class name applied to the root element if `variant=\"soft\"`.",
      "isGlobal": false
    },
    {
      "key": "variantSolid",
      "className": "MuiCheckbox-variantSolid",
      "description": "Class name applied to the root element if `variant=\"solid\"`.",
      "isGlobal": false
    }
  ],
  "spread": false,
  "themeDefaultProps": true,
  "muiName": "JoyCheckbox",
  "forwardsRefTo": "HTMLSpanElement",
  "filename": "/packages/mui-joy/src/Checkbox/Checkbox.tsx",
  "inheritance": null,
  "demos": "<ul><li><a href=\"/joy-ui/react-checkbox/\">Checkbox</a></li></ul>",
  "cssComponent": false
}