OptionalaboutOptionalaccessOptionalaria-Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
Optionalaria-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.
Optionalaria-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.
Optionalaria-Defines a string value that labels the current element, which is intended to be converted into Braille.
Optionalaria-Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
Optionalaria-Optionalaria-Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
Optionalaria-Defines the total number of columns in a table, grid, or treegrid.
Optionalaria-Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
Optionalaria-Defines a human readable text alternative of aria-colindex.
Optionalaria-Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
Optionalaria-Identifies the element (or elements) whose contents or presence are controlled by the current element.
Optionalaria-Indicates the element that represents the current item within a container or set of related elements.
Optionalaria-Identifies the element (or elements) that describes the object.
Optionalaria-Defines a string value that describes or annotates the current element.
Optionalaria-Identifies the element that provides a detailed, extended description for the object.
Optionalaria-Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
Optionalaria-Indicates what functions can be performed when a dragged object is released on the drop target.
Optionalaria-Identifies the element that provides an error message for the object.
Optionalaria-Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
Optionalaria-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.
Optionalaria-Indicates an element's "grabbed" state in a drag-and-drop operation.
Optionalaria-Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
Optionalaria-Indicates whether the element is exposed to an accessibility API.
Optionalaria-Indicates the entered value does not conform to the format expected by the application.
Optionalaria-Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
Optionalaria-Defines a string value that labels the current element.
Optionalaria-Identifies the element (or elements) that labels the current element.
Optionalaria-Defines the hierarchical level of an element within a structure.
Optionalaria-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.
Optionalaria-Indicates whether an element is modal when displayed.
Optionalaria-Indicates whether a text box accepts multiple lines of input or only a single line.
Optionalaria-Indicates that the user may select more than one item from the current selectable descendants.
Optionalaria-Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
Optionalaria-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.
Optionalaria-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.
Optionalaria-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.
Optionalaria-Indicates the current "pressed" state of toggle buttons.
Optionalaria-Indicates that the element is not editable, but is otherwise operable.
Optionalaria-Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
Optionalaria-Indicates that user input is required on the element before a form may be submitted.
Optionalaria-Defines a human-readable, author-localized description for the role of an element.
Optionalaria-Defines the total number of rows in a table, grid, or treegrid.
Optionalaria-Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
Optionalaria-Defines a human readable text alternative of aria-rowindex.
Optionalaria-Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
Optionalaria-Indicates the current "selected" state of various widgets.
Optionalaria-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.
Optionalaria-Indicates if items in a table or grid are sorted in ascending or descending order.
Optionalaria-Defines the maximum allowed value for a range widget.
Optionalaria-Defines the minimum allowed value for a range widget.
Optionalaria-Defines the current value for a range widget.
Optionalaria-Defines the human readable text alternative of aria-valuenow for a range widget.
OptionalautoOptionalautoOptionalautoOptionalautoOptionalcaseChanges the matching logic to make it case-sensitive:
| Link | URL | isActive |
|---|---|---|
<NavLink to="/SpOnGe-bOB" /> |
/sponge-bob |
true |
<NavLink to="/SpOnGe-bOB" caseSensitive /> |
/sponge-bob |
false |
OptionalchildrenCan be regular React children or a function that receives an object with the
active and pending states of the link.
<NavLink to="/tasks">
{({ isActive }) => (
<span className={isActive ? "active" : ""}>Tasks</span>
)}
</NavLink>
OptionalclassClasses are automatically applied to NavLink that correspond to the state.
a.active {
color: red;
}
a.pending {
color: blue;
}
a.transitioning {
view-transition-name: my-transition;
}
Or you can specify a function that receives NavLinkRenderProps and
returns the className:
<NavLink className={({ isActive, isPending }) => (
isActive ? "my-active-class" :
isPending ? "my-pending-class" :
""
)} />
OptionalcolorOptionalcontentOptionalcontentOptionalcontextOptionaldangerouslyOptionaldatatypeOptionaldefaultOptionaldefaultOptionaldirOptionaldiscoverDefines the link lazy route discovery behavior.
<Link /> // default ("render")
<Link discover="render" />
<Link discover="none" />
OptionaldownloadOptionaldraggableOptionalendChanges the matching logic for the active and pending states to only match
to the "end" of the NavLinkProps.to. If the URL is longer, it will no
longer be considered active.
| Link | URL | isActive |
|---|---|---|
<NavLink to="/tasks" /> |
/tasks |
true |
<NavLink to="/tasks" /> |
/tasks/123 |
true |
<NavLink to="/tasks" end /> |
/tasks |
true |
<NavLink to="/tasks" end /> |
/tasks/123 |
false |
<NavLink to="/"> is an exceptional case because every URL matches /.
To avoid this matching every single route by default, it effectively ignores
the end prop and only matches when you're at the root route.
OptionalhiddenOptionalhrefOptionalidOptionalinlistOptionalinputHints at the type of data that might be entered by the user while editing the element or its contents
OptionalisSpecify that a standard HTML element should behave like a defined custom built-in element
OptionalitemOptionalitemOptionalitemOptionalitemOptionalitemOptionallangOptionalmediaOptionalnonceOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalpingOptionalplaceholderOptionalprefetchDefines 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).
OptionalprefixOptionalpreventPrevents 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 resetting scroll to the top, scroll position will be restored for back/forward button navigation.
<Link to="?tab=one" preventScrollReset />
OptionalpropertyOptionalradioOptionalreferrerOptionalrelOptionalrelativeDefines 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"Note that index routes and layout routes do not have paths so they are not included in the relative path calculation.
OptionalreloadWill 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 />
OptionalreplaceReplaces 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
OptionalresourceOptionalresultsOptionalrevOptionalroleOptionalsecurityOptionalslotOptionalspellOptionalstateAdds 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
OptionalstyleStyles can also be applied dynamically via a function that receives NavLinkRenderProps and returns the styles:
<NavLink to="/tasks" style={{ color: "red" }} />
<NavLink to="/tasks" style={({ isActive, isPending }) => ({
color:
isActive ? "red" :
isPending ? "blue" : "black"
})} />
OptionalsuppressOptionalsuppressOptionaltabOptionaltargetOptionaltitleCan be a string or a partial Path:
<Link to="/some/path" />
<Link
to={{
pathname: "/some/path",
search: "?query=string",
hash: "#hash",
}}
/>
OptionaltranslateOptionaltypeOptionaltypeofOptionalunselectableOptionalunstable_Specify the default revalidation behavior for the navigation.
<Link to="/some/path" unstable_defaultShouldRevalidate={false} />
If no shouldRevalidate functions are present on the active routes, then this
value will be used directly. Otherwise it will be passed into shouldRevalidate
so the route can make the final determination on revalidation. This can be
useful when updating search params and you don't want to trigger a revalidation.
By default (when not specified), loaders will revalidate according to the routers standard revalidation behavior.
OptionalviewEnables a View Transition for this navigation.
Click me
To apply specific styles for the transition, see useViewTransitionState
Optionalvocab