Skip to content

[pull] main from remix-run:main #258

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pull merged 2 commits into from
Mar 25, 2026
Merged

[pull] main from remix-run:main #258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
82eca19
docs: clarify useViewTransitionState matches to or from path (#14922)
brookslybrand Mar 25, 2026
b15c07c
chore: generate markdown docs from jsdocs
remix-run-bot Mar 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/api/hooks/useViewTransitionState.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/do
[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react-router.useViewTransitionState.html)

This hook returns `true` when there is an active [View Transition](https://developer.mozilla.org/en-US/docs/Web/API/View_Transitions_API)
to the specified location. This can be used to apply finer-grained styles to
and the specified location matches either side of the navigation (the URL you are
navigating **to** or the URL you are navigating **from**). This can be used to apply finer-grained styles to
elements to further customize the view transition. This requires that view
transitions have been enabled for the given navigation via [`LinkProps.viewTransition`](https://api.reactrouter.com/v7/interfaces/react-router.LinkProps.html#viewTransition)
(or the `Form`, `submit`, or `navigate` call)
Expand All @@ -45,7 +46,7 @@ function useViewTransitionState(

### to

The [`To`](https://api.reactrouter.com/v7/types/react-router.To.html) location to check for an active [View Transition](https://developer.mozilla.org/en-US/docs/Web/API/View_Transitions_API).
The [`To`](https://api.reactrouter.com/v7/types/react-router.To.html) location to compare against the active transition's current and next URLs.

### options.relative

Expand All @@ -55,5 +56,5 @@ more details.
## Returns

`true` if there is an active [View Transition](https://developer.mozilla.org/en-US/docs/Web/API/View_Transitions_API)
to the specified [`Location`](https://api.reactrouter.com/v7/interfaces/react-router.Location.html), otherwise `false`.
and the resolved path matches the transition's destination or source pathname, otherwise `false`.

8 changes: 5 additions & 3 deletions packages/react-router/lib/dom/lib.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3309,7 +3309,8 @@ export function usePrompt({

/**
* This hook returns `true` when there is an active [View Transition](https://developer.mozilla.org/en-US/docs/Web/API/View_Transitions_API)
* to the specified location. This can be used to apply finer-grained styles to
* and the specified location matches either side of the navigation (the URL you are
* navigating **to** or the URL you are navigating **from**). This can be used to apply finer-grained styles to
* elements to further customize the view transition. This requires that view
* transitions have been enabled for the given navigation via {@link LinkProps.viewTransition}
* (or the `Form`, `submit`, or `navigate` call)
Expand All @@ -3318,13 +3319,14 @@ export function usePrompt({
* @category Hooks
* @mode framework
* @mode data
* @param to The {@link To} location to check for an active [View Transition](https://developer.mozilla.org/en-US/docs/Web/API/View_Transitions_API).
* @param to The {@link To} location to compare against the active transition's current
* and next URLs.
* @param options Options
* @param options.relative The relative routing type to use when resolving the
* `to` location, defaults to `"route"`. See {@link RelativeRoutingType} for
* more details.
* @returns `true` if there is an active [View Transition](https://developer.mozilla.org/en-US/docs/Web/API/View_Transitions_API)
* to the specified {@link Location}, otherwise `false`.
* and the resolved path matches the transition's destination or source pathname, otherwise `false`.
*/
export function useViewTransitionState(
to: To,
Expand Down
Loading