Skip to content

Last updated: First published:

View Transition API Details

The reference section lists several good sources of information. The most detailed, accurate and exhausting to read are the drafts of the specs.

Two Leveled Spec

The View Transition API comes in two levels: Level 1 specifies same-document transitions and level 2 defines cross-document transitions.

Level 1 / Same Document Transitions

The View Transition API (Level 1) consists of a single function and a single CSS property: These are the types that are introduced by the View Transition API:

dom-view-transition.d.ts (Level 1)
1
// The view-transition-name CSS property
2
interface CSSStyleDeclaration {
3
viewTransitionName: string;
4
}
5
6
// The startViewTransition() function provided by window.document
7
type UpdateCallback = () => Promise<void> | void
8
interface Document {
9
startViewTransition(updateCallback: UpdateCallback): ViewTransition;
10
}
11
12
// The result type of calling window.document.startViewTransition()
13
interface ViewTransition {
14
finished: Promise<void>;
15
ready: Promise<void>;
16
updateCallbackDone: Promise<void>;
17
skipTransition(): void;
18
}

In CSS you can use the following pseudo elements to address the animations.

CSS Pseudo Elements (Level 1)
1
::view-transition,
2
::view-transition-group(*),
3
::view-transition-image-pair(*),
4
::view-transition-old(*),
5
::view-transition-new(*)

All but ::view-transition are parametrized with a view transition name (or * for all).

Level 2 / Cross Document Transitions

The level 2 spec adds a new property and extends the signature of the startViewTransition() function

Extensions added by the level 2 API
1
// As of level 1 plus the following
2
3
// The view-transition-class CSS property
4
interface CSSStyleDeclaration {
5
viewTransitionClass: string;
6
}
7
8
// Extended signature for startViewTransition()
9
type StartViewTransitionOptions = {
10
update?: UpdateCallback,
11
types?: sting[]
12
}
13
interface Document {
14
startViewTransition(param: UpdateCallback | StartViewTransitionOptions): ViewTransition;
15
}
16
// The result type of calling startViewTransition() also got types added
17
interface ViewTransition {
18
finished: Promise<void>;
19
ready: Promise<void>;
20
updateCallbackDone: Promise<void>;
21
types: string[];
22
skipTransition(): void;
23
}
24
// Not really part of the View Transition API, but closely related:
25
26
// There are also two events that are raised during cross-document navigation:
27
28
"pageswap" // An event that is raised while the old document is still present.
29
// This happens right before the screenshot and the swap
30
31
"pagereveal" // An event that happens after the swap right before the new page is
32
// shown for the first time
33
34
// The browser also triggers these events independently of view transitions.
35
// However, if they are triggered during a cross-document view transition,
36
// the `viewTransition` property of the event contain the current view transition object.
37
// In addition, the `pageswap` event also has an `activation` property
38
// that describes the type of navigation including source and target URLs.

On the CSS side, the pseudo-elements are unchanged, but now you can also use view transition classes to select animations in addition to * and view transition names.

use view transition classes (Level 2)
1
::view-transition-new(k3.slow), /* view-transition-name "k3" if class is ".slow" */
2
::view-transition-old(.slow .headers) { /* all classes must match */
3
animation-duration: 2s;
4
}

Level 2 also defines two CSS pseudo-classes on the document that can be used to select based on the existence and type of the active view transition

use transition types (Level2)
1
:root:active-view-transition,
2
:root:active-view-transition-type(backward, slide-out) { /* at least one must match */
3
4
}

Also new in level 2 is the ability to make one transition group a child of another transition group setting the view-transition-group property:

assign a parent to a transition group
1
main {
2
view-transition-name: main;
3
view-transition-group: clipper;
4
}

And level 2 defines a new at-rule that can be used to specify whether a page should participate in automatic cross-document view transitions and in what form.

Opt in to cross-document transitions (Level2)
1
@view-transition {
2
navigation: auto; /* can be 'auto' or 'none' */
3
types: backward; /* can be one or several custom-ident values or 'none' */
4
}

View from the Outside

The startViewTransition() function returns immediately yielding an object with three promises, updateCallbackDone, ready, and finished, and a function called skipTransition(). The returned promises can be used to trigger actions that depend on the progress of the view transition process. The skipTransition() function lets you skip the visual animations.

In case of a cross-document transition, startViewTransition() is implicitly called by the browser with an update callback that swaps in the DOM for the new page. The types property of the option Object is initialized with the types of the @view-transition at-rule, if specified. The resulting ViewTransition object can be accessed via the viewTransition property of the new pageswap and pagereveal events.

Here is a high-level description of what is going on and how that can be observed from the out side using the promises:

Pending-capture: First, startViewTransition() saves old-images of all HTML elements that have a view-transition-name CSS property. By default this is only the <html> root element of your document, which is automatically named root.

The function then runs the update callback to transform the current document into a new version.

Update-callback-called: You can react to the end of the update with the updateCallbackDone promise. The update callback even runs when errors occurred in the capture phase. The basic idea here is that the update of the document is a mandatory part of view transition, while the visual animation is a nice add-on.

After that, new-images are drawn above the old images and a tree of ::view-transition pseudo elements is created. When all is set up, the ready promise fulfills.

Animating: Insertion of the pseudo elements into the DOM triggers animations that fade out the old-images and fade in the new-images. For each pair of elements with the same view transition name in the old and in the new version of the DOM, there is an additional animation that moves the image pair from the old position and size to the new position and size.1 All animations happen at the same time in parallel.

Done: When all those animations completed, the finished promise fulfills.

If you call viewTransition.skipTransition() this aborts the animation part, but not the document update.

Detailed Interior View

This is a more elaborated description of what the startViewTransitions() function does. I tried to keep the abstraction somewhere between the high-level view and the very detailed view given in the spec.

  1. In the capture phase, the browser saves a bitmap of the current state for each HTML element that has a view-transition-name CSS property. This can later be addressed using the ::view-transition-old(<name>) pseudo element. Together with the image data, further CSS properties are recorded1.

    For the captures, elements are ordered from bottom to top starting at the lowest z-index. While capturing an image, other elements of “higher” images are not painted and thus the capture shows the element’s background in these areas.

    All view-transition-name values used in the document must be unique. Otherwise the view transition is aborted (after calling the update callback, see next step).

  2. If an update callback is provided, the browser updates the document by starting and awaiting that callback. The viewTransition.updateCallbackDone promise reflects the execution of the callback. If no callback was provided, the updateCallbackDone promise fulfils immediately.

    Even though update callback can be an asynchronous function, browsers typically time-out after a few seconds if the promise does not settle in time. Chrome for example throws a TimeoutError after 4 seconds. For this reason all time consuming preparations, like loading a new DOM over the network, should be executed before calling startViewTransition().

    The promise might resolve or reject. If it rejects, the ready and the finished promises also reject and the whole view transition is aborted.

    Before the update callback runs, rendering is blocked in the browser until ready settles. The view is frozen. Another good reason to hurry up during the execution of the update callback.

  3. View transition processing then generates a new stacking context called the view transition layer that sits above all HTML content on the new page.

    The bitmaps from step 1 are placed in that new layer. Position and saved CSS properties, most notably size and transformations, are those of the original elements from which they were screen-shotted.

  4. The next step now identifies elements with view transition names in the now updated document and places images for those elements in the view transition layer that was generated in the previous step. If the elements have view transition names that already appeared on the previous page, they are positioned and transformed to exactly cover the corresponding images added in the previous step. Otherwise position, size and CSS properties are those of the elements from the new document. The new images can be addressed by the ::view-transition-new(<name>) pseudo element.

    It might be worth noting, that not the new elements are placed in the view transition layer but only their images as replaced elements.

  5. For each view transition name (other than none) found in the previous or updated state of the document, the browser generates a ::view-transition-image-pair(<name>) pseudo element that becomes the direct parent of ::view-transition-old(<name>) and ::view-transition-new(<name>). As not necessarily both images might exist for a given view transition name, the ::view-transition-image-pair(<name>) has one or two children.

    For each ::view-transition-image-pair(<name>) a ::view-transition-group(<name>) pseudo element is created as the direct parent. All ::view-transition-group(<name>) are children of a global ::view-transition pseudo element.

    Groups that only have an old image form exit animations, groups that only have a new image form an entry animation. The CSS pseudo classes :only-child / :not(:only-child) can be used to detect that situation and alter animations accordingly.

    By default, the browser uses a fade-out animation for each old image and a fade-in animation for each new image. For each ::view-transition-group(<name>) with two images, the browser dynamically generates an animation that transitions both images from the old position and saved CSS properties to the new position and current properties. These animations are sometimes called morph or group animations.

  6. Now the ::view-transition pseudo element is inserted at the documents <html> element, rendering is unblocked again, and the viewTransition.ready promise fulfills. The occurrence of the ::view-transition pseudo element with all its children triggers the view transition animations, which now all run in parallel. The hierarchy of pseudo elements only exists during the animation phase of the view transition.

    The ready promise may be used to start custom JavaScript animations, e.g. using the Animation API, GSAP, Anime.js and the like.

    Render order is back to front. For pairs with two children, the new image is drawn in front of the old image. Entry animations are drawn in front of the other animations.

    With their corresponding new images in the view transition layer, elements with view transition names will be exempt from drawing when the current DOM is rendered, leaving holes there as if the elements were styled with visibility: hidden. During the animation, the new images will transition to the holes and close the gaps.

  7. When all view transition animations come to an end, the ::view-transition pseudo element with all its children is removed again, the viewTransition.finished promise fulfills, and the view transition ends.

Footnotes

  1. The CSS properties saved together with the image data include, width, height, transform, backdrop-filter and others. For details see https://drafts.csswg.org/css-view-transitions/#style-transition-pseudo-elements-algorithm 2