react-test/docs/pages/material-ui/api/form-control-label.json

{
  "props": {
    "control": { "type": { "name": "element" }, "required": true },
    "checked": { "type": { "name": "bool" } },
    "classes": { "type": { "name": "object" }, "additionalInfo": { "cssApi": true } },
    "componentsProps": {
      "type": { "name": "shape", "description": "{ typography?: object }" },
      "default": "{}",
      "deprecated": true,
      "deprecationInfo": "use the <code>slotProps</code> prop instead. This prop will be removed in a future major release. See <a href=\"https://mui.com/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
    },
    "disabled": { "type": { "name": "bool" } },
    "disableTypography": { "type": { "name": "bool" } },
    "inputRef": { "type": { "name": "custom", "description": "ref" } },
    "label": { "type": { "name": "node" } },
    "labelPlacement": {
      "type": {
        "name": "enum",
        "description": "'bottom'<br>&#124;&nbsp;'end'<br>&#124;&nbsp;'start'<br>&#124;&nbsp;'top'"
      },
      "default": "'end'"
    },
    "onChange": {
      "type": { "name": "func" },
      "signature": {
        "type": "function(event: React.SyntheticEvent) => void",
        "describedArgs": ["event"]
      }
    },
    "required": { "type": { "name": "bool" } },
    "slotProps": {
      "type": { "name": "shape", "description": "{ typography?: func<br>&#124;&nbsp;object }" },
      "default": "{}"
    },
    "slots": {
      "type": { "name": "shape", "description": "{ typography?: elementType }" },
      "default": "{}"
    },
    "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 }
    },
    "value": { "type": { "name": "any" } }
  },
  "name": "FormControlLabel",
  "imports": [
    "import FormControlLabel from '@mui/material/FormControlLabel';",
    "import { FormControlLabel } from '@mui/material';"
  ],
  "slots": [
    {
      "name": "typography",
      "description": "The component that renders the label.\nThis is unused if `disableTypography` is true.",
      "default": "Typography",
      "class": null
    }
  ],
  "classes": [
    {
      "key": "asterisk",
      "className": "MuiFormControlLabel-asterisk",
      "description": "Styles applied to the asterisk element.",
      "isGlobal": false
    },
    {
      "key": "disabled",
      "className": "Mui-disabled",
      "description": "State class applied to the root element if `disabled={true}`.",
      "isGlobal": true
    },
    {
      "key": "error",
      "className": "Mui-error",
      "description": "State class applied to the root element if `error={true}`.",
      "isGlobal": true
    },
    {
      "key": "label",
      "className": "MuiFormControlLabel-label",
      "description": "Styles applied to the label's Typography component.",
      "isGlobal": false
    },
    {
      "key": "labelPlacementBottom",
      "className": "MuiFormControlLabel-labelPlacementBottom",
      "description": "Styles applied to the root element if `labelPlacement=\"bottom\"`.",
      "isGlobal": false
    },
    {
      "key": "labelPlacementStart",
      "className": "MuiFormControlLabel-labelPlacementStart",
      "description": "Styles applied to the root element if `labelPlacement=\"start\"`.",
      "isGlobal": false
    },
    {
      "key": "labelPlacementTop",
      "className": "MuiFormControlLabel-labelPlacementTop",
      "description": "Styles applied to the root element if `labelPlacement=\"top\"`.",
      "isGlobal": false
    },
    {
      "key": "required",
      "className": "Mui-required",
      "description": "State class applied to the root element if `required={true}`.",
      "isGlobal": true
    },
    {
      "key": "root",
      "className": "MuiFormControlLabel-root",
      "description": "Styles applied to the root element.",
      "isGlobal": false
    }
  ],
  "spread": true,
  "themeDefaultProps": true,
  "muiName": "MuiFormControlLabel",
  "forwardsRefTo": "HTMLLabelElement",
  "filename": "/packages/mui-material/src/FormControlLabel/FormControlLabel.js",
  "inheritance": null,
  "demos": "<ul><li><a href=\"/material-ui/react-checkbox/\">Checkbox</a></li>\n<li><a href=\"/material-ui/react-radio-button/\">Radio Group</a></li>\n<li><a href=\"/material-ui/react-switch/\">Switch</a></li></ul>",
  "cssComponent": false
}