Skip to content

feat: add support for View Transition API types #12991

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.

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

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from

Conversation

lsharir
Copy link

@lsharir lsharir commented Feb 10, 2025

Add Support for View Transition API Types

Enables passing custom transition types via the new viewTransition prop for targeted CSS animations.

<Link to="/about" viewTransition={{ types: ["fade", "slide"] }}>
  About
 </Link>

This works alongside the existing global viewTransition boolean prop.

Description

This PR adds support for custom view transition types in React Router. Developers can now pass an array of transition type names (e.g. ["fade", "slide"]) via the new viewTransition prop (or as an options object) to be applied with document.startViewTransition(), enabling targeted CSS animations during navigation.

Changes Overview

  • RouterProvider & Context: Introduces a new state to hold and propagate view transition types.
  • DOM & Global Types: Extends DOM typings to support an options object for document.startViewTransition().
  • Components (Link, NavLink, Form, etc.): Propagates the new viewTransition prop through relevant components.
  • Router: Records and applies view transition options for both PUSH/REPLACE and POP navigations.

Testing & Documentation

  • Added tests to verify that custom view transition types are correctly applied.
  • Updated docs (e.g., in docs/how-to/view-transitions.md) with examples.
  • Local builds and tests are passing.

Additional Context

This feature leverages the experimental View Transitions API. For details on browser support and available transition types, please check caniuse.

Related Links

Please review and share any comments or suggestions for improvements.

Copy link

changeset-bot bot commented Feb 10, 2025

⚠️ No Changeset found

Latest commit: cd9c6c7

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 Feb 10, 2025

Hi @lsharir,

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 [email protected].

Thanks!

- The Remix team

@remix-cla-bot
Copy link
Contributor

remix-cla-bot bot commented Feb 10, 2025

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.

1 participant