Normally a component is not transitioned if it is shown when the
<Transition>
component mounts. If you want to transition on the first
mount set appear to true, and the component will transition in as soon
as the <Transition>
mounts. Note: there are no specific "appear" states.
appear only adds an additional enter transition.
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.
The label for the menu. Either this or the "aria-labelledby"
prop is
required for a11y.
The id of an element that acts as a label for the menu. Either this or the
"aria-label"
prop is required for a11y.
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 animation classNames
applied to the component as it enters or exits.
A single name can be provided and it will be suffixed for each stage: e.g.
classNames="fade"
applies fade-enter
, fade-enter-active
,
fade-exit
, fade-exit-active
, fade-appear
, and fade-appear-active
.
Each individual classNames can also be specified independently like:
classNames={{
appear: 'my-appear',
appearActive: 'my-appear-active',
appearDone: 'my-appear-done',
enter: 'my-enter',
enterActive: 'my-enter-active',
enterDone: 'my-enter-done',
exit: 'my-exit',
exitActive: 'my-exit-active',
exitDone: 'my-exit-done'
}}
Boolean if the menu should no longer close when the page is resized. Instead, it'll automatically update its position within the viewport.
Boolean if the menu should not be closed when the page is scrolled. Instead, it'll automatically update its position within the viewport. You normally don't want to enable this prop as the menu won't close if the menu control element is no longer in the viewport.
The id of the control element that toggles the menu. This is required so
that the menu can be positioned to this element and is normally a
<button>
.
The element that should be focused first when opened. This can either be the first or last focusable item in the menu, or a query selector string to find an element.
Boolean if the close on outside click logic should consider the control
element within the menu and not call the onRequestClose
function when it
is been clicked. This should be enabled when creating a context menu but
normally should remain false
otherwise since the control element has it's
own toggle logic that conflicts with this close click.
Enable or disable enter transitions.
Enable or disable exit transitions.
Boolean if the menu should be rendered horizontally instead of vertically.
The id for the menu. This is required for a11y.
Show the component; triggers the enter or exit states
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
By default the child component is mounted immediately along with the
parent Transition component. If you want to "lazy mount" the component on
the first in={true}
you can set mountOnEnter
. After the first enter
transition the component will stay mounted, even on "exited", unless you
also specify unmountOnExit
.
Callback fired before the "entering" status is applied. An extra
parameter isAppearing
is supplied to indicate if the enter stage is
occurring on the initial mount
Callback fired after the "entered" status is applied. An extra parameter isAppearing is supplied to indicate if the enter stage is occurring on the initial mount
Callback fired after the "entering" status is applied. An extra parameter isAppearing is supplied to indicate if the enter stage is occurring on the initial mount
Callback fired before the "exiting" status is applied.
Callback fired after the "exited" status is applied.
Callback fired after the "exiting" status is applied.
Boolean if the portal should be used.
Optional options to pass down to the useFixedPositionin
hook styles to
change how the menu is fixed to the MenuButton
.
The role for the menu. This should normally just be "menu"
, but I might
expand on it to implement the "listbox"
or other menu like widgets.
The tab index for the menu. This should probably be left at -1
.
By default the child component stays mounted after it reaches the
'exited' state. Set unmountOnExit
if you'd prefer to unmount the
component after it finishes exiting.
Boolean if the menu is currently visible.
A function to call that should set the visible
prop to false.
Generated using TypeDoc
The positioning anchor for the menu relative to the button/control that owns the menu. This is used for the positioning logic as well as modifying the animationg slightly to originate from a coordinate. When this is omitted, it will default to: