When null, the caller is requesting root select options.
Child Nodes or a nullish value when node does not have children.
Returning a nullish value indicates that node is a Leaf Node.
Retrieve the parent of node.
Branch Node parent of node or a nullish value when node does not have a parent.
Returning a nullish value indicates that node is a root select option.
Render the input.
A function that determines the filtered options to be rendered on search.
The options to render.
The state of the component.
The label to display when the tags are truncated (limitTags).
The number of truncated tags.
Used to determine the disabled state for a given option.
The option to test.
Used to provided custom key prop to rendered options.
Option keys are generated by {@link UseTreeSelectProps.getOptionLabel}.
A keys' uniqueness can be compromised when getOptionLabel returns the
same string for two different options. Use this method to resolve such
conflicts.
Used to determine the string value of a path. path ascends ancestors.
Uses getOptionLabel and branchDelimiter by default.
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.
Determine if an option is a Branch or Leaf Node.
Overrides default behavior which is to call {@link UseTreeSelectProps.getChildren} and to infer node type from the return value.
Determine if Branch Node is selectable as a value.
When true, will add a Leaf option in addition to the Branch option for the Node.
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.
The option to test.
The value to test against.
Callback fired when active branch changes.
Indicates the direction of along the tree.
Callback fired when the value changes.
The event source of the callback.
The new value of the component.
One of "createOption", "selectOption", "removeOption", "blur" or "clear".
Render the group.
The group to render.
Render the selected value.
Props applied to the Chip element.
The component used to render the listbox.
Props applied to the Listbox element.
The component used to render the body of the popup.
The component used to position the popup.
Props applied to the Tooltip elements.
Prefix option label for a adding freeSolo values.
Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.
Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.
Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
Defines the total number of columns in a table, grid, or treegrid.
Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
Identifies the element (or elements) whose contents or presence are controlled by the current element.
Indicates the element that represents the current item within a container or set of related elements.
Identifies the element (or elements) that describes the object.
Identifies the element that provides a detailed, extended description for the object.
Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
Indicates what functions can be performed when a dragged object is released on the drop target.
Identifies the element that provides an error message for the object.
Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.
Indicates an element's "grabbed" state in a drag-and-drop operation.
Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
Indicates whether the element is exposed to an accessibility API.
Indicates the entered value does not conform to the format expected by the application.
Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
Defines a string value that labels the current element.
Identifies the element (or elements) that labels the current element.
Defines the hierarchical level of an element within a structure.
Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
Indicates whether an element is modal when displayed.
Indicates whether a text box accepts multiple lines of input or only a single line.
Indicates that the user may select more than one item from the current selectable descendants.
Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.
Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.
Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
Indicates the current "pressed" state of toggle buttons.
Indicates that the element is not editable, but is otherwise operable.
Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
Indicates that user input is required on the element before a form may be submitted.
Defines a human-readable, author-localized description for the role of an element.
Defines the total number of rows in a table, grid, or treegrid.
Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
Indicates the current "selected" state of various widgets.
Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
Indicates if items in a table or grid are sorted in ascending or descending order.
Defines the maximum allowed value for a range widget.
Defines the minimum allowed value for a range widget.
Defines the current value for a range widget.
Defines the human readable text alternative of aria-valuenow for a range widget.
If true, the portion of the selected suggestion that has not been typed by the user,
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.
If true, the first option is automatically highlighted.
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.
Control if the input should be blurred when an option is selected:
false the input is not blurred.true the input is always blurred.touch the input is blurred after a touch event.mouse the input is blurred after a mouse event.The active Branch Node. This Node's children will be displayed in the select menu.
Delimits branches in path labels.
Override or extend the styles applied to the component.
The icon to display in place of the default clear icon.
If true, the input's text is cleared on blur if no value is selected.
Set to true if you want to help the user enter a new value.
Set to false if you want to help the user resume their search.
If true, clear all values when the user presses escape and the popup is closed.
Override the default text for the clear icon button.
For localization purposes, you can use the provided translations.
Override the default text for the close popup icon button.
For localization purposes, you can use the provided translations.
The component name that is using this hook. Used for warnings.
The props used for each slot inside.
The default branch. Use when the component is not controlled.
The default value. Use when the component is not controlled.
If true, the input can't be cleared.
If true, the popup won't close when a value is selected.
If true, the list box in the popup will not wrap focus.
If true, the Popper content will be under the DOM hierarchy of the parent component.
If true, the component is disabled.
If true, will allow focus on disabled items.
The icon to display in place of the default enter icon.
Override the default down branch icon tooltip title.
The icon to display in place of the default exit icon.
Override the default up branch icon tooltip title.
If true, hide the selected options from the list box.
Force the visibility display of the popup icon.
If true, the Autocomplete is free solo, meaning that the user input is not bound to provided options.
If true, the input will take up the full width of its container.
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.
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.
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.
If true, the highlight can move to the input.
Hints at the type of data that might be entered by the user while editing the element or its contents
The input value.
Specify that a standard HTML element should behave like a defined custom built-in element
The maximum number of tags that will be visible when not focused.
Set -1 to disable the limit.
Text to display when in a loading state.
For localization purposes, you can use the provided translations.
If true, value must be an array and the menu will support multiple selections.
Text to display when there are no options.
For localization purposes, you can use the provided translations.
If true, the component is shown.
If true, the popup will open on input focus.
Override the default text for the open popup icon button.
For localization purposes, you can use the provided translations.
The icon to display in place of the default path icon.
Rendered when multiple === false.
The icon to display in place of the default popup icon.
If true, the component becomes readonly. It is also supported for multiple tags where the tag cannot be deleted.
Render the option, use getOptionLabel by default.
If true, the input's text is selected on focus.
It helps the user clear the selected value.
The size of the component.
The props used for each slot inside.
The system prop that allows defining system overrides as well as additional CSS styles.
The value of the autocomplete.
The value must have reference equality with the option in order to be selected.
You can customize the equality behavior with the isOptionEqualToValue prop.
Generated using TypeDoc
Retrieve the child nodes of
node.Rejections must be handled when returning a Promise.