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.
Boolean if the the child is currently collapsed.
Boolean if the dense spec should be applied to the list.
Boolean if the transition should allow for an enter animation once the
transitionIn booleanis set to true.
Boolean if the transition should allow for an exit animation once the
transitionIn booleanis set to false.
Boolean if the list should appear horizontally instead of vertically.
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
The minimum height that the collapsed element can be which defaults to 0.
This can either be a number of pixels or a string CSS height value.
Setting this value to any non-zero value will allow for the element to shrink to the defined min-height, and then expand to the full height once no longer collapsed.
Note: If the minHeight, minPaddingTop, and minPaddingBottom options
are all set to 0 (default), the child will be removed from the DOM while
collapsed.
The minimum padding-bottom that the collapsed element can be which defaults
to 0. This can either be a number of pixels or a string CSS
padding-bottom value.
Note: If the minHeight, minPaddingTop, and minPaddingBottom options
are all set to 0 (default), the child will be removed from the DOM while
collapsed.
The minimum padding-top that the collapsed element can be which defaults to
0. This can either be a number of pixels or a string CSS padding-top
value.
Note: If the minHeight, minPaddingTop, and minPaddingBottom options
are all set to 0 (default), the child will be removed from the DOM while
collapsed.
An optional enter handler that can be used to determine additional
transition styles if you need access to the DOM node to calculate those
styles. This will also be fired for appear transitions.
This will be fired right after the transitionIn is set to true.
An optional entered handler that can be used to determine additional
transition styles if you need access to the DOM node to calculate those
styles. This will also be fired for appear transitions.
This will be fired once the transition has finished.
An optional entering handler that can be used to determine additional
transition styles if you need access to the DOM node to calculate those
styles. This will also be fired for appear transitions.
This will be fired almost immediately after the onEnter callback.
However, if the repaint option was enabled, it will ensure the DOM as
been repainted before firing to help with CSS transitions.
An optional exit handler that can be used to determine additional transition styles if you need access to the DOM node to calculate those styles.
This will be fired right after the transitionIn is set to false.
An optional entered handler that can be used to determine additional
transition styles if you need access to the DOM node to calculate those
styles. This will also be fired for appear transitions.
This will be fired once the transition has finished.
Note: If the temporary option was enabled, the rendered result will be
false and the node actually won't exist in the DOM anymore.
An optional exit handler that can be used to determine additional transition styles if you need access to the DOM node to calculate those styles.
This will be fired almost immdiately after the onExit callback. However,
if the repaint option was enabled, it will ensure the DOM as been
repainted before firing to help with CSS transitions.
Boolean if the list's order is important. This will update the list to be
rendered as an <ol> instead of <ul>.
An optional ref that will get merged with the required ref for the transition to work.
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.
Boolean if the component should mount and unmount based on the current
transitionIn stage with a default value of false. When this is
false, the first result (rendered) in the return value array will
always be true.
When this is set to true, the first result (rendered) in the return
value array will be true only while the transitionIn option is true
or the transition is still happening.
Note: Changing this option while the hook/component is mounted will not
do anything. If you want to dynamically change the component's temporary
state, you will need to also change the key to get the component to
re-mount.
The timeout for the collapse transition. This will default to 250ms enter and 200ms exit.
Generated using TypeDoc
Boolean if the transition should also be triggered immediately once the component mounts. This is generally not recommended for server side rendering/initial page load so it is set to
falseby default.