163 lines
6.9 KiB
JSON
163 lines
6.9 KiB
JSON
|
|
{
|
||
|
|
"componentDescription": "",
|
||
|
|
"propDescriptions": {
|
||
|
|
"action": {
|
||
|
|
"description": "A ref for imperative actions. It currently only supports <code>focusVisible()</code> action."
|
||
|
|
},
|
||
|
|
"autoFocus": {
|
||
|
|
"description": "If <code>true</code>, the select element is focused during the first mount"
|
||
|
|
},
|
||
|
|
"color": {
|
||
|
|
"description": "The color of the component. It supports those theme colors that make sense for this component."
|
||
|
|
},
|
||
|
|
"component": {
|
||
|
|
"description": "The component used for the root node. Either a string to use a HTML element or a component."
|
||
|
|
},
|
||
|
|
"defaultListboxOpen": {
|
||
|
|
"description": "If <code>true</code>, the select will be initially open."
|
||
|
|
},
|
||
|
|
"defaultValue": {
|
||
|
|
"description": "The default selected value. Use when the component is not controlled."
|
||
|
|
},
|
||
|
|
"disabled": { "description": "If <code>true</code>, the component is disabled." },
|
||
|
|
"endDecorator": { "description": "Trailing adornment for the select." },
|
||
|
|
"getSerializedValue": {
|
||
|
|
"description": "A function to convert the currently selected value to a string. Used to set a value of a hidden input associated with the select, so that the selected value can be posted with a form."
|
||
|
|
},
|
||
|
|
"indicator": {
|
||
|
|
"description": "The indicator(*) for the select. ________________ [ value * ] ‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾"
|
||
|
|
},
|
||
|
|
"listboxId": {
|
||
|
|
"description": "<code>id</code> attribute of the listbox element. Also used to derive the <code>id</code> attributes of options."
|
||
|
|
},
|
||
|
|
"listboxOpen": { "description": "Controls the open state of the select's listbox." },
|
||
|
|
"multiple": {
|
||
|
|
"description": "If <code>true</code>, selecting multiple values is allowed. This affects the type of the <code>value</code>, <code>defaultValue</code>, and <code>onChange</code> props."
|
||
|
|
},
|
||
|
|
"name": {
|
||
|
|
"description": "Name of the element. For example used by the server to identify the fields in form submits."
|
||
|
|
},
|
||
|
|
"onChange": { "description": "Callback fired when an option is selected." },
|
||
|
|
"onClose": { "description": "Triggered when focus leaves the menu and the menu should close." },
|
||
|
|
"onListboxOpenChange": {
|
||
|
|
"description": "Callback fired when the component requests to be opened. Use in controlled mode (see listboxOpen)."
|
||
|
|
},
|
||
|
|
"placeholder": { "description": "Text to show when there is no selected value." },
|
||
|
|
"renderValue": {
|
||
|
|
"description": "Function that customizes the rendering of the selected value."
|
||
|
|
},
|
||
|
|
"required": {
|
||
|
|
"description": "If <code>true</code>, the Select cannot be empty when submitting form."
|
||
|
|
},
|
||
|
|
"size": { "description": "The size of the component." },
|
||
|
|
"slots": { "description": "The components used for each slot inside." },
|
||
|
|
"startDecorator": { "description": "Leading adornment for the select." },
|
||
|
|
"sx": {
|
||
|
|
"description": "The system prop that allows defining system overrides as well as additional CSS styles."
|
||
|
|
},
|
||
|
|
"value": {
|
||
|
|
"description": "The selected value. Set to <code>null</code> to deselect all options."
|
||
|
|
},
|
||
|
|
"variant": {
|
||
|
|
"description": "The <a href=\"https://mui.com/joy-ui/main-features/global-variants/\">global variant</a> to use."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"classDescriptions": {
|
||
|
|
"colorContext": {
|
||
|
|
"description": "Class name applied to {{nodeName}} when {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "color inversion is triggered"
|
||
|
|
},
|
||
|
|
"colorDanger": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root slot",
|
||
|
|
"conditions": "<code>color=\"danger\"</code>"
|
||
|
|
},
|
||
|
|
"colorNeutral": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root slot",
|
||
|
|
"conditions": "<code>color=\"neutral\"</code>"
|
||
|
|
},
|
||
|
|
"colorPrimary": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root slot",
|
||
|
|
"conditions": "<code>color=\"primary\"</code>"
|
||
|
|
},
|
||
|
|
"colorSuccess": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root slot",
|
||
|
|
"conditions": "<code>color=\"success\"</code>"
|
||
|
|
},
|
||
|
|
"colorWarning": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root slot",
|
||
|
|
"conditions": "<code>color=\"warning\"</code>"
|
||
|
|
},
|
||
|
|
"disabled": {
|
||
|
|
"description": "State class applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root slot",
|
||
|
|
"conditions": "<code>disabled={true}</code>"
|
||
|
|
},
|
||
|
|
"expanded": {
|
||
|
|
"description": "State class applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root slot",
|
||
|
|
"conditions": "listbox open"
|
||
|
|
},
|
||
|
|
"focusVisible": {
|
||
|
|
"description": "State class applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the SelectBase root slot",
|
||
|
|
"conditions": "the button is keyboard focused"
|
||
|
|
},
|
||
|
|
"multiple": {
|
||
|
|
"description": "Class name applied to the root slot if <code>multiple=true</code>"
|
||
|
|
},
|
||
|
|
"popper": {
|
||
|
|
"description": "Class name applied to {{nodeName}}.",
|
||
|
|
"nodeName": "the popper slot"
|
||
|
|
},
|
||
|
|
"sizeLg": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root slot",
|
||
|
|
"conditions": "<code>size=\"lg\"</code>"
|
||
|
|
},
|
||
|
|
"sizeMd": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root slot",
|
||
|
|
"conditions": "<code>size=\"md\"</code>"
|
||
|
|
},
|
||
|
|
"sizeSm": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root slot",
|
||
|
|
"conditions": "<code>size=\"sm\"</code>"
|
||
|
|
},
|
||
|
|
"variantOutlined": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root slot",
|
||
|
|
"conditions": "<code>variant=\"outlined\"</code>"
|
||
|
|
},
|
||
|
|
"variantPlain": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root slot",
|
||
|
|
"conditions": "<code>variant=\"plain\"</code>"
|
||
|
|
},
|
||
|
|
"variantSoft": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root slot",
|
||
|
|
"conditions": "<code>variant=\"soft\"</code>"
|
||
|
|
},
|
||
|
|
"variantSolid": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root slot",
|
||
|
|
"conditions": "<code>variant=\"solid\"</code>"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"slotDescriptions": {
|
||
|
|
"button": "The component that renders the button.",
|
||
|
|
"endDecorator": "The component that renders the end decorator.",
|
||
|
|
"indicator": "The component that renders the indicator.",
|
||
|
|
"listbox": "The component that renders the listbox.",
|
||
|
|
"root": "The component that renders the root.",
|
||
|
|
"startDecorator": "The component that renders the start decorator."
|
||
|
|
}
|
||
|
|
}
|