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

{
  "props": {
    "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 }
    },
    "endDecorator": { "type": { "name": "node" } },
    "error": { "type": { "name": "bool" }, "default": "false" },
    "fullWidth": { "type": { "name": "bool" }, "default": "false" },
    "size": {
      "type": {
        "name": "union",
        "description": "'sm'<br>&#124;&nbsp;'md'<br>&#124;&nbsp;'lg'<br>&#124;&nbsp;string"
      },
      "default": "'md'",
      "additionalInfo": { "joy-size": true }
    },
    "startDecorator": { "type": { "name": "node" } },
    "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 }
    },
    "variant": {
      "type": {
        "name": "union",
        "description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'<br>&#124;&nbsp;string"
      },
      "default": "'outlined'",
      "additionalInfo": { "joy-variant": true }
    }
  },
  "name": "Input",
  "imports": ["import Input from '@mui/joy/Input';", "import { Input } from '@mui/joy';"],
  "slots": [
    {
      "name": "root",
      "description": "The component that renders the root.",
      "default": "'div'",
      "class": "MuiInput-root"
    },
    {
      "name": "input",
      "description": "The component that renders the input.",
      "default": "'input'",
      "class": "MuiInput-input"
    },
    {
      "name": "startDecorator",
      "description": "The component that renders the start decorator.",
      "default": "'div'",
      "class": "MuiInput-startDecorator"
    },
    {
      "name": "endDecorator",
      "description": "The component that renders the end decorator.",
      "default": "'div'",
      "class": "MuiInput-endDecorator"
    }
  ],
  "classes": [
    {
      "key": "colorContext",
      "className": "MuiInput-colorContext",
      "description": "Class name applied to the root element when color inversion is triggered.",
      "isGlobal": false
    },
    {
      "key": "colorDanger",
      "className": "MuiInput-colorDanger",
      "description": "Class name applied to the root element if `color=\"danger\"`.",
      "isGlobal": false
    },
    {
      "key": "colorNeutral",
      "className": "MuiInput-colorNeutral",
      "description": "Class name applied to the root element if `color=\"neutral\"`.",
      "isGlobal": false
    },
    {
      "key": "colorPrimary",
      "className": "MuiInput-colorPrimary",
      "description": "Class name applied to the root element if `color=\"primary\"`.",
      "isGlobal": false
    },
    {
      "key": "colorSuccess",
      "className": "MuiInput-colorSuccess",
      "description": "Class name applied to the root element if `color=\"success\"`.",
      "isGlobal": false
    },
    {
      "key": "colorWarning",
      "className": "MuiInput-colorWarning",
      "description": "Class name applied to the root element if `color=\"warning\"`.",
      "isGlobal": false
    },
    {
      "key": "disabled",
      "className": "Mui-disabled",
      "description": "Class name 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": "focused",
      "className": "Mui-focused",
      "description": "Class name applied to the root element if the component is focused.",
      "isGlobal": true
    },
    {
      "key": "formControl",
      "className": "MuiInput-formControl",
      "description": "Class name applied to the root element if the component is a descendant of `FormControl`.",
      "isGlobal": false
    },
    {
      "key": "fullWidth",
      "className": "MuiInput-fullWidth",
      "description": "Class name applied to the root element if `fullWidth={true}`.",
      "isGlobal": false
    },
    {
      "key": "sizeLg",
      "className": "MuiInput-sizeLg",
      "description": "Class name applied to the root element if `size=\"lg\"`.",
      "isGlobal": false
    },
    {
      "key": "sizeMd",
      "className": "MuiInput-sizeMd",
      "description": "Class name applied to the root element if `size=\"md\"`.",
      "isGlobal": false
    },
    {
      "key": "sizeSm",
      "className": "MuiInput-sizeSm",
      "description": "Class name applied to the root element if `size=\"sm\"`.",
      "isGlobal": false
    },
    {
      "key": "variantOutlined",
      "className": "MuiInput-variantOutlined",
      "description": "Class name applied to the root element if `variant=\"outlined\"`.",
      "isGlobal": false
    },
    {
      "key": "variantPlain",
      "className": "MuiInput-variantPlain",
      "description": "Class name applied to the root element if `variant=\"plain\"`.",
      "isGlobal": false
    },
    {
      "key": "variantSoft",
      "className": "MuiInput-variantSoft",
      "description": "Class name applied to the root element if `variant=\"soft\"`.",
      "isGlobal": false
    },
    {
      "key": "variantSolid",
      "className": "MuiInput-variantSolid",
      "description": "Class name applied to the root element if `variant=\"solid\"`.",
      "isGlobal": false
    }
  ],
  "spread": false,
  "themeDefaultProps": true,
  "muiName": "JoyInput",
  "forwardsRefTo": "HTMLDivElement",
  "filename": "/packages/mui-joy/src/Input/Input.tsx",
  "inheritance": null,
  "demos": "<ul><li><a href=\"/joy-ui/react-input/\">Input</a></li></ul>",
  "cssComponent": false
}