{
"hookDescription": "",
"parametersDescriptions": {
"areOptionsEqual": {
"description": "A function used to determine if two options' values are equal. By default, reference equality is used.
There is a performance impact when using the areOptionsEqual prop (proportional to the number of options). Therefore, it's recommented to use the default reference equality comparison whenever possible."
},
"buttonRef": { "description": "The ref of the trigger button element." },
"componentName": {
"description": "The name of the component using useSelect. For debugging purposes."
},
"defaultOpen": { "description": "If true, the select will be open by default." },
"defaultValue": {
"description": "The default selected value. Use when the component is not controlled."
},
"disabled": { "description": "If true, the select is disabled." },
"getOptionAsString": {
"description": "A function used to convert the option label to a string. This is useful when labels are elements and need to be converted to plain text to enable keyboard navigation with character keys."
},
"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."
},
"listboxId": { "description": "The id attribute of the listbox element." },
"listboxRef": { "description": "The ref of the listbox element." },
"multiple": {
"description": "If true, the end user can select multiple values. This affects the type of the value, defaultValue, and onChange props."
},
"name": {
"description": "The name attribute of the hidden input element. This is useful when the select is embedded in a form and you want to access the selected value in the form data."
},
"onChange": { "description": "Callback fired when an option is selected." },
"onHighlightChange": { "description": "Callback fired when an option is highlighted." },
"onOpenChange": { "description": "Callback fired when the listbox is opened or closed." },
"open": {
"description": "Controls the open state of the select's listbox. This is the controlled equivalent of the defaultOpen prop."
},
"options": {
"description": "An alternative way to specify the options. If this parameter is set, options defined as JSX children are ignored."
},
"required": {
"description": "If true, the select embedded in a form must have a selected value. Otherwise, the form submission will fail."
},
"value": {
"description": "The selected value. Set to null to deselect all options."
}
},
"returnValueDescriptions": {
"buttonActive": {
"description": "If true, the trigger button is active (pressed)."
},
"buttonFocusVisible": {
"description": "If true, the trigger button has a visible focus."
},
"buttonRef": { "description": "Ref to the button slot DOM node." },
"contextValue": {
"description": "A value to be passed to the SelectProvider component."
},
"disabled": { "description": "If true, the select is disabled." },
"dispatch": {
"description": "Action dispatcher for the select component. Allows to programmatically control the select."
},
"getButtonProps": { "description": "Resolver for the button slot's props." },
"getHiddenInputProps": { "description": "Resolver for the hidden input slot's props." },
"getListboxProps": { "description": "Resolver for the listbox slot's props." },
"getOptionMetadata": {
"description": "A function that returns the metadata of an option with a given value."
},
"highlightedOption": { "description": "The value of the highlighted option." },
"listboxRef": { "description": "Ref to the listbox slot DOM node." },
"open": { "description": "If true, the listbox is open." },
"options": { "description": "Values of all the registered options." },
"value": { "description": "The value of the selected option(s)." }
}
}