Type: string
Type: string
Type: string
Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
Type: Booleanish
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.
Type: "none" | "list" | "inline" | "both"
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.
Type: string
Defines a string value that labels the current element, which is intended to be converted into Braille.
Type: string
Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
Type: Booleanish
Type: boolean | "true" | "false" | "mixed"
Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
Type: number
Defines the total number of columns in a table, grid, or treegrid.
Type: number
Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
Type: string
Defines a human readable text alternative of aria-colindex.
Type: number
Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
Type: string
Identifies the element (or elements) whose contents or presence are controlled by the current element.
Type: boolean | "time" | "true" | "location" | "page" | "step" | "false" | "date"
Indicates the element that represents the current item within a container or set of related elements.
Type: string
Identifies the element (or elements) that describes the object.
Type: string
Defines a string value that describes or annotates the current element.
Type: string
Identifies the element that provides a detailed, extended description for the object.
Type: Booleanish
Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
Type: "link" | "copy" | "none" | "execute" | "move" | "popup"
Indicates what functions can be performed when a dragged object is released on the drop target.
Type: string
Identifies the element that provides an error message for the object.
Type: Booleanish
Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
Type: string
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.
Type: Booleanish
Indicates an element's "grabbed" state in a drag-and-drop operation.
Type: boolean | "dialog" | "menu" | "true" | "false" | "grid" | "listbox" | "tree"
Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
Type: Booleanish
Indicates whether the element is exposed to an accessibility API.
Type: boolean | "true" | "false" | "grammar" | "spelling"
Indicates the entered value does not conform to the format expected by the application.
Type: string
Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
Type: string
Defines a string value that labels the current element.
Type: string
Identifies the element (or elements) that labels the current element.
Type: number
Defines the hierarchical level of an element within a structure.
Type: "off" | "assertive" | "polite"
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.
Type: Booleanish
Indicates whether an element is modal when displayed.
Type: Booleanish
Indicates whether a text box accepts multiple lines of input or only a single line.
Type: Booleanish
Indicates that the user may select more than one item from the current selectable descendants.
Type: "horizontal" | "vertical"
Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
Type: string
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.
Type: string
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.
Type: number
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.
Type: boolean | "true" | "false" | "mixed"
Indicates the current "pressed" state of toggle buttons.
Type: Booleanish
Indicates that the element is not editable, but is otherwise operable.
Type: "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"
Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
Type: Booleanish
Indicates that user input is required on the element before a form may be submitted.
Type: string
Defines a human-readable, author-localized description for the role of an element.
Type: number
Defines the total number of rows in a table, grid, or treegrid.
Type: number
Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
Type: string
Defines a human readable text alternative of aria-rowindex.
Type: number
Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
Type: Booleanish
Indicates the current "selected" state of various widgets.
Type: number
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.
Type: "none" | "ascending" | "descending" | "other"
Indicates if items in a table or grid are sorted in ascending or descending order.
Type: number
Defines the maximum allowed value for a range widget.
Type: number
Defines the minimum allowed value for a range widget.
Type: number
Defines the current value for a range widget.
Type: string
Defines the human readable text alternative of aria-valuenow for a range widget.
Type: string
Type: string
Type: boolean
Type: string
Type: ReactNode
Type: string
Type: string
Type: string
Type: "inherit" | Booleanish
Type: string
Type: { __html: string | TrustedHTML, }
Type: string
Type: boolean
Type: string | number | readonly string[]
Type: string
Type: DiscoverBehavior
Defines the link discovery behavior
<Link /> // default ("render")
<Link discover="render" />
<Link discover="none" />
Type: any
Type: Booleanish
Type: boolean
Type: string
Type: string
Type: any
Type: "search" | "text" | "url" | "none" | "tel" | "email" | "numeric" | "decimal"
Hints at the type of data that might be entered by the user while editing the element or its contents
Type: string
Specify that a standard HTML element should behave like a defined custom built-in element
Type: string
Type: string
Type: string
Type: boolean
Type: string
Type: string
Type: string
Type: string
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: AnimationEventHandler<HTMLAnchorElement>
Type: AnimationEventHandler<HTMLAnchorElement>
Type: AnimationEventHandler<HTMLAnchorElement>
Type: AnimationEventHandler<HTMLAnchorElement>
Type: AnimationEventHandler<HTMLAnchorElement>
Type: AnimationEventHandler<HTMLAnchorElement>
Type: MouseEventHandler<HTMLAnchorElement>
Type: MouseEventHandler<HTMLAnchorElement>
Type: FormEventHandler<HTMLAnchorElement>
Type: FormEventHandler<HTMLAnchorElement>
Type: FocusEventHandler<HTMLAnchorElement>
Type: FocusEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: FormEventHandler<HTMLAnchorElement>
Type: FormEventHandler<HTMLAnchorElement>
Type: MouseEventHandler<HTMLAnchorElement>
Type: MouseEventHandler<HTMLAnchorElement>
Type: CompositionEventHandler<HTMLAnchorElement>
Type: CompositionEventHandler<HTMLAnchorElement>
Type: CompositionEventHandler<HTMLAnchorElement>
Type: CompositionEventHandler<HTMLAnchorElement>
Type: CompositionEventHandler<HTMLAnchorElement>
Type: CompositionEventHandler<HTMLAnchorElement>
Type: MouseEventHandler<HTMLAnchorElement>
Type: MouseEventHandler<HTMLAnchorElement>
Type: ClipboardEventHandler<HTMLAnchorElement>
Type: ClipboardEventHandler<HTMLAnchorElement>
Type: ClipboardEventHandler<HTMLAnchorElement>
Type: ClipboardEventHandler<HTMLAnchorElement>
Type: MouseEventHandler<HTMLAnchorElement>
Type: MouseEventHandler<HTMLAnchorElement>
Type: DragEventHandler<HTMLAnchorElement>
Type: DragEventHandler<HTMLAnchorElement>
Type: DragEventHandler<HTMLAnchorElement>
Type: DragEventHandler<HTMLAnchorElement>
Type: DragEventHandler<HTMLAnchorElement>
Type: DragEventHandler<HTMLAnchorElement>
Type: DragEventHandler<HTMLAnchorElement>
Type: DragEventHandler<HTMLAnchorElement>
Type: DragEventHandler<HTMLAnchorElement>
Type: DragEventHandler<HTMLAnchorElement>
Type: DragEventHandler<HTMLAnchorElement>
Type: DragEventHandler<HTMLAnchorElement>
Type: DragEventHandler<HTMLAnchorElement>
Type: DragEventHandler<HTMLAnchorElement>
Type: DragEventHandler<HTMLAnchorElement>
Type: DragEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: FocusEventHandler<HTMLAnchorElement>
Type: FocusEventHandler<HTMLAnchorElement>
Type: PointerEventHandler<HTMLAnchorElement>
Type: PointerEventHandler<HTMLAnchorElement>
Type: FormEventHandler<HTMLAnchorElement>
Type: FormEventHandler<HTMLAnchorElement>
Type: FormEventHandler<HTMLAnchorElement>
Type: FormEventHandler<HTMLAnchorElement>
Type: KeyboardEventHandler<HTMLAnchorElement>
Type: KeyboardEventHandler<HTMLAnchorElement>
Type: KeyboardEventHandler<HTMLAnchorElement>
Type: KeyboardEventHandler<HTMLAnchorElement>
Type: KeyboardEventHandler<HTMLAnchorElement>
Type: KeyboardEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: PointerEventHandler<HTMLAnchorElement>
Type: PointerEventHandler<HTMLAnchorElement>
Type: MouseEventHandler<HTMLAnchorElement>
Type: MouseEventHandler<HTMLAnchorElement>
Type: MouseEventHandler<HTMLAnchorElement>
Type: MouseEventHandler<HTMLAnchorElement>
Type: MouseEventHandler<HTMLAnchorElement>
Type: MouseEventHandler<HTMLAnchorElement>
Type: MouseEventHandler<HTMLAnchorElement>
Type: MouseEventHandler<HTMLAnchorElement>
Type: MouseEventHandler<HTMLAnchorElement>
Type: MouseEventHandler<HTMLAnchorElement>
Type: MouseEventHandler<HTMLAnchorElement>
Type: MouseEventHandler<HTMLAnchorElement>
Type: ClipboardEventHandler<HTMLAnchorElement>
Type: ClipboardEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: PointerEventHandler<HTMLAnchorElement>
Type: PointerEventHandler<HTMLAnchorElement>
Type: PointerEventHandler<HTMLAnchorElement>
Type: PointerEventHandler<HTMLAnchorElement>
Type: PointerEventHandler<HTMLAnchorElement>
Type: PointerEventHandler<HTMLAnchorElement>
Type: PointerEventHandler<HTMLAnchorElement>
Type: PointerEventHandler<HTMLAnchorElement>
Type: PointerEventHandler<HTMLAnchorElement>
Type: PointerEventHandler<HTMLAnchorElement>
Type: PointerEventHandler<HTMLAnchorElement>
Type: PointerEventHandler<HTMLAnchorElement>
Type: PointerEventHandler<HTMLAnchorElement>
Type: PointerEventHandler<HTMLAnchorElement>
Type: PointerEventHandler<HTMLAnchorElement>
Type: PointerEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: FormEventHandler<HTMLAnchorElement>
Type: FormEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: UIEventHandler<HTMLAnchorElement>
Type: UIEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: FormEventHandler<HTMLAnchorElement>
Type: FormEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: TouchEventHandler<HTMLAnchorElement>
Type: TouchEventHandler<HTMLAnchorElement>
Type: TouchEventHandler<HTMLAnchorElement>
Type: TouchEventHandler<HTMLAnchorElement>
Type: TouchEventHandler<HTMLAnchorElement>
Type: TouchEventHandler<HTMLAnchorElement>
Type: TouchEventHandler<HTMLAnchorElement>
Type: TouchEventHandler<HTMLAnchorElement>
Type: TransitionEventHandler<HTMLAnchorElement>
Type: TransitionEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: ReactEventHandler<HTMLAnchorElement>
Type: WheelEventHandler<HTMLAnchorElement>
Type: WheelEventHandler<HTMLAnchorElement>
Type: string
Type: string
Type: PrefetchBehavior
Defines the data and module prefetching behavior for the link.
<Link /> // default
<Link prefetch="none" />
<Link prefetch="intent" />
<Link prefetch="render" />
<Link prefetch="viewport" />
Prefetching is done with HTML <link rel="prefetch">
tags. They are inserted after the link.
<a href="..." />
<a href="..." />
<link rel="prefetch" /> // might conditionally render
Because of this, if you are using nav :last-child
you will need to use nav :last-of-type
so the styles don't conditionally fall off your last link (and any other similar selectors).
Type: string
Type: boolean
Prevents the scroll position from being reset to the top of the window when the link is clicked and the app is using ScrollRestoration. This only prevents new locations reseting scroll to the top, scroll position will be restored for back/forward button navigation.
<Link to="?tab=one" preventScrollReset />
Type: string
Type: string
Type: HTMLAttributeReferrerPolicy
Type: string
Type: RelativeRoutingType
Defines the relative path behavior for the link.
<Link to=".." /> // default: "route"
<Link relative="route" />
<Link relative="path" />
Consider a route hierarchy where a parent route pattern is "blog" and a child route pattern is "blog/:slug/edit".
".."
will remove both :slug/edit
segments back to "/blog"...
will only remove one URL segment up to "/blog/:slug"Type: boolean
Will use document navigation instead of client side routing when the link is clicked: the browser will handle the transition normally (as if it were an <a href>
).
<Link to="/logout" reloadDocument />
Type: boolean
Replaces the current entry in the history stack instead of pushing a new one onto it.
<Link replace />
# with a history stack like this
A -> B
# normal link click pushes a new entry
A -> B -> C
# but with `replace`, B is replaced by C
A -> C
Type: string
Type: number
Type: string
Type: AriaRole
Type: string
Type: string
Type: Booleanish
Type: any
Adds persistent client side routing state to the next location.
<Link to="/somewhere/else" state={{ some: "value" }} />
The location state is accessed from the location
.
function SomeComp() {
const location = useLocation()
location.state; // { some: "value" }
}
This state is inaccessible on the server as it is implemented on top of history.state
Type: CSSProperties
Type: boolean
Type: boolean
Type: number
Type: HTMLAttributeAnchorTarget
Type: string
Type: To
Can be a string or a partial Path:
<Link to="/some/path" />
<Link
to={{
pathname: "/some/path",
search: "?query=string",
hash: "#hash",
}}
/>
Type: "yes" | "no"
Type: string
Type: string
Type: "on" | "off"
Type: boolean
Enables a View Transition for this navigation.
<Link to={to} viewTransition>
Click me
</Link>
To apply specific styles for the transition, see useViewTransitionState
Type: string