Skip to content

Clarify useViewTransitionState docs for bidirectional matching#14845

Open
createhb21 wants to merge 2 commits intoremix-run:mainfrom
createhb21:codex/use-view-transition-state-bidirectional-docs
Open

Clarify useViewTransitionState docs for bidirectional matching#14845
createhb21 wants to merge 2 commits intoremix-run:mainfrom
createhb21:codex/use-view-transition-state-bidirectional-docs

Conversation

@createhb21
Copy link

Summary

  • clarify useViewTransitionState docs to describe bidirectional matching (active when transitioning to or from the given location)
  • keep generated API docs aligned by updating the source JSDoc comment in lib.tsx
  • add a DOM router test that verifies useViewTransitionState stays active for both currentLocation and nextLocation while a transition is in progress

Testing

  • pnpm test packages/react-router/__tests__/dom/data-browser-router-test.tsx -t "keeps useViewTransitionState active for both from/to locations during transitions"
  • pnpm exec prettier --check packages/react-router/lib/dom/lib.tsx packages/react-router/__tests__/dom/data-browser-router-test.tsx

Closes #14686.

@changeset-bot
Copy link

changeset-bot bot commented Mar 3, 2026

⚠️ No Changeset found

Latest commit: 9a8428d

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@remix-cla-bot
Copy link
Contributor

remix-cla-bot bot commented Mar 3, 2026

Hi @createhb21,

Welcome, and thank you for contributing to React Router!

Before we consider your pull request, we ask that you sign our Contributor License Agreement (CLA). We require this only once.

You may review the CLA and sign it by adding your name to contributors.yml.

Once the CLA is signed, the CLA Signed label will be added to the pull request.

If you have already signed the CLA and received this response in error, or if you have any questions, please contact us at hello@remix.run.

Thanks!

- The Remix team

@remix-cla-bot
Copy link
Contributor

remix-cla-bot bot commented Mar 3, 2026

Thank you for signing the Contributor License Agreement. Let's get this merged! 🥳

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs]: useViewTransition is misleading

1 participant