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.
The component to render the item's content in. This should normally stay as
the default "span" element, but if you'd like to make a navigation tree,
this can be set as a Link component from a routing library.
Example:
<TreeItem href="#" contentComponent="a" />
<TreeItem to="/example-url" contentComponent={Link} exact />
The current depth that the tree item is being rendered at. This will be a
number starting from 1 since it should be directly mapped to
"aria-posinset".
Boolean if the tree item is disabled which will prevent it from being interactable. It will still be "keyboard focusable" while disabled, but clicking or selecting won't work.
Boolean if the tree item is expanded. When this is true, it should add
aria-expanded="true" to the tree item.
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 tree item is the current keyboard focus.
Boolean if the left and/or right addons should be "forcefully" wrapped in a
<span> with the spacing class names applied instead of attempting to
clone it into the provided icon element.
The height to apply to the list item.
Conversions:
A DOM id for the tree item. This is required for a11y since this id should
reflect the aria-activedescendant value on the base Tree component to
show current keyboard focus.
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
Boolean if the TreeItem is a link component which changes up how the
accessibility attributes are applied to the DOM. The default behavior is to
check if the contentComponent is to consider it a link if it is not a
string (custom component) or the string: "a". Since this might cause some
false-positives, you can set this flag instead which will always be used
instead.
The current tree item's index within its list at the provided depth. This
will be a number starting from 1 since it should be directly mapped to
"aria-posinset".
An optional addon to display to the left of the primaryText or
children and should be used with the leftAddonType prop to adjust
spacing.
The vertical position the left icon, avatar, media, or large media should be placed.
The type of the addon that appears to the left of the primaryText or
children.
An optional className to apply to the surrounding <li> element for the
tree item. The className prop is actually passed to the
contentComponent element instead since you normally don't want to apply
styles to the surrounding element.
An optional ref to apply to the content of the tree item.
An optional style to apply to the surrounding <li> element for the tree
item. The style prop is actually passed to the contentComponent element
instead since you normally don't want to apply styles to the surrounding
element.
The current total list size for the tree item at the provided depth. This
should be mapped directly into "aria-setsize".
An optional element that should be rendered as the primaryText within the
list item. It is most likely easier to use the children prop instead, but
this allows you to create more complex components with the ListItem since
you can provided children and have the styles for the primaryText still
applied. By default, this will only allow one line of text and add ellipsis
for any text overflow.
Boolean if the tree item is read only. Not sure why this was added though
since <li> elements don't support readOnly.
An optional addon to display to the right of the primaryText or
children and should be used with the rightAddonType prop to adjust
spacing.
The vertical position the right icon, avatar, media, or large media should be placed.
The type of the addon that appears to the right of the primaryText or
children.
An optional element that should be rendered as the secondaryText within
the list item. By default, this will only span one line and add ellipsis
for overflow.
An optional className to apply to the <span> that surrounds the
secondaryText within the list item.
Boolean if the tree item is currently selected.
Boolean if the children should be treated as the primaryText prop. This
will wrap them in an additional class so that they have ellipsis for text
overflow.
If you want to have more "freedom" within the ListItem, you can disable
this prop so that the height will grow depending on content.
NOTE: If the secondaryText prop is provided, this will always be
considered true.
An optional className to apply to the <span> that surrounds the
primaryText and optionally secondaryText within the list item.
Boolean if the list item should be considered "three-lines" in height. This
will update the secondaryText to span 2 lines instead of one, but it will
not correctly applied the trailing ellipsis overflow due to browser
compatibility of line-clamp. If you would still like the ellipsis to
show, it is recommended to use javascript to add them yourself.
This function will only be provided when the tree item has child tree
items. This function should only be called within the exported TreeGroup
component or in a component that has the role="group" for accessibility.
Generated using TypeDoc
Since I allow the
contentComponentprop for handling rendering<a>tags from other routing libraries, I unfortunately need an index key so that those props can be passed down correctly.