Skip to content
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

Add <ViewTransition> Component #31975

Open
wants to merge 32 commits into
base: main
Choose a base branch
from

Conversation

sebmarkbage
Copy link
Collaborator

@sebmarkbage sebmarkbage commented Jan 4, 2025

This will provide the opt-in for using View Transitions in React.

View Transitions only trigger for async updates like startTransition, useDeferredValue, Actions or <Suspense> revealing from fallback to content. Synchronous updates provide an opt-out but also guarantee that they commit immediately which View Transitions can't.

There's no need to opt-in to View Transitions at the "cause" side like event handlers or actions. They don't know what UI will change and whether that has an animated transition described.

Conceptually the <ViewTransition> component is like a DOM fragment that transitions its children in its own isolate/snapshot. The API works by wrapping a DOM node or inner component:

import {ViewTransition} from 'react';

<ViewTransition><Component /></ViewTransition>

The default is name="auto" which will automatically assign a view-transition-name to the inner DOM node. That way you can add a View Transition to a Component without controlling its DOM nodes styling otherwise.

A difference between this and the browser's built-in view-transition-name: auto is that switching the DOM nodes within the <ViewTransition> component preserves the same name so this example cross-fades between the DOM nodes instead of causing an exit and enter:

<ViewTransition>{condition ? <ComponentA /> : <ComponentB />}</ViewTransition>

This becomes especially useful with <Suspense> as this example cross-fades between Skeleton and Content:

<ViewTransition>
  <Suspense fallback={<Skeleton />}>
    <Content />
  </Suspense>
</ViewTransition>

Where as this example triggers an exit of the Skeleton and an enter of the Content:

<Suspense fallback={<ViewTransition><Skeleton /></ViewTransition>}>
  <ViewTransition><Content /></ViewTransition>
</Suspense>

Managing instances and keys becomes extra important.

You can also specify an explicit name property for example for animating the same conceptual item from one page onto another. However, best practices is to property namespace these since they can easily collide. It's also useful to add an id to it if available.

<ViewTransition name="my-shared-view">

The model in general is the same as plain view-transition-name except React manages a set of heuristics for when to apply it. A problem with the naive View Transitions model is that it overly opts in every boundary that might transition into transitioning. This is leads to unfortunate effects like things floating around when unrelated updates happen. This leads the whole document to animate which means that nothing is clickable in the meantime. It makes it not useful for smaller and more local transitions. Best practice is to add view-transition-name only right before you're about to need to animate the thing. This is tricky to manage globally on complex apps and is not compositional. Instead we let React manage when a <ViewTransition> "activates" and add/remove the view-transition-name. This is also when React calls startViewTransition behind the scenes while it mutates the DOM.

I've come up with a number of heuristics that I think will make a lot easier to coordinate this. The principle is that only if something that updates that particular boundary do we activate it. I hope that one day maybe browsers will have something like these built-in and we can remove our implementation.

A <ViewTransition> only activates if:

  • If a mounted Component renders a <ViewTransition> within it outside the first DOM node, and it is within the viewport, then that ViewTransition activates as an "enter" animation. This avoids inner "enter" animations trigger when the parent mounts.
  • If an unmounted Component had a <ViewTransition> within it outside the first DOM node, and it was within the viewport, then that ViewTransition activates as an "exit" animation. This avoids inner "exit" animations triggering when the parent unmounts.
  • If an explicitly named <ViewTransition name="..."> is deep within an unmounted tree and one with the same name appears in a mounted tree at the same time, then both are activated as a pair, but only if they're both in the viewport. This avoids these triggering "enter" or "exit" animations when going between parents that don't have a pair.
  • If an already mounted <ViewTransition> is visible and a DOM mutation, that might affect how it's painted, happens within its children but outside any nested <ViewTransition>. This allows it to "cross-fade" between its updates.
  • If an already mounted <ViewTransition> resizes or moves as the result of direct DOM nodes siblings changing or moving around. This allows insertion, deletion and reorders into a list to animate all children. It is only within one DOM node though, to avoid unrelated changes in the parent to trigger this. If an item is outside the viewport before and after, then it's skipped to avoid things flying across the screen.
  • If a <ViewTransition> boundary changes size, due to a DOM mutation within it, then the parent activates (or the root document if there are no more parents). This ensures that the container can cross-fade to avoid abrupt relayout. This can be avoided by using absolutely positioned children. When this can avoid bubbling to the root document, whatever is not animating is still responsive to clicks during the transition.

Conceptually each DOM node has its own default that activates the parent <ViewTransition> or no transition if the parent is the root. That means that if you add a DOM node like <div><ViewTransition><Component /></ViewTransition></div> this won't trigger an "enter" animation since it was the div that was added, not the ViewTransition. Instead, it might cause a cross-fade of the parent ViewTransition or no transition if it had no parent. This ensures that only explicit boundaries perform coarse animations instead of every single node which is really the benefit of the View Transitions model. This ends up working out well for simple cases like switching between two pages immediately while transitioning one floating item that appears on both pages. Because only the floating item transitions by default.

Note that it's possible to add manual view-transition-name with CSS or style={{ viewTransitionName: 'auto' }} that always transitions as long as something else has a <ViewTransition> that activates. For example a <ViewTransition> can wrap a whole page for a cross-fade but inside of it an explicit name can be added to something to ensure it animates as a move when something relates else changes its layout. Instead of just cross-fading it along with the Page which would be the default.

There's more PRs coming with some optimizations, fixes and expanded APIs. This first PR explores the above core heuristic.

Copy link

vercel bot commented Jan 4, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
react-compiler-playground ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 7, 2025 4:09am

@react-sizebot
Copy link

react-sizebot commented Jan 4, 2025

Comparing: 3314162...2d3d593

Critical size changes

Includes critical production bundles, as well as any change greater than 2%:

Name +/- Base Current +/- gzip Base gzip Current gzip
oss-stable/react-dom/cjs/react-dom.production.js = 6.68 kB 6.68 kB = 1.83 kB 1.83 kB
oss-stable/react-dom/cjs/react-dom-client.production.js +0.12% 513.40 kB 514.03 kB +0.08% 91.72 kB 91.79 kB
oss-experimental/react-dom/cjs/react-dom.production.js = 6.69 kB 6.69 kB = 1.83 kB 1.83 kB
oss-experimental/react-dom/cjs/react-dom-client.production.js +5.14% 518.18 kB 544.81 kB +4.71% 92.57 kB 96.93 kB
facebook-www/ReactDOM-prod.classic.js +0.14% 595.45 kB 596.29 kB +0.13% 104.81 kB 104.95 kB
facebook-www/ReactDOM-prod.modern.js +0.14% 585.72 kB 586.56 kB +0.12% 103.25 kB 103.38 kB
oss-experimental/react-reconciler/cjs/react-reconciler.production.js +6.31% 394.01 kB 418.86 kB +5.53% 64.04 kB 67.58 kB
oss-experimental/react-art/cjs/react-art.production.js +6.27% 306.09 kB 325.28 kB +5.21% 52.31 kB 55.04 kB
oss-experimental/react-reconciler/cjs/react-reconciler.profiling.js +5.70% 446.20 kB 471.63 kB +5.09% 71.66 kB 75.31 kB
oss-experimental/react-dom/cjs/react-dom-unstable_testing.production.js +5.00% 532.91 kB 559.54 kB +4.53% 96.20 kB 100.56 kB
oss-experimental/react-dom/cjs/react-dom-profiling.profiling.js +4.80% 573.25 kB 600.79 kB +4.37% 101.21 kB 105.63 kB
oss-experimental/react-reconciler/cjs/react-reconciler.development.js +4.06% 678.17 kB 705.72 kB +3.65% 107.54 kB 111.47 kB
oss-experimental/react-art/cjs/react-art.development.js +3.76% 594.90 kB 617.26 kB +3.22% 95.02 kB 98.08 kB
oss-experimental/react-is/cjs/react-is.production.js +3.46% 4.46 kB 4.61 kB +2.98% 1.08 kB 1.11 kB
oss-experimental/react-is/cjs/react-is.development.js +3.32% 5.00 kB 5.17 kB +3.03% 1.12 kB 1.16 kB
oss-experimental/react-dom/cjs/react-dom-client.development.js +3.25% 981.49 kB 1,013.41 kB +2.99% 165.08 kB 170.01 kB
oss-experimental/react-dom/cjs/react-dom-profiling.development.js +3.20% 997.93 kB 1,029.85 kB +2.93% 167.91 kB 172.83 kB
oss-experimental/react-dom/cjs/react-dom-unstable_testing.development.js +3.20% 998.43 kB 1,030.35 kB +2.90% 168.82 kB 173.71 kB
oss-stable-semver/react-is/cjs/react-is.production.js +2.49% 4.46 kB 4.57 kB +2.51% 1.08 kB 1.10 kB
oss-stable/react-is/cjs/react-is.production.js +2.49% 4.46 kB 4.57 kB +2.51% 1.08 kB 1.10 kB
facebook-react-native/react-is/cjs/ReactIs-prod.js +2.49% 4.47 kB 4.58 kB +2.90% 1.07 kB 1.10 kB
facebook-react-native/react-is/cjs/ReactIs-profiling.js +2.49% 4.47 kB 4.58 kB +2.90% 1.07 kB 1.10 kB
facebook-react-native/react-is/cjs/ReactIs-dev.js +2.40% 4.95 kB 5.07 kB +3.11% 1.09 kB 1.13 kB
oss-stable-semver/react-is/cjs/react-is.development.js +2.38% 5.00 kB 5.12 kB +2.67% 1.12 kB 1.15 kB
oss-stable/react-is/cjs/react-is.development.js +2.38% 5.00 kB 5.12 kB +2.67% 1.12 kB 1.15 kB

Significant size changes

Includes any change greater than 0.2%:

Expand to show
Name +/- Base Current +/- gzip Base gzip Current gzip
oss-experimental/react-reconciler/cjs/react-reconciler.production.js +6.31% 394.01 kB 418.86 kB +5.53% 64.04 kB 67.58 kB
oss-experimental/react-art/cjs/react-art.production.js +6.27% 306.09 kB 325.28 kB +5.21% 52.31 kB 55.04 kB
oss-experimental/react-reconciler/cjs/react-reconciler.profiling.js +5.70% 446.20 kB 471.63 kB +5.09% 71.66 kB 75.31 kB
oss-experimental/react-dom/cjs/react-dom-client.production.js +5.14% 518.18 kB 544.81 kB +4.71% 92.57 kB 96.93 kB
oss-experimental/react-dom/cjs/react-dom-unstable_testing.production.js +5.00% 532.91 kB 559.54 kB +4.53% 96.20 kB 100.56 kB
oss-experimental/react-dom/cjs/react-dom-profiling.profiling.js +4.80% 573.25 kB 600.79 kB +4.37% 101.21 kB 105.63 kB
oss-experimental/react-reconciler/cjs/react-reconciler.development.js +4.06% 678.17 kB 705.72 kB +3.65% 107.54 kB 111.47 kB
oss-experimental/react-art/cjs/react-art.development.js +3.76% 594.90 kB 617.26 kB +3.22% 95.02 kB 98.08 kB
oss-experimental/react-is/cjs/react-is.production.js +3.46% 4.46 kB 4.61 kB +2.98% 1.08 kB 1.11 kB
oss-experimental/react-is/cjs/react-is.development.js +3.32% 5.00 kB 5.17 kB +3.03% 1.12 kB 1.16 kB
oss-experimental/react-dom/cjs/react-dom-client.development.js +3.25% 981.49 kB 1,013.41 kB +2.99% 165.08 kB 170.01 kB
oss-experimental/react-dom/cjs/react-dom-profiling.development.js +3.20% 997.93 kB 1,029.85 kB +2.93% 167.91 kB 172.83 kB
oss-experimental/react-dom/cjs/react-dom-unstable_testing.development.js +3.20% 998.43 kB 1,030.35 kB +2.90% 168.82 kB 173.71 kB
oss-stable-semver/react-is/cjs/react-is.production.js +2.49% 4.46 kB 4.57 kB +2.51% 1.08 kB 1.10 kB
oss-stable/react-is/cjs/react-is.production.js +2.49% 4.46 kB 4.57 kB +2.51% 1.08 kB 1.10 kB
facebook-react-native/react-is/cjs/ReactIs-prod.js +2.49% 4.47 kB 4.58 kB +2.90% 1.07 kB 1.10 kB
facebook-react-native/react-is/cjs/ReactIs-profiling.js +2.49% 4.47 kB 4.58 kB +2.90% 1.07 kB 1.10 kB
facebook-react-native/react-is/cjs/ReactIs-dev.js +2.40% 4.95 kB 5.07 kB +3.11% 1.09 kB 1.13 kB
oss-stable-semver/react-is/cjs/react-is.development.js +2.38% 5.00 kB 5.12 kB +2.67% 1.12 kB 1.15 kB
oss-stable/react-is/cjs/react-is.development.js +2.38% 5.00 kB 5.12 kB +2.67% 1.12 kB 1.15 kB
facebook-www/ReactIs-prod.classic.js +1.93% 5.74 kB 5.85 kB +1.93% 1.34 kB 1.37 kB
facebook-www/ReactIs-prod.modern.js +1.93% 5.74 kB 5.85 kB +1.93% 1.34 kB 1.37 kB
oss-stable-semver/react-noop-renderer/cjs/react-noop-renderer.production.js +1.90% 35.66 kB 36.34 kB +1.43% 6.71 kB 6.81 kB
oss-stable/react-noop-renderer/cjs/react-noop-renderer.production.js +1.90% 35.68 kB 36.36 kB +1.38% 6.74 kB 6.83 kB
oss-experimental/react-noop-renderer/cjs/react-noop-renderer.production.js +1.90% 35.69 kB 36.37 kB +1.38% 6.74 kB 6.84 kB
oss-stable-semver/react-noop-renderer/cjs/react-noop-renderer-persistent.production.js +1.90% 35.79 kB 36.46 kB +1.43% 6.73 kB 6.83 kB
oss-stable/react-noop-renderer/cjs/react-noop-renderer-persistent.production.js +1.90% 35.81 kB 36.49 kB +1.38% 6.76 kB 6.85 kB
oss-experimental/react-noop-renderer/cjs/react-noop-renderer-persistent.production.js +1.90% 35.82 kB 36.50 kB +1.38% 6.76 kB 6.86 kB
facebook-www/ReactIs-dev.classic.js +1.88% 6.34 kB 6.46 kB +2.04% 1.37 kB 1.40 kB
facebook-www/ReactIs-dev.modern.js +1.88% 6.34 kB 6.46 kB +2.04% 1.37 kB 1.40 kB
oss-stable-semver/react-noop-renderer/cjs/react-noop-renderer.development.js +1.81% 39.80 kB 40.52 kB +1.32% 7.30 kB 7.40 kB
oss-stable/react-noop-renderer/cjs/react-noop-renderer.development.js +1.81% 39.83 kB 40.55 kB +1.25% 7.33 kB 7.42 kB
oss-experimental/react-noop-renderer/cjs/react-noop-renderer.development.js +1.81% 39.83 kB 40.55 kB +1.27% 7.34 kB 7.43 kB
oss-stable-semver/react-noop-renderer/cjs/react-noop-renderer-persistent.development.js +1.80% 39.94 kB 40.66 kB +1.31% 7.32 kB 7.41 kB
oss-stable/react-noop-renderer/cjs/react-noop-renderer-persistent.development.js +1.80% 39.97 kB 40.69 kB +1.27% 7.35 kB 7.44 kB
oss-experimental/react-noop-renderer/cjs/react-noop-renderer-persistent.development.js +1.80% 39.97 kB 40.69 kB +1.25% 7.35 kB 7.45 kB
oss-experimental/react/cjs/react-jsx-dev-runtime.development.js +1.32% 11.18 kB 11.33 kB +1.28% 3.13 kB 3.17 kB
oss-experimental/react/cjs/react-jsx-runtime.development.js +1.30% 11.38 kB 11.53 kB +1.27% 3.15 kB 3.19 kB
oss-experimental/react/cjs/react-jsx-runtime.react-server.development.js +1.23% 12.00 kB 12.15 kB +1.19% 3.28 kB 3.32 kB
oss-experimental/react/cjs/react-jsx-dev-runtime.react-server.development.js +1.23% 12.01 kB 12.15 kB +1.22% 3.28 kB 3.32 kB
oss-experimental/react/cjs/react.react-server.production.js +1.07% 18.52 kB 18.72 kB +1.02% 4.92 kB 4.97 kB
oss-experimental/react/cjs/react.react-server.development.js +0.74% 35.85 kB 36.12 kB +0.64% 8.48 kB 8.54 kB
oss-experimental/react/cjs/react.production.js +0.72% 17.98 kB 18.11 kB +0.75% 4.66 kB 4.70 kB
oss-experimental/react-reconciler/cjs/react-reconciler-reflection.development.js +0.60% 6.80 kB 6.84 kB +0.78% 1.66 kB 1.67 kB
oss-experimental/react/cjs/react.development.js +0.57% 45.49 kB 45.75 kB +0.52% 10.39 kB 10.45 kB
facebook-www/JSXDEVRuntime-dev.classic.js +0.40% 27.97 kB 28.08 kB +0.52% 6.57 kB 6.60 kB
facebook-www/JSXDEVRuntime-dev.modern.js +0.40% 27.97 kB 28.08 kB +0.52% 6.57 kB 6.60 kB
oss-experimental/react-server/cjs/react-server.production.js +0.38% 121.88 kB 122.34 kB +0.30% 21.41 kB 21.47 kB
oss-experimental/react-server/cjs/react-server.development.js +0.32% 177.04 kB 177.61 kB +0.27% 31.20 kB 31.29 kB
facebook-www/ReactReconciler-prod.modern.js +0.25% 450.36 kB 451.48 kB +0.30% 72.40 kB 72.62 kB
facebook-www/ReactReconciler-prod.classic.js +0.24% 460.69 kB 461.80 kB +0.27% 73.97 kB 74.17 kB
oss-stable-semver/react-reconciler/cjs/react-reconciler.production.js +0.23% 388.99 kB 389.88 kB +0.24% 63.11 kB 63.26 kB
oss-stable/react-reconciler/cjs/react-reconciler.production.js +0.23% 389.02 kB 389.91 kB +0.25% 63.13 kB 63.29 kB
oss-experimental/react-server/cjs/react-server-flight.production.js +0.23% 62.56 kB 62.70 kB +0.43% 12.44 kB 12.49 kB
facebook-www/ReactART-prod.modern.js +0.22% 357.94 kB 358.74 kB +0.27% 59.94 kB 60.10 kB
facebook-www/ReactART-prod.classic.js +0.22% 367.66 kB 368.47 kB +0.22% 61.51 kB 61.65 kB
oss-experimental/react-markup/cjs/react-markup.production.js +0.22% 207.26 kB 207.71 kB +0.20% 38.58 kB 38.66 kB
oss-stable-semver/react-reconciler/cjs/react-reconciler.profiling.js +0.21% 415.14 kB 416.03 kB +0.23% 66.76 kB 66.91 kB
oss-stable/react-reconciler/cjs/react-reconciler.profiling.js +0.21% 415.16 kB 416.05 kB +0.23% 66.79 kB 66.94 kB
oss-experimental/react-server-dom-parcel/cjs/react-server-dom-parcel-client.browser.development.js +0.21% 104.87 kB 105.10 kB +0.28% 19.86 kB 19.92 kB
oss-experimental/react-server-dom-esm/cjs/react-server-dom-esm-client.browser.development.js +0.21% 105.02 kB 105.25 kB +0.30% 20.05 kB 20.11 kB
oss-experimental/react-client/cjs/react-client-flight.development.js +0.21% 106.35 kB 106.57 kB +0.27% 19.78 kB 19.84 kB
oss-experimental/react-server-dom-turbopack/cjs/react-server-dom-turbopack-client.browser.development.js +0.21% 107.21 kB 107.43 kB +0.27% 20.44 kB 20.50 kB
oss-experimental/react-server-dom-webpack/cjs/react-server-dom-webpack-client.browser.development.js +0.21% 107.77 kB 107.99 kB +0.28% 20.57 kB 20.63 kB
oss-experimental/react-server-dom-parcel/cjs/react-server-dom-parcel-client.node.development.js +0.21% 108.09 kB 108.31 kB +0.38% 20.60 kB 20.67 kB
oss-experimental/react-server-dom-esm/cjs/react-server-dom-esm-client.node.development.js +0.21% 109.12 kB 109.35 kB +0.39% 20.74 kB 20.82 kB
oss-experimental/react-dom/cjs/react-dom-server-legacy.browser.production.js +0.20% 218.55 kB 219.00 kB +0.16% 39.27 kB 39.33 kB
oss-experimental/react-server-dom-parcel/cjs/react-server-dom-parcel-client.edge.development.js +0.20% 109.89 kB 110.11 kB +0.38% 20.95 kB 21.03 kB
oss-experimental/react-server-dom-turbopack/cjs/react-server-dom-turbopack-client.node.development.js +0.20% 111.76 kB 111.99 kB +0.38% 21.22 kB 21.30 kB

Generated by 🚫 dangerJS against 2728cb2

@Fausto95
Copy link

Fausto95 commented Jan 4, 2025

Wondering how this will work in RN

@li-jia-nan
Copy link

How can I set the transition to duration?

@sebmarkbage
Copy link
Collaborator Author

sebmarkbage commented Jan 5, 2025

Wondering how this will work in RN

The idea is that this can be implemented on the native side with a form of Shared Element Transitions. It would however likely be a new implementation (as opposed to mapping to Layout Animations or Reanimated) to ensure it lines up semantically with the web's View Transitions model so it's not slightly different on native. I think this would likely only be available on the New Architecture.

The way you style these are a bit up on the air since on web it heavily relies on CSS, but the general gist is that a View Transition class could be registered with Native and you'd specify a name class on the JS side. There will be a programmatic API that can work on RN and web.

Similarly, libraries like react-three-fiber could implement GL based transitions as long as it follows the general model and implements the required config hooks that React exposes.

The idea is that this would be a general purpose View Transition / Shared Element Animation model across platforms. That's why this Component is exposed on react and not just react-dom. That said, this is a ton of additional work, so I wouldn't hold my breath for React Native support any time soon. The more likely approach is that you'd have two forked implementations of animating wrappers between Web and Native to start.

sebmarkbage added a commit that referenced this pull request Jan 6, 2025
…but flush it eagerly if we're sync (#31987)

This is a follow up to #31930 and a prerequisite for #31975.

With View Transitions, the commit phase becomes async which means that
other work can sneak in between. We need to be resilient to that.

This PR first refactors the flushMutationEffects and flushLayoutEffects
to use module scope variables to track its arguments so we can defer
them. It shares these with how we were already doing it for
flushPendingEffects.

We also track how far along the commit phase we are so we know what we
have left to flush.

Then callers of flushPassiveEffects become flushPendingEffects. That
helper synchronously flushes any remaining phases we've yet to commit.
That ensure that things are at least consistent if that happens.

Finally, when we are using a scheduled task, we don't do any work. This
ensures that we're not flushing any work too early if we could've
deferred it. This still ensures that we always do flush it before
starting any new work on any root so new roots observe the committed
state.

There are some unfortunate effects that could happen from allowing
things to flush eagerly. Such as if a flushSync sneaks in before
startViewTransition, it'll skip the animation. If it's during a
suspensey font it'll start the transition before the font has loaded
which might be better than breaking flushSync. It'll also potentially
flush passive effects inside the startViewTransition which should
typically be ok.
We currently use the useId algorithm for this for hydration in case we want
to support animating from server rendered fallback to client rendered content.

It might not be needed though since we only apply the names temporarily.
This will let us know if we have any View Transitions in this subtree that
may run an enter/exit animation. It provides a fast path for finding them
during a placement or deletion.
Only if this is an eligible lane - Transition, Retry or Idle.
Do the same thing as the snapshot phase in reverse.

We could use either the layout phase or passive phase for this. We use the
passive in case this creates any extra work but it might actually be the
reverse if this is work that would've been done anyway before the first
paint. So we could also try this in the layout phase.
…e after mutation phase we can assign the name there

This lets us avoid an extra traversal in the mutation phase.
… name

This lets us find it deep within a deleted or reappearing tree do that
we can connect it with its pair.
…eappearing

We need to know this before we visit the deletions in the snapshot phase so
we know if there is a pair.
That way we'll be able to exclude them if they are not within the viewport.

To do this we need a different mechanisms to detect insertions instead of
Placement effect which was already wrong since it includes moves.
This avoids things flying in, onto, or across the screen unexpectedly.

Unfortunately if it goes from onscreen to offscreen we have no way to cancel
the old state, so that appears as an exit even though it should've just
painted on top of its deleted parent if we had known.
github-actions bot pushed a commit that referenced this pull request Jan 6, 2025
…but flush it eagerly if we're sync (#31987)

This is a follow up to #31930 and a prerequisite for #31975.

With View Transitions, the commit phase becomes async which means that
other work can sneak in between. We need to be resilient to that.

This PR first refactors the flushMutationEffects and flushLayoutEffects
to use module scope variables to track its arguments so we can defer
them. It shares these with how we were already doing it for
flushPendingEffects.

We also track how far along the commit phase we are so we know what we
have left to flush.

Then callers of flushPassiveEffects become flushPendingEffects. That
helper synchronously flushes any remaining phases we've yet to commit.
That ensure that things are at least consistent if that happens.

Finally, when we are using a scheduled task, we don't do any work. This
ensures that we're not flushing any work too early if we could've
deferred it. This still ensures that we always do flush it before
starting any new work on any root so new roots observe the committed
state.

There are some unfortunate effects that could happen from allowing
things to flush eagerly. Such as if a flushSync sneaks in before
startViewTransition, it'll skip the animation. If it's during a
suspensey font it'll start the transition before the font has loaded
which might be better than breaking flushSync. It'll also potentially
flush passive effects inside the startViewTransition which should
typically be ok.

DiffTrain build for [defffdb](defffdb)
github-actions bot pushed a commit that referenced this pull request Jan 6, 2025
…but flush it eagerly if we're sync (#31987)

This is a follow up to #31930 and a prerequisite for #31975.

With View Transitions, the commit phase becomes async which means that
other work can sneak in between. We need to be resilient to that.

This PR first refactors the flushMutationEffects and flushLayoutEffects
to use module scope variables to track its arguments so we can defer
them. It shares these with how we were already doing it for
flushPendingEffects.

We also track how far along the commit phase we are so we know what we
have left to flush.

Then callers of flushPassiveEffects become flushPendingEffects. That
helper synchronously flushes any remaining phases we've yet to commit.
That ensure that things are at least consistent if that happens.

Finally, when we are using a scheduled task, we don't do any work. This
ensures that we're not flushing any work too early if we could've
deferred it. This still ensures that we always do flush it before
starting any new work on any root so new roots observe the committed
state.

There are some unfortunate effects that could happen from allowing
things to flush eagerly. Such as if a flushSync sneaks in before
startViewTransition, it'll skip the animation. If it's during a
suspensey font it'll start the transition before the font has loaded
which might be better than breaking flushSync. It'll also potentially
flush passive effects inside the startViewTransition which should
typically be ok.

DiffTrain build for [defffdb](defffdb)
github-actions bot pushed a commit to code/lib-react that referenced this pull request Jan 6, 2025
…but flush it eagerly if we're sync (facebook#31987)

This is a follow up to facebook#31930 and a prerequisite for facebook#31975.

With View Transitions, the commit phase becomes async which means that
other work can sneak in between. We need to be resilient to that.

This PR first refactors the flushMutationEffects and flushLayoutEffects
to use module scope variables to track its arguments so we can defer
them. It shares these with how we were already doing it for
flushPendingEffects.

We also track how far along the commit phase we are so we know what we
have left to flush.

Then callers of flushPassiveEffects become flushPendingEffects. That
helper synchronously flushes any remaining phases we've yet to commit.
That ensure that things are at least consistent if that happens.

Finally, when we are using a scheduled task, we don't do any work. This
ensures that we're not flushing any work too early if we could've
deferred it. This still ensures that we always do flush it before
starting any new work on any root so new roots observe the committed
state.

There are some unfortunate effects that could happen from allowing
things to flush eagerly. Such as if a flushSync sneaks in before
startViewTransition, it'll skip the animation. If it's during a
suspensey font it'll start the transition before the font has loaded
which might be better than breaking flushSync. It'll also potentially
flush passive effects inside the startViewTransition which should
typically be ok.

DiffTrain build for [defffdb](facebook@defffdb)
github-actions bot pushed a commit to code/lib-react that referenced this pull request Jan 6, 2025
…but flush it eagerly if we're sync (facebook#31987)

This is a follow up to facebook#31930 and a prerequisite for facebook#31975.

With View Transitions, the commit phase becomes async which means that
other work can sneak in between. We need to be resilient to that.

This PR first refactors the flushMutationEffects and flushLayoutEffects
to use module scope variables to track its arguments so we can defer
them. It shares these with how we were already doing it for
flushPendingEffects.

We also track how far along the commit phase we are so we know what we
have left to flush.

Then callers of flushPassiveEffects become flushPendingEffects. That
helper synchronously flushes any remaining phases we've yet to commit.
That ensure that things are at least consistent if that happens.

Finally, when we are using a scheduled task, we don't do any work. This
ensures that we're not flushing any work too early if we could've
deferred it. This still ensures that we always do flush it before
starting any new work on any root so new roots observe the committed
state.

There are some unfortunate effects that could happen from allowing
things to flush eagerly. Such as if a flushSync sneaks in before
startViewTransition, it'll skip the animation. If it's during a
suspensey font it'll start the transition before the font has loaded
which might be better than breaking flushSync. It'll also potentially
flush passive effects inside the startViewTransition which should
typically be ok.

DiffTrain build for [defffdb](facebook@defffdb)
Co-authored-by: Sebastian "Sebbie" Silbermann <[email protected]>
We were reading from the wrong fiber.

Update the fixture to show that the document and the button remains interactive
due to the inner boundary not resizing.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed React Core Team Opened by a member of the React Core Team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants