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.
An optional aria-label to provide to the tree. This will be defaulted to
"Navigation".
An optional space-delimited list of ids that help describe this tree. This
can be used instead of an aria-label or alongside for additional screen
reader description.
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.
Boolean if the dense spec should be applied to the list.
Boolean if the temporary navigation type should no longer automatically
close when the selectedIds updates to contain a new route when using the
useLayoutNavigation hook. This makes it so when a user on mobile clicks
a route within your app in the main navigation pane, it will automatically
close if it was a link.
The list of expanded ids within the tree. These ids should reference
itemIds for tree items.
The icon to show within each item within the tree that helps show that there are child items.
NOTE: This will override the rightAddon prop if defined on each item by
default so they can't be used. If the expanderLeft prop is enabled, the
leftAddon will be overridden instead.
Boolean if the expander icon should appear to the left instead of the right.
Boolean if the list should appear horizontally instead of vertically.
The id to use for the tree. When this is omitted, it will be set to
${baseId}-navigation-tree where the baseId is the id provided to the
parent Layout component.
Hints at the type of data that might be entered by the user while editing the element or its contents
Specify that a standard HTML element should behave like a defined custom built-in element
A function that gets called to render each TreeItem within the tree. This
can be overridden if you need to add additional functionality around the
TreeItem (such as drag and drop). The default behavior is to extract the
ListItem props:
leftAddonleftAddonTypeleftAddonPositionrightAddonrightAddonTyperightAddonPositionchildrento / hrefisLinkand try to render as a TreeItem with those props. It will also override
the expanderLeft and expanderIcon on the TreeItem with whatever was
provided to the Tree component.
The key to use to extract a renderable label from each tree item. This will
be displayed in the DOM as the children in each tree item.
The component to use for any treeitem that has a to, href, or isLink
attribute. This is a nice way to be able to update treeitems to be links
instead of storing the contentComponent in the tree's data.
Boolean if the LayoutTree is being rendered as the mini variant. This
will update the itemRenderer to default to the
defaultMiniNavigationItemRenderer instead of the
defaultNavigationItemRenderer.
The TreeItemRenderer to use if the mini prop is enabled.
Boolean if multiple items within the tree can be selected at once.
Optional className to provide to the <nav> element surrounding the tree
The navigation items to render.
Optional style to provide to the <nav> element surrounding the tree
A function to call when the user presses the asterisk key (*) that will expand all tree items at the same level as the currently focused item.
Boolean if the list's order is important. This will update the list to be
rendered as an <ol> instead of <ul>.
The role is set to "none" by default for lists screen readers announce
lists differently than other elements on the page. Since the major use-case
for lists is to contain clickable items, setting this to "none" fixes
this issue.
An optional id to use to determine the root items within the tree. You'll
most likely want to keep this as the default of null, but it can also be
used if you have a different identifier for root items.
The list of selected ids within the tree. If you only want to allow a
single item to be selected at a time within a tree, keep this as either an
empty list (no selections) or a single itemId.
Boolean if the mini navigation should be treated as a "sticky" element.
This should really only be true if disabling the fixed AppBar behavior
in the Layout.
The key to use to extract a text string from each tree item. This is used for keyboard accessibility and being able to "search" the tree for items starting with the typed letters.
A function to extract the renderable label from each tree item. The default
behavior will be to just return item[labelKey].
A function to extract the text string from each tree item. The default
behavior will be to return the item[valueKey] and stringify it.
A function to call that will update the expandedIds to collapse or expand
a clicked item.
A function to call that will update the selectedIds to include itemId
of the newly selected tree item. This will be triggered when:
Note: If you are using the useTreeItemSelection hook, this will always
cause the selectedIds to be a list of just the selected itemId unless
the multiSelect (second argument) is enabled.
A function to call that will update the selectedIds for "batch"
selection updates. This will always be called with a unique list of
itemIds that contained the previous itemIds including the new
itemIds. This will only be called when the multiSelect prop has been
enabled and:
Shift + Clicks items within the treeControl+Shift+Home or
Control+Shift+EndGenerated using TypeDoc
Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.