UNPKG

common-intellisense

Version:
898 lines (897 loc) 688 kB
[ { "name": "Accordion", "props": { "children": { "description": "The content of the component.", "description_zh": "The content of the component.", "default": "-", "value": "", "type": "node", "required": true }, "classes": { "description": "Override or extend the styles applied to the component.See CSS classes API below for more details.", "description_zh": "Override or extend the styles applied to the component.See CSS classes API below for more details.", "default": "-", "value": "", "type": "object", "required": false }, "defaultExpanded": { "description": "If true, expands the accordion by default.", "description_zh": "If true, expands the accordion by default.", "default": "false", "value": "", "type": "bool", "required": false }, "disabled": { "description": "If true, the component is disabled.", "description_zh": "If true, the component is disabled.", "default": "false", "value": "", "type": "bool", "required": false }, "disableGutters": { "description": "If true, it removes the margin between two expanded accordion items and the increase of height.", "description_zh": "If true, it removes the margin between two expanded accordion items and the increase of height.", "default": "false", "value": "", "type": "bool", "required": false }, "expanded": { "description": "If true, expands the accordion, otherwise collapse it. Setting this prop enables control over the accordion.", "description_zh": "If true, expands the accordion, otherwise collapse it. Setting this prop enables control over the accordion.", "default": "-", "value": "", "type": "bool", "required": false }, "onChange": { "description": "Callback fired when the expand/collapse state is changed.Signature:function(event: React.SyntheticEvent, expanded: boolean) => voidevent The event source of the callback. Warning: This is a generic event not a change event.expanded The expanded state of the accordion.", "description_zh": "Callback fired when the expand/collapse state is changed.Signature:function(event: React.SyntheticEvent, expanded: boolean) => voidevent The event source of the callback. Warning: This is a generic event not a change event.expanded The expanded state of the accordion.", "default": "-", "value": "", "type": "func", "required": false }, "slotProps": { "description": "The props used for each slot inside.", "description_zh": "The props used for each slot inside.", "default": "{}", "value": "", "type": "{ transition?: func| object }", "required": false }, "slots": { "description": "The components used for each slot inside.", "description_zh": "The components used for each slot inside.", "default": "{}", "value": "", "type": "{ transition?: elementType }", "required": false }, "square": { "description": "If true, rounded corners are disabled.", "description_zh": "If true, rounded corners are disabled.", "default": "false", "value": "", "type": "bool", "required": false }, "sx": { "description": "The system prop that allows defining system overrides as well as additional CSS styles.See the `sx` page for more details.", "description_zh": "The system prop that allows defining system overrides as well as additional CSS styles.See the `sx` page for more details.", "default": "-", "value": "", "type": "Array<func| object| bool>| func| object", "required": false }, "TransitionComponent": { "description": "The component used for the transition. Follow this guide to learn more about the requirements for this component.Deprecated - Use slots.transition instead. This prop will be removed in v7. How to migrate.", "description_zh": "The component used for the transition. Follow this guide to learn more about the requirements for this component.Deprecated - Use slots.transition instead. This prop will be removed in v7. How to migrate.", "default": "-", "value": "", "type": "elementType", "required": false }, "TransitionProps": { "description": "Props applied to the transition element. By default, the element is based on this Transition component.Deprecated - Use slotProps.transition instead. This prop will be removed in v7. How to migrate.", "description_zh": "Props applied to the transition element. By default, the element is based on this Transition component.Deprecated - Use slotProps.transition instead. This prop will be removed in v7. How to migrate.", "default": "-", "value": "", "type": "object", "required": false } }, "link": "https://mui.com/material-ui/api/accordion/", "link_zh": "https://mui.com/material-ui/api/accordion/", "typeDetail": {}, "events": [ { "name": "onChange", "description": "Callback fired when the expand/collapse state is changed.Signature:event The event source of the callback. Warning: This is a generic event not a change event.expanded The expanded state of the accordion.", "description_zh": "Callback fired when the expand/collapse state is changed.Signature:event The event source of the callback. Warning: This is a generic event not a change event.expanded The expanded state of the accordion.", "params": "function(event: React.SyntheticEvent, expanded: boolean) => void" } ], "methods": [], "slots": [], "suggestions": [], "filename": "Accordion" }, { "name": "AccordionActions", "props": { "children": { "description": "The content of the component.", "description_zh": "The content of the component.", "default": "-", "value": "", "type": "node", "required": false }, "classes": { "description": "Override or extend the styles applied to the component.See CSS classes API below for more details.", "description_zh": "Override or extend the styles applied to the component.See CSS classes API below for more details.", "default": "-", "value": "", "type": "object", "required": false }, "disableSpacing": { "description": "If true, the actions do not have additional margin.", "description_zh": "If true, the actions do not have additional margin.", "default": "false", "value": "", "type": "bool", "required": false }, "sx": { "description": "The system prop that allows defining system overrides as well as additional CSS styles.See the `sx` page for more details.", "description_zh": "The system prop that allows defining system overrides as well as additional CSS styles.See the `sx` page for more details.", "default": "-", "value": "", "type": "Array<func| object| bool>| func| object", "required": false } }, "link": "https://mui.com/material-ui/api/accordion-actions/", "link_zh": "https://mui.com/material-ui/api/accordion-actions/", "typeDetail": {}, "events": [], "methods": [], "slots": [], "suggestions": [], "filename": "AccordionActions" }, { "name": "AccordionDetails", "props": { "children": { "description": "The content of the component.", "description_zh": "The content of the component.", "default": "", "value": "", "type": "node", "required": false }, "classes": { "description": "Override or extend the styles applied to the component.See CSS classes API below for more details.", "description_zh": "Override or extend the styles applied to the component.See CSS classes API below for more details.", "default": "", "value": "", "type": "object", "required": false }, "sx": { "description": "The system prop that allows defining system overrides as well as additional CSS styles.See the `sx` page for more details.", "description_zh": "The system prop that allows defining system overrides as well as additional CSS styles.See the `sx` page for more details.", "default": "", "value": "", "type": "Array<func| object| bool>| func| object", "required": false } }, "link": "https://mui.com/material-ui/api/accordion-details/", "link_zh": "https://mui.com/material-ui/api/accordion-details/", "typeDetail": {}, "events": [], "methods": [], "slots": [], "suggestions": [], "filename": "AccordionDetails" }, { "name": "AccordionSummary", "props": { "children": { "description": "The content of the component.", "description_zh": "The content of the component.", "default": "", "value": "", "type": "node", "required": false }, "classes": { "description": "Override or extend the styles applied to the component.See CSS classes API below for more details.", "description_zh": "Override or extend the styles applied to the component.See CSS classes API below for more details.", "default": "", "value": "", "type": "object", "required": false }, "expandIcon": { "description": "The icon to display as the expand indicator.", "description_zh": "The icon to display as the expand indicator.", "default": "", "value": "", "type": "node", "required": false }, "focusVisibleClassName": { "description": "This prop can help identify which element has keyboard focus. The class name will be applied when the element gains the focus through keyboard interaction. It's a polyfill for the CSS :focus-visible selector. The rationale for using this feature is explained here. A polyfill can be used to apply a focus-visible class to other components if needed.", "description_zh": "This prop can help identify which element has keyboard focus. The class name will be applied when the element gains the focus through keyboard interaction. It's a polyfill for the CSS :focus-visible selector. The rationale for using this feature is explained here. A polyfill can be used to apply a focus-visible class to other components if needed.", "default": "", "value": "", "type": "string", "required": false }, "sx": { "description": "The system prop that allows defining system overrides as well as additional CSS styles.See the `sx` page for more details.", "description_zh": "The system prop that allows defining system overrides as well as additional CSS styles.See the `sx` page for more details.", "default": "", "value": "", "type": "Array<func| object| bool>| func| object", "required": false } }, "link": "https://mui.com/material-ui/api/accordion-summary/", "link_zh": "https://mui.com/material-ui/api/accordion-summary/", "typeDetail": {}, "events": [], "methods": [], "slots": [], "suggestions": [], "filename": "AccordionSummary" }, { "name": "Alert", "props": { "action": { "description": "The action to display. It renders after the message, at the end of the alert.", "description_zh": "The action to display. It renders after the message, at the end of the alert.", "default": "-", "value": "", "type": "node", "required": false }, "children": { "description": "The content of the component.", "description_zh": "The content of the component.", "default": "-", "value": "", "type": "node", "required": false }, "classes": { "description": "Override or extend the styles applied to the component.See CSS classes API below for more details.", "description_zh": "Override or extend the styles applied to the component.See CSS classes API below for more details.", "default": "-", "value": "", "type": "object", "required": false }, "closeText": { "description": "Override the default label for the close popup icon button.For localization purposes, you can use the provided translations.", "description_zh": "Override the default label for the close popup icon button.For localization purposes, you can use the provided translations.", "default": "'Close'", "value": "", "type": "string", "required": false }, "color": { "description": "The color of the component. Unless provided, the value is taken from the severity prop. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", "description_zh": "The color of the component. Unless provided, the value is taken from the severity prop. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", "default": "-", "value": "", "type": "error| info| success| warning| string", "required": false }, "components": { "description": "The components used for each slot inside.Deprecated - use the slots prop instead. This prop will be removed in v7. How to migrate.", "description_zh": "The components used for each slot inside.Deprecated - use the slots prop instead. This prop will be removed in v7. How to migrate.", "default": "{}", "value": "", "type": "{ CloseButton?: elementType, CloseIcon?: elementType }", "required": false }, "componentsProps": { "description": "The extra props for the slot components. You can override the existing props or add new ones.Deprecated - use the slotProps prop instead. This prop will be removed in v7. How to migrate.", "description_zh": "The extra props for the slot components. You can override the existing props or add new ones.Deprecated - use the slotProps prop instead. This prop will be removed in v7. How to migrate.", "default": "{}", "value": "", "type": "{ closeButton?: object, closeIcon?: object }", "required": false }, "icon": { "description": "Override the icon displayed before the children. Unless provided, the icon is mapped to the value of the severity prop. Set to false to remove the icon.", "description_zh": "Override the icon displayed before the children. Unless provided, the icon is mapped to the value of the severity prop. Set to false to remove the icon.", "default": "-", "value": "", "type": "node", "required": false }, "iconMapping": { "description": "The component maps the severity prop to a range of different icons, for instance success to <SuccessOutlined>. If you wish to change this mapping, you can provide your own. Alternatively, you can use the icon prop to override the icon displayed.", "description_zh": "The component maps the severity prop to a range of different icons, for instance success to <SuccessOutlined>. If you wish to change this mapping, you can provide your own. Alternatively, you can use the icon prop to override the icon displayed.", "default": "-", "value": "", "type": "{ error?: node, info?: node, success?: node, warning?: node }", "required": false }, "onClose": { "description": "Callback fired when the component requests to be closed. When provided and no action prop is set, a close icon button is displayed that triggers the callback when clicked.Signature:function(event: React.SyntheticEvent) => voidevent The event source of the callback.", "description_zh": "Callback fired when the component requests to be closed. When provided and no action prop is set, a close icon button is displayed that triggers the callback when clicked.Signature:function(event: React.SyntheticEvent) => voidevent The event source of the callback.", "default": "-", "value": "", "type": "func", "required": false }, "role": { "description": "The ARIA role attribute of the element.", "description_zh": "The ARIA role attribute of the element.", "default": "'alert'", "value": "", "type": "string", "required": false }, "severity": { "description": "The severity of the alert. This defines the color and icon used.", "description_zh": "The severity of the alert. This defines the color and icon used.", "default": "'success'", "value": "", "type": "error| info| success| warning| string", "required": false }, "slotProps": { "description": "The props used for each slot inside.", "description_zh": "The props used for each slot inside.", "default": "{}", "value": "", "type": "{ closeButton?: func| object, closeIcon?: func| object }", "required": false }, "slots": { "description": "The components used for each slot inside.", "description_zh": "The components used for each slot inside.", "default": "{}", "value": "", "type": "{ closeButton?: elementType, closeIcon?: elementType }", "required": false }, "sx": { "description": "The system prop that allows defining system overrides as well as additional CSS styles.See the `sx` page for more details.", "description_zh": "The system prop that allows defining system overrides as well as additional CSS styles.See the `sx` page for more details.", "default": "-", "value": "", "type": "Array<func| object| bool>| func| object", "required": false }, "variant": { "description": "The variant to use.", "description_zh": "The variant to use.", "default": "'standard'", "value": "", "type": "filled| outlined| standard| string", "required": false } }, "link": "https://mui.com/material-ui/api/alert/", "link_zh": "https://mui.com/material-ui/api/alert/", "typeDetail": {}, "events": [ { "name": "onClose", "description": "Callback fired when the component requests to be closed. When provided and no prop is set, a close icon button is displayed that triggers the callback when clicked.Signature:function(event: React.SyntheticEvent) => voidevent The event source of the callback.", "description_zh": "Callback fired when the component requests to be closed. When provided and no prop is set, a close icon button is displayed that triggers the callback when clicked.Signature:function(event: React.SyntheticEvent) => voidevent The event source of the callback.", "params": "action" } ], "methods": [], "slots": [], "suggestions": [], "filename": "Alert" }, { "name": "AlertTitle", "props": { "children": { "description": "The content of the component.", "description_zh": "The content of the component.", "default": "", "value": "", "type": "node", "required": false }, "classes": { "description": "Override or extend the styles applied to the component.See CSS classes API below for more details.", "description_zh": "Override or extend the styles applied to the component.See CSS classes API below for more details.", "default": "", "value": "", "type": "object", "required": false }, "sx": { "description": "The system prop that allows defining system overrides as well as additional CSS styles.See the `sx` page for more details.", "description_zh": "The system prop that allows defining system overrides as well as additional CSS styles.See the `sx` page for more details.", "default": "", "value": "", "type": "Array<func| object| bool>| func| object", "required": false } }, "link": "https://mui.com/material-ui/api/alert-title/", "link_zh": "https://mui.com/material-ui/api/alert-title/", "typeDetail": {}, "events": [], "methods": [], "slots": [], "suggestions": [], "filename": "AlertTitle" }, { "name": "AppBar", "props": { "children": { "description": "The content of the component.", "description_zh": "The content of the component.", "default": "-", "value": "", "type": "node", "required": false }, "classes": { "description": "Override or extend the styles applied to the component.See CSS classes API below for more details.", "description_zh": "Override or extend the styles applied to the component.See CSS classes API below for more details.", "default": "-", "value": "", "type": "object", "required": false }, "color": { "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", "description_zh": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", "default": "'primary'", "value": "", "type": "default| inherit| primary| secondary| transparent| error| info| success| warning| string", "required": false }, "enableColorOnDark": { "description": "If true, the color prop is applied in dark mode.", "description_zh": "If true, the color prop is applied in dark mode.", "default": "false", "value": "", "type": "bool", "required": false }, "position": { "description": "The positioning type. The behavior of the different options is described in the MDN web docs. Note: sticky is not universally supported and will fall back to static when unavailable.", "description_zh": "The positioning type. The behavior of the different options is described in the MDN web docs. Note: sticky is not universally supported and will fall back to static when unavailable.", "default": "'fixed'", "value": "", "type": "absolute| fixed| relative| static| sticky", "required": false }, "sx": { "description": "The system prop that allows defining system overrides as well as additional CSS styles.See the `sx` page for more details.", "description_zh": "The system prop that allows defining system overrides as well as additional CSS styles.See the `sx` page for more details.", "default": "-", "value": "", "type": "Array<func| object| bool>| func| object", "required": false } }, "link": "https://mui.com/material-ui/api/app-bar/", "link_zh": "https://mui.com/material-ui/api/app-bar/", "typeDetail": {}, "events": [], "methods": [], "slots": [], "suggestions": [], "filename": "AppBar" }, { "name": "Autocomplete", "props": { "options": { "description": "Array of options.", "description_zh": "Array of options.", "default": "-", "value": "", "type": "array", "required": true }, "renderInput": { "description": "Render the input.Signature:function(params: object) => ReactNode", "description_zh": "Render the input.Signature:function(params: object) => ReactNode", "default": "-", "value": "", "type": "func", "required": true }, "autoComplete": { "description": "If true, the portion of the selected suggestion that the user hasn't typed, known as the completion string, appears inline after the input cursor in the textbox. The inline completion string is visually highlighted and has a selected state.", "description_zh": "If true, the portion of the selected suggestion that the user hasn't typed, known as the completion string, appears inline after the input cursor in the textbox. The inline completion string is visually highlighted and has a selected state.", "default": "false", "value": "", "type": "bool", "required": false }, "autoHighlight": { "description": "If true, the first option is automatically highlighted.", "description_zh": "If true, the first option is automatically highlighted.", "default": "false", "value": "", "type": "bool", "required": false }, "autoSelect": { "description": "If true, the selected option becomes the value of the input when the Autocomplete loses focus unless the user chooses a different option or changes the character string in the input.When using the freeSolo mode, the typed value will be the input value if the Autocomplete loses focus without highlighting an option.", "description_zh": "If true, the selected option becomes the value of the input when the Autocomplete loses focus unless the user chooses a different option or changes the character string in the input.When using the freeSolo mode, the typed value will be the input value if the Autocomplete loses focus without highlighting an option.", "default": "false", "value": "", "type": "bool", "required": false }, "blurOnSelect": { "description": "Control if the input should be blurred when an option is selected:\n\nfalse the input is not blurred.\ntrue the input is always blurred.\ntouch the input is blurred after a touch event.\nmouse the input is blurred after a mouse event.\n\n", "description_zh": "Control if the input should be blurred when an option is selected:\n\nfalse the input is not blurred.\ntrue the input is always blurred.\ntouch the input is blurred after a touch event.\nmouse the input is blurred after a mouse event.\n\n", "default": "false", "value": "", "type": "mouse| touch| bool", "required": false }, "ChipProps": { "description": "Props applied to the Chip element.", "description_zh": "Props applied to the Chip element.", "default": "-", "value": "", "type": "object", "required": false }, "classes": { "description": "Override or extend the styles applied to the component.See CSS classes API below for more details.", "description_zh": "Override or extend the styles applied to the component.See CSS classes API below for more details.", "default": "-", "value": "", "type": "object", "required": false }, "clearIcon": { "description": "The icon to display in place of the default clear icon.", "description_zh": "The icon to display in place of the default clear icon.", "default": "<ClearIcon fontSize=\"small\" />", "value": "", "type": "node", "required": false }, "clearOnBlur": { "description": "If true, the input's text is cleared on blur if no value is selected.Set it to true if you want to help the user enter a new value. Set it to false if you want to help the user resume their search.", "description_zh": "If true, the input's text is cleared on blur if no value is selected.Set it to true if you want to help the user enter a new value. Set it to false if you want to help the user resume their search.", "default": "!props.freeSolo", "value": "", "type": "bool", "required": false }, "clearOnEscape": { "description": "If true, clear all values when the user presses escape and the popup is closed.", "description_zh": "If true, clear all values when the user presses escape and the popup is closed.", "default": "false", "value": "", "type": "bool", "required": false }, "clearText": { "description": "Override the default text for the clear icon button.For localization purposes, you can use the provided translations.", "description_zh": "Override the default text for the clear icon button.For localization purposes, you can use the provided translations.", "default": "'Clear'", "value": "", "type": "string", "required": false }, "closeText": { "description": "Override the default text for the close popup icon button.For localization purposes, you can use the provided translations.", "description_zh": "Override the default text for the close popup icon button.For localization purposes, you can use the provided translations.", "default": "'Close'", "value": "", "type": "string", "required": false }, "componentsProps": { "description": "The props used for each slot inside.", "description_zh": "The props used for each slot inside.", "default": "{}", "value": "", "type": "{ clearIndicator?: object, paper?: object, popper?: object, popupIndicator?: object }", "required": false }, "defaultValue": { "description": "The default value. Use when the component is not controlled.", "description_zh": "The default value. Use when the component is not controlled.", "default": "props.multiple ? [] : null", "value": "", "type": "any", "required": false }, "disableClearable": { "description": "If true, the input can't be cleared.", "description_zh": "If true, the input can't be cleared.", "default": "false", "value": "", "type": "bool", "required": false }, "disableCloseOnSelect": { "description": "If true, the popup won't close when a value is selected.", "description_zh": "If true, the popup won't close when a value is selected.", "default": "false", "value": "", "type": "bool", "required": false }, "disabled": { "description": "If true, the component is disabled.", "description_zh": "If true, the component is disabled.", "default": "false", "value": "", "type": "bool", "required": false }, "disabledItemsFocusable": { "description": "If true, will allow focus on disabled items.", "description_zh": "If true, will allow focus on disabled items.", "default": "false", "value": "", "type": "bool", "required": false }, "disableListWrap": { "description": "If true, the list box in the popup will not wrap focus.", "description_zh": "If true, the list box in the popup will not wrap focus.", "default": "false", "value": "", "type": "bool", "required": false }, "disablePortal": { "description": "If true, the Popper content will be under the DOM hierarchy of the parent component.", "description_zh": "If true, the Popper content will be under the DOM hierarchy of the parent component.", "default": "false", "value": "", "type": "bool", "required": false }, "filterOptions": { "description": "A function that determines the filtered options to be rendered on search.Signature:function(options: Array, state: object) => Arrayoptions The options to render.state The state of the component.", "description_zh": "A function that determines the filtered options to be rendered on search.Signature:function(options: Array, state: object) => Arrayoptions The options to render.state The state of the component.", "default": "createFilterOptions()", "value": "", "type": "func", "required": false }, "filterSelectedOptions": { "description": "If true, hide the selected options from the list box.", "description_zh": "If true, hide the selected options from the list box.", "default": "false", "value": "", "type": "bool", "required": false }, "forcePopupIcon": { "description": "Force the visibility display of the popup icon.", "description_zh": "Force the visibility display of the popup icon.", "default": "'auto'", "value": "", "type": "auto| bool", "required": false }, "freeSolo": { "description": "If true, the Autocomplete is free solo, meaning that the user input is not bound to provided options.", "description_zh": "If true, the Autocomplete is free solo, meaning that the user input is not bound to provided options.", "default": "false", "value": "", "type": "bool", "required": false }, "fullWidth": { "description": "If true, the input will take up the full width of its container.", "description_zh": "If true, the input will take up the full width of its container.", "default": "false", "value": "", "type": "bool", "required": false }, "getLimitTagsText": { "description": "The label to display when the tags are truncated (limitTags).Signature:function(more: number) => ReactNodemore The number of truncated tags.", "description_zh": "The label to display when the tags are truncated (limitTags).Signature:function(more: number) => ReactNodemore The number of truncated tags.", "default": "(more) => `+${more}`", "value": "", "type": "func", "required": false }, "getOptionDisabled": { "description": "Used to determine the disabled state for a given option.Signature:function(option: Value) => booleanoption The option to test.", "description_zh": "Used to determine the disabled state for a given option.Signature:function(option: Value) => booleanoption The option to test.", "default": "-", "value": "", "type": "func", "required": false }, "getOptionKey": { "description": "Used to determine the key for a given option. This can be useful when the labels of options are not unique (since labels are used as keys by default).Signature:function(option: Value) => string | numberoption The option to get the key for.", "description_zh": "Used to determine the key for a given option. This can be useful when the labels of options are not unique (since labels are used as keys by default).Signature:function(option: Value) => string | numberoption The option to get the key for.", "default": "-", "value": "", "type": "func", "required": false }, "getOptionLabel": { "description": "Used to determine the string value for a given option. It's used to fill the input (and the list box options if renderOption is not provided).If used in free solo mode, it must accept both the type of the options and a string.Signature:function(option: Value) => string", "description_zh": "Used to determine the string value for a given option. It's used to fill the input (and the list box options if renderOption is not provided).If used in free solo mode, it must accept both the type of the options and a string.Signature:function(option: Value) => string", "default": "(option) => option.label ?? option", "value": "", "type": "func", "required": false }, "groupBy": { "description": "If provided, the options will be grouped under the returned string. The groupBy value is also used as the text for group headings when renderGroup is not provided.Signature:function(options: Value) => stringoptions The options to group.", "description_zh": "If provided, the options will be grouped under the returned string. The groupBy value is also used as the text for group headings when renderGroup is not provided.Signature:function(options: Value) => stringoptions The options to group.", "default": "-", "value": "", "type": "func", "required": false }, "handleHomeEndKeys": { "description": "If true, the component handles the \"Home\" and \"End\" keys when the popup is open. It should move focus to the first option and last option, respectively.", "description_zh": "If true, the component handles the \"Home\" and \"End\" keys when the popup is open. It should move focus to the first option and last option, respectively.", "default": "!props.freeSolo", "value": "", "type": "bool", "required": false }, "id": { "description": "This prop is used to help implement the accessibility logic. If you don't provide an id it will fall back to a randomly generated one.", "description_zh": "This prop is used to help implement the accessibility logic. If you don't provide an id it will fall back to a randomly generated one.", "default": "-", "value": "", "type": "string", "required": false }, "includeInputInList": { "description": "If true, the highlight can move to the input.", "description_zh": "If true, the highlight can move to the input.", "default": "false", "value": "", "type": "bool", "required": false }, "inputValue": { "description": "The input value.", "description_zh": "The input value.", "default": "-", "value": "", "type": "string", "required": false }, "isOptionEqualToValue": { "description": "Used to determine if the option represents the given value. Uses strict equality by default. ⚠️ Both arguments need to be handled, an option can only match with one value.Signature:function(option: Value, value: Value) => booleanoption The option to test.value The value to test against.", "description_zh": "Used to determine if the option represents the given value. Uses strict equality by default. ⚠️ Both arguments need to be handled, an option can only match with one value.Signature:function(option: Value, value: Value) => booleanoption The option to test.value The value to test against.", "default": "-", "value": "", "type": "func", "required": false }, "limitTags": { "description": "The maximum number of tags that will be visible when not focused. Set -1 to disable the limit.", "description_zh": "The maximum number of tags that will be visible when not focused. Set -1 to disable the limit.", "default": "-1", "value": "", "type": "integer", "required": false }, "ListboxComponent": { "description": "The component used to render the listbox.", "description_zh": "The component used to render the listbox.", "default": "'ul'", "value": "", "type": "elementType", "required": false }, "ListboxProps": { "description": "Props applied to the Listbox element.", "description_zh": "Props applied to the Listbox element.", "default": "-", "value": "", "type": "object", "required": false }, "loading": { "description": "If true, the component is in a loading state. This shows the loadingText in place of suggestions (only if there are no suggestions to show, for example options are empty).", "description_zh": "If true, the component is in a loading state. This shows the loadingText in place of suggestions (only if there are no suggestions to show, for example options are empty).", "default": "false", "value": "", "type": "bool", "required": false }, "loadingText": { "description": "Text to display when in a loading state.For localization purposes, you can use the provided translations.", "description_zh": "Text to display when in a loading state.For localization purposes, you can use the provided translations.", "default": "'Loading…'", "value": "", "type": "node", "required": false }, "multiple": { "description": "If true, value must be an array and the menu will support multiple selections.", "description_zh": "If true, value must be an array and the menu will support multiple selections.", "default": "false", "value": "", "type": "bool", "required": false }, "noOptionsText": { "description": "Text to display when there are no options.For localization purposes, you can use the provided translations.", "description_zh": "Text to display when there are no options.For localization purposes, you can use the provided translations.", "default": "'No options'", "value": "", "type": "node", "required": false }, "onChange": { "description": "Callback fired when the value changes.Signature:function(event: React.SyntheticEvent, value: Value | Array, reason: string, details?: string) => voidevent The event source of the callback.value The new value of the component.reason One of \"createOption\", \"selectOption\", \"removeOption\", \"blur\" or \"clear\".", "description_zh": "Callback fired when the value changes.Signature:function(event: React.SyntheticEvent, value: Value | Array, reason: string, details?: string) => voidevent The event source of the callback.value The new value of the component.reason One of \"createOption\", \"selectOption\", \"removeOption\", \"blur\" or \"clear\".", "default": "-", "value": "", "type": "func", "required": false }, "onClose": { "description": "Callback fired when the popup requests to be closed. Use in controlled mode (see open).Signature:function(event: React.SyntheticEvent, reason: string) => voidevent The event source of the callback.reason Can be: \"toggleInput\", \"escape\", \"selectOption\", \"removeOption\", \"blur\".", "description_zh": "Callback fired when the popup requests to be closed. Use in controlled mode (see open).Signature:function(event: React.SyntheticEvent, reason: string) => voidevent The event source of the callback.reason Can be: \"toggleInput\", \"escape\", \"selectOption\", \"removeOption\", \"blur\".", "default": "-", "value": "", "type": "func", "required": false }, "onHighlightChange": { "description": "Callback fired when the highlight option changes.Signature:function(event: React.SyntheticEvent, option: Value, reason: string) => voidevent The event source of the callback.option The highlighted option.reason Can be: \"keyboard\", \"auto\", \"mouse\", \"touch\".", "description_zh": "Callback fired when the highlight option changes.Signature:function(event: React.SyntheticEvent, option: Value, reason: string) => voidevent The event source of the callback.option The highlighted option.reason Can be: \"keyboard\", \"auto\", \"mouse\", \"touch\".", "default": "-", "value": "", "type": "func", "required": false }, "onInputChange": { "description": "Callback fired when the input value changes.Signature:function(event: React.SyntheticEvent, value: string, reason: string) => voidevent The event source of the callback.value The new value of the text input.reason Can be: \"input\" (user input), \"reset\" (programmatic change), \"clear\".", "description_zh": "Callback fired when the input value changes.Signature:function(event: React.SyntheticEvent, value: string, reason: string) => voidevent The event source of the callback.value The new value of the text input.reason Can be: \"input\" (user input), \"reset\" (programmatic change), \"clear\".", "default": "-", "value": "", "type": "func", "required": false }, "onOpen": { "description": "Callback fired when the popup requests to be opened. Use in controlled mode (see open).Signature:function(event: React.SyntheticEvent) => voidevent The event source of the callback.", "description_zh": "Callback fired when the popup requests to be opened. Use in controlled mode (see open).Signature:function(event: React.SyntheticEvent) => voidevent The event source of the callback.", "default": "-", "value": "", "type": "func", "required": false }, "open": { "description": "If true, the component is shown.", "description_zh": "If true, the component is shown.", "default": "-",