react-test/docs/translations/api-docs/select/select.json

{
  "componentDescription": "",
  "propDescriptions": {
    "autoWidth": {
      "description": "If <code>true</code>, the width of the popover will automatically be set according to the items inside the menu, otherwise it will be at least the width of the select input."
    },
    "children": {
      "description": "The option elements to populate the select with. Can be some <code>MenuItem</code> when <code>native</code> is false and <code>option</code> when <code>native</code> is true.<br>⚠️The <code>MenuItem</code> elements <strong>must</strong> be direct descendants when <code>native</code> is false."
    },
    "classes": { "description": "Override or extend the styles applied to the component." },
    "defaultOpen": {
      "description": "If <code>true</code>, the component is initially open. Use when the component open state is not controlled (i.e. the <code>open</code> prop is not defined). You can only use it when the <code>native</code> prop is <code>false</code> (default)."
    },
    "defaultValue": {
      "description": "The default value. Use when the component is not controlled."
    },
    "displayEmpty": {
      "description": "If <code>true</code>, a value is displayed even if no items are selected.<br>In order to display a meaningful value, a function can be passed to the <code>renderValue</code> prop which returns the value to be displayed when no items are selected.<br>⚠️ When using this prop, make sure the label doesn&#39;t overlap with the empty displayed value. The label should either be hidden or forced to a shrunk state."
    },
    "IconComponent": { "description": "The icon that displays the arrow." },
    "id": {
      "description": "The <code>id</code> of the wrapper element or the <code>select</code> element when <code>native</code>."
    },
    "input": {
      "description": "An <code>Input</code> element; does not have to be a material-ui specific <code>Input</code>."
    },
    "inputProps": {
      "description": "<a href=\"https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#attributes\">Attributes</a> applied to the <code>input</code> element. When <code>native</code> is <code>true</code>, the attributes are applied on the <code>select</code> element."
    },
    "label": {
      "description": "See <a href=\"https://mui.com/material-ui/api/outlined-input/#props\">OutlinedInput#label</a>"
    },
    "labelId": {
      "description": "The ID of an element that acts as an additional label. The Select will be labelled by the additional label and the selected value."
    },
    "MenuProps": {
      "description": "Props applied to the <a href=\"https://mui.com/material-ui/api/menu/\"><code>Menu</code></a> element."
    },
    "multiple": {
      "description": "If <code>true</code>, <code>value</code> must be an array and the menu will support multiple selections."
    },
    "native": {
      "description": "If <code>true</code>, the component uses a native <code>select</code> element."
    },
    "onChange": {
      "description": "Callback fired when a menu item is selected.",
      "typeDescriptions": {
        "event": {
          "name": "event",
          "description": "The event source of the callback. You can pull out the new value by accessing <code>event.target.value</code> (any). <strong>Warning</strong>: This is a generic event, not a change event, unless the change event is caused by browser autofill."
        },
        "child": {
          "name": "child",
          "description": "The react element that was selected when <code>native</code> is <code>false</code> (default)."
        }
      }
    },
    "onClose": {
      "description": "Callback fired when the component requests to be closed. Use it in either controlled (see the <code>open</code> prop), or uncontrolled mode (to detect when the Select collapses).",
      "typeDescriptions": {
        "event": { "name": "event", "description": "The event source of the callback." }
      }
    },
    "onOpen": {
      "description": "Callback fired when the component requests to be opened. Use it in either controlled (see the <code>open</code> prop), or uncontrolled mode (to detect when the Select expands).",
      "typeDescriptions": {
        "event": { "name": "event", "description": "The event source of the callback." }
      }
    },
    "open": {
      "description": "If <code>true</code>, the component is shown. You can only use it when the <code>native</code> prop is <code>false</code> (default)."
    },
    "renderValue": {
      "description": "Render the selected value. You can only use it when the <code>native</code> prop is <code>false</code> (default).",
      "typeDescriptions": {
        "value": {
          "name": "value",
          "description": "The <code>value</code> provided to the component."
        }
      }
    },
    "SelectDisplayProps": { "description": "Props applied to the clickable div element." },
    "sx": {
      "description": "The system prop that allows defining system overrides as well as additional CSS styles."
    },
    "value": {
      "description": "The <code>input</code> value. Providing an empty string will select no options. Set to an empty string <code>&#39;&#39;</code> if you don&#39;t want any of the available options to be selected.<br>If the value is an object it must have reference equality with the option in order to be selected. If the value is not an object, the string representation must match with the string representation of the option in order to be selected."
    },
    "variant": { "description": "The variant to use." }
  },
  "classDescriptions": {
    "disabled": {
      "description": "State class applied to {{nodeName}}.",
      "nodeName": "the select component <code>disabled</code> class"
    },
    "error": {
      "description": "State class applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the root element",
      "conditions": "<code>error={true}</code>"
    },
    "filled": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the select component",
      "conditions": "<code>variant=\"filled\"</code>"
    },
    "focused": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the select component",
      "conditions": "it is focused"
    },
    "icon": { "description": "Styles applied to {{nodeName}}.", "nodeName": "the icon component" },
    "iconFilled": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the icon component",
      "conditions": "<code>variant=\"filled\"</code>",
      "deprecationInfo": "Combine the <a href=\"/material-ui/api/select/#select-classes-MuiSelect-icon\">.MuiSelect-icon</a> and <a href=\"/material-ui/api/select/#select-classes-MuiSelect-filled\">.MuiSelect-filled</a> classes instead. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
    },
    "iconOpen": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the icon component",
      "conditions": "the popup is open"
    },
    "iconOutlined": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the icon component",
      "conditions": "<code>variant=\"outlined\"</code>",
      "deprecationInfo": "Combine the <a href=\"/material-ui/api/select/#select-classes-MuiSelect-icon\">.MuiSelect-icon</a> and <a href=\"/material-ui/api/select/#select-classes-MuiSelect-outlined\">.MuiSelect-outlined</a> classes instead. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
    },
    "iconStandard": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the icon component",
      "conditions": "<code>variant=\"standard\"</code>",
      "deprecationInfo": "Combine the <a href=\"/material-ui/api/select/#select-classes-MuiSelect-icon\">.MuiSelect-icon</a> and <a href=\"/material-ui/api/select/#select-classes-MuiSelect-standard\">.MuiSelect-standard</a> classes instead. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
    },
    "multiple": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the select component",
      "conditions": "<code>multiple={true}</code>"
    },
    "nativeInput": {
      "description": "Styles applied to {{nodeName}}.",
      "nodeName": "the underlying native input component"
    },
    "outlined": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the select component",
      "conditions": "<code>variant=\"outlined\"</code>"
    },
    "root": { "description": "Styles applied to the root element." },
    "select": {
      "description": "Styles applied to {{nodeName}}.",
      "nodeName": "the select component <code>select</code> class"
    },
    "standard": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the select component",
      "conditions": "<code>variant=\"standard\"</code>"
    }
  }
}