Boolean if the transition should occur immediately once the component
mounts if the TransitionOptions.transitionIn is true
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.
A label to apply to the dialog. Either this or the aria-labelledby prop
are required for accessibility.
An id pointing to an element that is a label for the dialog. Either this or
the aria-label prop are required for accessibility.
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 Menus children.
{@inheritDoc CSSTransitionClassNames}
The component to render the dialog as. This really shouldn't be used
outside of the @react-md/layout and @react-md/sheet packages to
conditionally render a navigation panel.
An optional className to apply to the dialog container when the type is
set to "centered" or when the forceContainer prop is enabled. You
probably don't want to use this prop in most cases.
An optional style to apply to the dialog container when the type is set
to "centered" or when the forceContainer prop is enabled. You probably
don't want to use this prop in most cases.
Either the "first" or "last" string to focus the first or last focusable element within the container or a query selector string to find a focusable element within the container.
Boolean if the ability to close the dialog via the escape key should be disabled. You should really not be using this as it breaks accessibility in most cases.
Note: When the modal prop is enabled, this flag will be considered true
as well so that the escape keypress no longer closes the dialog.
By default, the focus container will try to maintain a cache of the focusable elements that is updated only when this component re-renders. If the children are extremely dynamic and focusable elements can be removed/added without this component updating, you should disable the cache so that the focusable elements are updated each time the tab key is pressed. Disabling the cache will be slightly slower for larger focusable areas, but it might not be too bad.
NOTE: The only important elements are the first and last elements in this list. So if your children aren't changing the first and last elements, there's no need to disable the cache.
Boolean if the dialog's focus container logic should be disabled. This
should normally be kept at the default of false unless implementing a
custom dialog that does not require consistent user focus.
The default behavior for the focus container is to focus an element once it
is mounted and the disabled prop is not enabled. This behavior can be
disabled if this is not wanted for some reason.
Boolean if the element that gets focused on mount should try to not scroll
the focused element into view which is the default behavior. This should
normally remain false, but it is useful to set to true if the
FocusContainer is within a transition that appears offscreen.
The default behavior for the focus container is to attempt to focus the element that was focused before the focus container was mounted since it is generally used for temporary material. If there are cases where this behavior is not wanted, you can enable this prop.
The Dialog component will attempt to automatically fix nested dialogs
behind the scenes using the NestedDialogContextProvider component. This
prop will disable that feature if it does not seem to be working as
expected.
Boolean if the dialog should no longer add scroll locking to the page when
visible. You normally want this prop to stay false, but it is useful when
using custom dialogs that are more for popovers and don't require full user
attention.
Boolean if the focus behavior should be disabled. This should really be used if you are using nested focus containers for temporary material (such as dialogs or menus).
Boolean if the appear, enter, and exit transitions should be disabled
for the dialog. This is just a shortcut so all three of those props don't
need to be disabled.
Boolean if the transition should occur whenever the
TransitionOptions.transitionIn is switch to true after the
component has been rendered in the DOM.
Boolean if the transition should occur whenever the
TransitionOptions.transitionIn is switch to false after the
component has been rendered in the DOM.
{@inheritDoc MenuConfiguration.sheetFooter}
{@inheritDoc MenuConfiguration.sheetHeader}
Boolean if the menu should be rendered horizontally instead of vertically.
This will also update the aria-orientation.
{@inheritDoc SheetHorizontalSize}
An id required for a11y for the dialog.
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
An optional className to provide to the List component that surrounds the
MenuItem within a Menu.
Any additional props to pass to the List component that surrounds the
Menu's MenuItems.
An optional style to provide to the List component that surrounds the
MenuItem within a Menu.
Any additional props that should be passed to the Menu component.
This should be the menuRef returned by the useMenu hook so that the
menu can be focused on mount.
This is called whenever one of the {@link KeyboardMovementBehavior.decrementKeys} are pressed.
This function will be called once the TransitionStage has been set
to "enter".
This function will be called once the TransitionStage has been set
to "entering".
This function will be called once the TransitionStage has been set
to "enter".
This function will be called once the TransitionStage has been set
to "entered".
This function will be called once the TransitionStage has been set
to "exited".
This function will be called once the TransitionStage has been set
to "exiting".
This is called whenever one of the {@link KeyboardMovementBehavior.incrementKeys} are pressed.
This is called whenever one of the {@link KeyboardMovementBehavior.jumpToFirstKeys} are pressed.
This is called whenever one of the {@link KeyboardMovementBehavior.jumpToLastKeys} are pressed.
This is called whenever a single letter has been pressed and
KeyboardMovementBehavior.searchable is true.
Boolean if there should be an overlay displayed with the sheet. This is recommended/required on mobile devices.
An optional className to apply to the overlay.
Boolean if the overlay should be "hidden" from the user once it's visible
be keeping the opacity set to 0. This is really only used for custom
dialogs like the FixedDialog.
Any additional props that should be passed to the Overlay element.
An optional style to apply to the overlay.
Boolean if the portal should be used.
{@inheritDoc SheetPosition}
The role that the sheet should be rendered as. You'll normally want to keep
this as the default of "dialog" unless you are implementing a mobile
sheet menu.
Note: Setting this to "menu" will not provide the menu keyboard
accessibility automatically.
The tab index for the sheet. This should normally stay at -1.
{@inheritDoc CSSTransitionHookOptions.temporary}
{@inheritDoc TransitionTimeout}
When the focus container unmounts, it will attempt to re-focus the element
that was focused before the focus container was mounted unless the
disableFocusOnUnmount prop is enabled. There might be cases where
unmounting the focus container causes the page to re-render and the
previous element no longer exists. When this happens keyboard users might
have a problem navigating through the page again depending on how the
browser implemented the native tab behavior so this prop allows you to
ensure that a specific element is focused in these cases.
This can either be a query selector string, a specific HTMLElement, or a function that finds a specific HTMLElement to focus.
{@inheritDoc SheetVerticalSize}
Boolean if the dialog is currently visible.
A function that can be used to get the default focus index when the
container element first gains focus. If this returns -1, no child element
will be focused and the container will maintain focus instead.
The current list of elements that can be focused within the container element
The container element that gained focus
An optional function to call when the custom focused element should change.
The default value is just to call element.focus().
The element that should gain custom focus
The next focus index which can be used for additional movement behavior.
A function used to close the dialog when the overlay is clicked or the
escape key is pressed when the modal prop is not enabled.
Generated using TypeDoc
@since 5.0.0