Skip to main content

ViewTransition

Check out the official React docs!

For more detailed information about React concepts and APIs, please refer to the official documentation for ViewTransition.


note

Requires React 19.3 or later. Browsers without the View Transition API update the UI without animating.

React.ViewTransition animates its children with the browser's View Transition API when they enter, exit or change. It only animates updates that happen in a transition: startTransition, useDeferredValue or a Suspense reveal. Plain setState calls don't animate.

Without properties, it uses the browser's default cross-fade:

React.ViewTransition [ Html.div [ prop.text "Cross-fades when it changes" ] ]

Properties​

Configure it with the viewTransition properties:

PropertyWhen it animates
viewTransition.enterThe boundary is inserted.
viewTransition.exitThe boundary is removed.
viewTransition.updateDOM inside the boundary changes, or its size or position changes.
viewTransition.shareA boundary with the same name unmounts and another one mounts (shared element transition).
viewTransition.default'Every trigger that isn't set explicitly.
viewTransition.nameNames the boundary for shared element transitions. Each name must only be mounted once at a time.

Each animation value is "auto" (the browser's cross-fade), "none" (no animation) or a CSS class name. React adds the class to the view transition, and you animate it with the ::view-transition-old(.class) and ::view-transition-new(.class) pseudo-elements:

::view-transition-old(.feliz-slide) { animation: 250ms ease-in both feliz-slide-out; }
::view-transition-new(.feliz-slide) { animation: 250ms ease-out both feliz-slide-in; }
React.ViewTransition [
viewTransition.update "feliz-slide"
viewTransition.children [ Html.h3 fruits[index] ]
]

Apple

Show code
module Example.ViewTransition

open Feliz

/// React adds the class to the view transition; the `::view-transition-*` pseudo-elements animate it.
let private css =
"""
::view-transition-old(.feliz-slide) { animation: 250ms ease-in both feliz-slide-out; }
::view-transition-new(.feliz-slide) { animation: 250ms ease-out both feliz-slide-in; }
@keyframes feliz-slide-out { to { opacity: 0; transform: translateX(-40px); } }
@keyframes feliz-slide-in { from { opacity: 0; transform: translateX(40px); } }
"""

let private fruits = [| "Apple"; "Banana"; "Cherry"; "Date" |]

[<ReactComponent(true)>]
let ViewTransition () =
let index, setIndex = React.useState 0

Html.div [
Html.style [ prop.text css ]
Html.button [
// Only updates inside a transition animate.
prop.onClick (fun _ -> React.startTransition (fun () -> setIndex ((index + 1) % fruits.Length)))
prop.text "Next fruit"
]
React.ViewTransition [
viewTransition.update "feliz-slide"
viewTransition.children [
Html.h3 [ prop.style [ style.display.inlineBlock ]; prop.text fruits[index] ]
]
]
]

enter and exit only trigger when the ViewTransition comes before any DOM element in its subtree, i.e. it wraps the DOM elements directly.

Choosing an animation by transition type​

Instead of a single class, every animation property also accepts a list of transitionType, value pairs. The types come from React.addTransitionType; a "default" entry is used when no type matches.

viewTransition.update [ "forward", "slide-left"; "backward", "slide-right"; "default", "none" ]

Event callbacks​

viewTransition.onEnter, onExit, onUpdate and onShare are called when the corresponding animation starts. They receive a ViewTransitionInstance (with the old, new, group and imagePair pseudo-elements) and the transition types. Use them to run animations from code, and return a cleanup function that cancels them:

viewTransition.onEnter (fun instance types ->
let animation =
instance.``new``.animate (
[| createObj [ "opacity" ==> 0 ]; createObj [ "opacity" ==> 1 ] |],
createObj [ "duration" ==> 300 ]
)

fun () -> animation?cancel ())

Only one callback fires per ViewTransition per transition; onShare takes precedence over onEnter and onExit.