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

{
  "props": {
    "action": {
      "type": {
        "name": "union",
        "description": "func<br>&#124;&nbsp;{ current?: { focusVisible: func } }"
      }
    },
    "autoFocus": { "type": { "name": "bool" }, "default": "false" },
    "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" } },
    "defaultListboxOpen": { "type": { "name": "bool" }, "default": "false" },
    "defaultValue": { "type": { "name": "any" } },
    "disabled": { "type": { "name": "bool" }, "default": "false" },
    "endDecorator": { "type": { "name": "node" } },
    "getSerializedValue": { "type": { "name": "func" } },
    "indicator": { "type": { "name": "node" } },
    "listboxId": { "type": { "name": "string" } },
    "listboxOpen": { "type": { "name": "bool" }, "default": "undefined" },
    "multiple": { "type": { "name": "bool" } },
    "name": { "type": { "name": "string" } },
    "onChange": { "type": { "name": "func" } },
    "onClose": { "type": { "name": "func" } },
    "onListboxOpenChange": { "type": { "name": "func" } },
    "placeholder": { "type": { "name": "node" } },
    "renderValue": { "type": { "name": "func" } },
    "required": { "type": { "name": "bool" }, "default": "false" },
    "size": {
      "type": {
        "name": "union",
        "description": "'sm'<br>&#124;&nbsp;'md'<br>&#124;&nbsp;'lg'<br>&#124;&nbsp;string"
      },
      "additionalInfo": { "joy-size": true }
    },
    "slots": {
      "type": {
        "name": "shape",
        "description": "{ button?: elementType, endDecorator?: elementType, indicator?: elementType, listbox?: elementType, root?: elementType, startDecorator?: elementType }"
      },
      "default": "{}",
      "additionalInfo": { "slotsApi": 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 }
    },
    "value": { "type": { "name": "any" } },
    "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": "Select",
  "imports": ["import Select from '@mui/joy/Select';", "import { Select } from '@mui/joy';"],
  "slots": [
    {
      "name": "root",
      "description": "The component that renders the root.",
      "default": "'div'",
      "class": "MuiSelect-root"
    },
    {
      "name": "button",
      "description": "The component that renders the button.",
      "default": "'button'",
      "class": "MuiSelect-button"
    },
    {
      "name": "startDecorator",
      "description": "The component that renders the start decorator.",
      "default": "'span'",
      "class": "MuiSelect-startDecorator"
    },
    {
      "name": "endDecorator",
      "description": "The component that renders the end decorator.",
      "default": "'span'",
      "class": "MuiSelect-endDecorator"
    },
    {
      "name": "indicator",
      "description": "The component that renders the indicator.",
      "default": "'span'",
      "class": "MuiSelect-indicator"
    },
    {
      "name": "listbox",
      "description": "The component that renders the listbox.",
      "default": "'ul'",
      "class": "MuiSelect-listbox"
    }
  ],
  "classes": [
    {
      "key": "colorContext",
      "className": "MuiSelect-colorContext",
      "description": "Class name applied to the root element when color inversion is triggered.",
      "isGlobal": false
    },
    {
      "key": "colorDanger",
      "className": "MuiSelect-colorDanger",
      "description": "Class name applied to the root slot if `color=\"danger\"`.",
      "isGlobal": false
    },
    {
      "key": "colorNeutral",
      "className": "MuiSelect-colorNeutral",
      "description": "Class name applied to the root slot if `color=\"neutral\"`.",
      "isGlobal": false
    },
    {
      "key": "colorPrimary",
      "className": "MuiSelect-colorPrimary",
      "description": "Class name applied to the root slot if `color=\"primary\"`.",
      "isGlobal": false
    },
    {
      "key": "colorSuccess",
      "className": "MuiSelect-colorSuccess",
      "description": "Class name applied to the root slot if `color=\"success\"`.",
      "isGlobal": false
    },
    {
      "key": "colorWarning",
      "className": "MuiSelect-colorWarning",
      "description": "Class name applied to the root slot if `color=\"warning\"`.",
      "isGlobal": false
    },
    {
      "key": "disabled",
      "className": "Mui-disabled",
      "description": "State class applied to the root slot if `disabled={true}`.",
      "isGlobal": true
    },
    {
      "key": "expanded",
      "className": "Mui-expanded",
      "description": "State class applied to the root slot if listbox open.",
      "isGlobal": true
    },
    {
      "key": "focusVisible",
      "className": "Mui-focusVisible",
      "description": "State class applied to the SelectBase root slot if the button is keyboard focused.",
      "isGlobal": true
    },
    {
      "key": "multiple",
      "className": "MuiSelect-multiple",
      "description": "Class name applied to the root slot if `multiple=true`",
      "isGlobal": false
    },
    {
      "key": "popper",
      "className": "MuiSelect-popper",
      "description": "Class name applied to the popper slot.",
      "isGlobal": false
    },
    {
      "key": "sizeLg",
      "className": "MuiSelect-sizeLg",
      "description": "Class name applied to the root slot if `size=\"lg\"`.",
      "isGlobal": false
    },
    {
      "key": "sizeMd",
      "className": "MuiSelect-sizeMd",
      "description": "Class name applied to the root slot if `size=\"md\"`.",
      "isGlobal": false
    },
    {
      "key": "sizeSm",
      "className": "MuiSelect-sizeSm",
      "description": "Class name applied to the root slot if `size=\"sm\"`.",
      "isGlobal": false
    },
    {
      "key": "variantOutlined",
      "className": "MuiSelect-variantOutlined",
      "description": "Class name applied to the root slot if `variant=\"outlined\"`.",
      "isGlobal": false
    },
    {
      "key": "variantPlain",
      "className": "MuiSelect-variantPlain",
      "description": "Class name applied to the root slot if `variant=\"plain\"`.",
      "isGlobal": false
    },
    {
      "key": "variantSoft",
      "className": "MuiSelect-variantSoft",
      "description": "Class name applied to the root slot if `variant=\"soft\"`.",
      "isGlobal": false
    },
    {
      "key": "variantSolid",
      "className": "MuiSelect-variantSolid",
      "description": "Class name applied to the root slot if `variant=\"solid\"`.",
      "isGlobal": false
    }
  ],
  "spread": false,
  "themeDefaultProps": true,
  "muiName": "JoySelect",
  "forwardsRefTo": "HTMLDivElement",
  "filename": "/packages/mui-joy/src/Select/Select.tsx",
  "inheritance": null,
  "demos": "<ul><li><a href=\"/joy-ui/react-select/\">Select</a></li></ul>",
  "cssComponent": false
}