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 card should use a border instead of box-shadow. Enabling
this prop will always disable the
An optional className to provide the content of the panel.
An optional style to provide to the content of the panel.
An optional header element to display instead of the default implementation.
Boolean if the padding should be removed from the content. This is really only useful if your child elements have their own padding.
Boolean if any
<p> tags that appear as children of this component should
no longer have their
margin-bottom removed. The default
behavior is to remove all
margin-top and remove the
<p> is the last child.
Boolean if the current secondary text color should be disabled from the content.
Boolean if the collapse transition should be disabled for the content within the panel. It is recommended to disable this transition if there is a lot of content within the panel since animating max-height isn't super great since it causes DOM repaints during the entire transition.
Boolean if clicking on the header should no longer toggle the expansion
state. This will automatically be provided from the
usePanels hook for
when a panel cannot be closed to do preventing all panels from being closed
at a time.
Boolean if the panel is currently expanded.
An optional expander icon to use within the default header implementation.
This defaults to the
Boolean if the card should no longer be
display: inline-block, but
display: block; width: 100%;.
The children to display within the default header element.
An optional className to provide to the default header implementation. If
header prop is provided, this will do nothing.
An optional ref to pass to the default header implementation. This will be
provided automatically if you are using the
usePanels hook to allow
keyboard movement with the arrow keys and home/end keys. If you provide
header, you'll need to pass the
headerRef to your custom
implementation to the focusable element for the keyboard focus behavior to
An optional style object to provide to the default header implementation. If
header prop is provided, this will do nothing.
An id for the panel that is required for a11y.
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 margin top should be applied to this header to add some
additional spacing between this panel and the previous panel. This will
automatically be provided for panels when using the
A function that should attempt to change the expansion state of the panel.
Boolean if the content should be persistent within the DOM instead of unmounting once no longer expanded. This is only really helpful if you want to maintain state while the panel is hidden since the children will unmount when not expanded.
Boolean if the card should gain additional box-shadow elevation once hovered.
Generated using TypeDoc