View Transitions Router API Reference

Добавлено в: astro@3.0.0

These modules provide functions to control and interact with the View Transitions API and client-side router.

For features and usage examples, see our View Transitions guide.

Imports from `astro:transitions`

import {
  ClientRouter,
  fade,
  slide,
} from 'astro:transitions';

`<ClientRouter />`

Добавлено в: astro@5.0.0

Opt in to using view transitions on individual pages by importing and adding the <ClientRouter /> routing component to <head> on every desired page.

---
import { ClientRouter } from 'astro:transitions';
---
<html lang="en">
  <head>
    <title>My Homepage</title>
    <ClientRouter />
  </head>
  <body>
    <h1>Welcome to my website!</h1>
  </body>
</html>

See more about how to control the router and add transition directives to page elements and components.

The <ClientRouter /> component accepts the following props:

`fallback`

Type: Fallback
Default: animate

Defines the fallback strategy to use for browsers that do not support the View Transitions API.

`fade`

Type: (opts: { duration?: string | number }) => TransitionDirectionalAnimations

Добавлено в: astro@3.0.0

Utility function to support customizing the duration of the built-in fade animation.

---
import { fade } from 'astro:transitions';
---

<!-- Fade transition with the default duration -->
<div transition:animate="fade" />

<!-- Fade transition with a duration of 400 milliseconds -->
<div transition:animate={fade({ duration: '0.4s' })} />

`slide`

Type: (opts: { duration?: string | number }) => TransitionDirectionalAnimations

Добавлено в: astro@3.0.0

Utility function to support customizing the duration of the built-in slide animation.

---
import { slide } from 'astro:transitions';
---

<!-- Slide transition with the default duration -->
<div transition:animate="slide" />

<!-- Slide transition with a duration of 400 milliseconds -->
<div transition:animate={slide({ duration: '0.4s' })} />

Imports from `astro:transitions/client`

import {
  getFallback,
  navigate,
  supportsViewTransitions,
  swapFunctions,
  transitionEnabledOnThisPage,
  /* The following are scheduled for deprecation in v6: */
  isTransitionBeforePreparationEvent,
  isTransitionBeforeSwapEvent,
  TRANSITION_AFTER_PREPARATION,
  TRANSITION_AFTER_SWAP,
  TRANSITION_BEFORE_PREPARATION,
  TRANSITION_BEFORE_SWAP,
  TRANSITION_PAGE_LOAD,
} from 'astro:transitions/client';

`navigate()`

Type: (href: string, options?: Options) => void

Добавлено в: astro@3.2.0

Executes a navigation to the given href using the View Transitions API.

This function signature is based on the navigate function from the browser Navigation API. Although based on the Navigation API, this function is implemented on top of the History API to allow for navigation without reloading the page.

navigate() does not perform sanitization on the href parameter. Sanitize user input if you use it to determine the URL to navigate to.

`history` option

Type: 'auto' | 'push' | 'replace'
Default: 'auto'

Добавлено в: astro@3.2.0

Defines how this navigation should be added to the browser history.

'push': the router will use history.pushState to create a new entry in the browser history.
'replace': the router will use history.replaceState to update the URL without adding a new entry into navigation.
'auto' (default): the router will attempt history.pushState, but if the URL cannot be transitioned to, the current URL will remain with no changes to the browser history.

This option follows the history option from the browser Navigation API but simplified for the cases that can happen on an Astro project.

`formData` option

Type: FormData

Добавлено в: astro@3.5.0

A FormData object for POST requests.

When this option is provided, the requests to the navigation target page will be sent as a POST request with the form data object as the content.

Submitting an HTML form with view transitions enabled will use this method instead of the default navigation with page reload. Calling this method allows triggering the same behavior programmatically.

`info` option

Type: any

Добавлено в: astro@3.6.0

Arbitrary data to be included in the astro:before-preparation and astro:before-swap events caused by this navigation.

This option mimics the info option from the browser Navigation API.

`state` option

Type: any

Добавлено в: astro@3.6.0

Arbitrary data to be associated with the NavigationHistoryEntry object created by this navigation. This data can then be retrieved using the history.getState function from the History API.

This option mimics the state option from the browser Navigation API.

`sourceElement` option

Type: Element

Добавлено в: astro@3.6.0

The element that triggered this navigation, if any. This element will be available in the following events:

astro:before-preparation
astro:before-swap

`supportsViewTransitions`

Type: boolean

Добавлено в: astro@3.2.0

Whether or not view transitions are supported and enabled in the current browser.

`transitionEnabledOnThisPage()`

Type: () => boolean

Добавлено в: astro@3.2.0

Whether or not the current page has view transitions enabled for client-side navigation. This can be used to make components that behave differently when they are used on pages with view transitions.

`getFallback()`

Type: () => Fallback
Default: animate

Добавлено в: astro@3.6.0

Returns the fallback strategy to use (animate by default) in browsers that do not support view transitions.

See the guide on Fallback control for how to choose and configure the fallback behavior.

`swapFunctions`

Type: object

Добавлено в: astro@4.15.0

An object containing the utility functions used to build Astro’s default swap function. These can be useful when building a custom swap function.

swapFunctions provides the following methods:

`deselectScripts()`

Type: (newDocument: Document) => void

Marks scripts in the new document that should not be executed. Those scripts are already in the current document and are not flagged for re-execution using data-astro-rerun.

`swapRootAttributes()`

Type: (newDocument: Document) => void

Swaps the attributes between the document roots, like the lang attribute. This also includes Astro-injected internal attributes like data-astro-transition, which makes the transition direction available to Astro-generated CSS rules.

When making a custom swap function, it is important to call this function so as not to break the view transition’s animations.

`swapHeadElements()`

Type: (newDocument: Document) => void

Removes every element from the current document’s <head> that is not persisted to the new document. Then appends all new elements from the new document’s <head> to the current document’s <head>.

`saveFocus()`

Type: () => () => void

Stores the element in focus on the current page and returns a function that when called, if the focused element was persisted, returns the focus to it.

`swapBodyElement()`

Type: (newBody: Element, oldBody: Element) => void

Replaces the old body with the new body. Then, goes through every element in the old body that should be persisted and have a matching element in the new body and swaps the old element back in place.

Deprecated imports

The following imports are scheduled for deprecation in v6. You can still use them in your project, but you may prefer to update your code now.

`isTransitionBeforePreparationEvent()`

Type: (value: any) => boolean

Добавлено в: astro@3.6.0

Determines whether the given value matches a TransitionBeforePreparationEvent. This can be useful when you need to narrow the type of an event in an event listener.

---
---

<script>
  import {
    isTransitionBeforePreparationEvent,
    TRANSITION_BEFORE_PREPARATION,
  } from "astro:transitions/client";

  function listener(event: Event) {
    const setting = isTransitionBeforePreparationEvent(event) ? 1 : 2;
    /* do something with setting */
  }

  document.addEventListener(TRANSITION_BEFORE_PREPARATION, listener);
</script>

`isTransitionBeforeSwapEvent()`

Type: (value: any) => boolean

Добавлено в: astro@3.6.0

Determines whether the given value matches a TransitionBeforeSwapEvent. This can be useful when you need to narrow the type of an event in an event listener.

---
---

<script>
  import {
    isTransitionBeforeSwapEvent,
    TRANSITION_BEFORE_SWAP,
  } from "astro:transitions/client";

  function listener(event: Event) {
    const setting = isTransitionBeforeSwapEvent(event) ? 1 : 2;
    /* do something with setting */
  }

  document.addEventListener(TRANSITION_BEFORE_SWAP, listener);
</script>

`TRANSITION_BEFORE_PREPARATION`

Type: 'astro:before-preparation'

Добавлено в: astro@3.6.0

A constant to avoid writing the astro:before-preparation event name in plain text when you define an event.

---
---

<script>
  import { TRANSITION_BEFORE_PREPARATION } from "astro:transitions/client";

  document.addEventListener(TRANSITION_BEFORE_PREPARATION, () => {
    /* the listener logic */
  });
</script>

`TRANSITION_AFTER_PREPARATION`

Type: 'astro:after-preparation'

Добавлено в: astro@3.6.0

A constant to avoid writing the astro:after-preparation event name in plain text when you define an event.

---
---

<script>
  import { TRANSITION_AFTER_PREPARATION } from "astro:transitions/client";

  document.addEventListener(TRANSITION_AFTER_PREPARATION, () => {
    /* the listener logic */
  });
</script>

`TRANSITION_BEFORE_SWAP`

Type: 'astro:before-swap'

Добавлено в: astro@3.6.0

A constant to avoid writing the astro:before-swap event name in plain text when you define an event.

---
---

<script>
  import { TRANSITION_BEFORE_SWAP } from "astro:transitions/client";

  document.addEventListener(TRANSITION_BEFORE_SWAP, () => {
    /* the listener logic */
  });
</script>

`TRANSITION_AFTER_SWAP`

Type: 'astro:after-swap'

Добавлено в: astro@3.6.0

A constant to avoid writing the astro:after-swap event name in plain text when you define an event.

---
---

<script>
  import { TRANSITION_AFTER_SWAP } from "astro:transitions/client";

  document.addEventListener(TRANSITION_AFTER_SWAP, () => {
    /* the listener logic */
  });
</script>

`TRANSITION_PAGE_LOAD`

Type: 'astro:page-load'

Добавлено в: astro@3.6.0

A constant to avoid writing the astro:page-load event name in plain text when you define an event.

---
---

<script>
  import { TRANSITION_PAGE_LOAD } from "astro:transitions/client";

  document.addEventListener(TRANSITION_PAGE_LOAD, () => {
    /* the listener logic */
  });
</script>

`astro:transitions/client` types

import type {
  Direction,
  Fallback,
  NavigationTypeString,
  Options,
  TransitionBeforePreparationEvent,
  TransitionBeforeSwapEvent,
} from 'astro:transitions/client';

`Direction`

Type: 'forward' | 'back'

Добавлено в: astro@3.2.0

A union of animation directions:

forward: navigating to the next page in the history or to a new page.
back: navigating to the previous page in the history.

`Fallback`

Type: 'none' | 'animate' | 'swap'

Добавлено в: astro@3.2.0

A union of fallback strategies to use in browsers that do not support view transitions:

animate: Astro will simulate view transitions using custom attributes before updating page content.
swap: Astro will not attempt to animate the page. Instead, the old page will be immediately replaced by the new one.
none: Astro will not do any animated page transitions at all. Instead, you will get full page navigation in non-supporting browsers.

Learn more about controlling the fallback strategy with the ClientRouter.

`NavigationTypeString`

Type: 'push' | 'replace' | 'traverse'

Добавлено в: astro@3.6.0

A union of supported history navigation events.

`TransitionBeforePreparationEvent`

Type: Event

Добавлено в: astro@3.6.0

Represents an astro:before-preparation event. This can be useful to type the event received by a listener:

---
---

<script>
  import {
    TRANSITION_BEFORE_PREPARATION,
    type TransitionBeforePreparationEvent
  } from "astro:transitions/client";

  function listener(event: TransitionBeforePreparationEvent) {
    /* do something */
  }

  document.addEventListener(TRANSITION_BEFORE_PREPARATION, listener);
</script>

`TransitionBeforeSwapEvent`

Type: Event

Добавлено в: astro@3.6.0

Represents an astro:before-swap event. This can be useful to type the event received by a listener:

---
---

<script>
  import {
    TRANSITION_BEFORE_SWAP,
    type TransitionBeforeSwapEvent
  } from "astro:transitions/client";

  function listener(event: TransitionBeforeSwapEvent) {
    /* do something */
  }

  document.addEventListener(TRANSITION_BEFORE_SWAP, listener);
</script>

Lifecycle events

`astro:before-preparation` event

Type: TransitionBeforePreparationEvent

Добавлено в: astro@3.6.0

An event dispatched at the beginning of a navigation using the View Transitions router. This event happens before any request is made and any browser state is changed.

This event has the attributes:

info
sourceElement
navigationType
direction
from
to
formData
loader()

Read more about how to use this event on the View Transitions guide.

`astro:after-preparation` event

Type: Event

Добавлено в: astro@3.6.0

An event dispatched after the next page in a navigation using View Transitions router is loaded.

This event has no attributes.

Read more about how to use this event on the View Transitions guide.

`astro:before-swap` event

Type: TransitionBeforeSwapEvent

Добавлено в: astro@3.6.0

An event dispatched after the next page is parsed, prepared, and linked into a document in preparation for the transition but before any content is swapped between the documents.

This event can’t be canceled. Calling preventDefault() is a no-op.

This event has the attributes:

info
sourceElement
navigationType
direction
from
to
viewTransition
swap()

Read more about how to use this event on the View Transitions guide.

`astro:after-swap` event

Type: Event

An event dispatched after the contents of the page have been swapped but before the view transition ends.

The history entry and scroll position have already been updated when this event is triggered.

`astro:page-load` event

Type: Event

An event dispatched after a page completes loading, whether from a navigation using view transitions or native to the browser.

When view transitions is enabled on the page, code that would normally execute on DOMContentLoaded should be changed to execute on this event.

Lifecycle events attributes

Добавлено в: astro@3.6.0

The following attributes are common to both the astro:before-preparation and astro:before-swap events, except for some that are only available with one or the other.

`info`

Type: any

Arbitrary data defined during navigation.

This is the literal value passed on the info option of the navigate() function.

`sourceElement`

Type: Element | undefined

The element that triggered the navigation. This can be, for example, an <a> element that was clicked.

When using the navigate() function, this will be the element specified in the call.

`newDocument`

Type: Document

The document for the next page in the navigation. The contents of this document will be swapped in place of the contents of the current document.

`navigationType`

Type: NavigationTypeString

Which kind of history navigation is happening.

push: a new NavigationHistoryEntry is being created for the new page.
replace: the current NavigationHistoryEntry is being replaced with an entry for the new page.
traverse: no NavigationHistoryEntry is created. The position in the history is changing. The direction of the traversal is given on the direction attribute.

`direction`

Type: string

The direction of the transition:

In an astro:before-preparation event, this can be used to define custom directions. The property is writable and accepts any string.
In an astro:before-swap event, this can be used to retrieve the transition direction. The property is readonly and its value can be a predefined Direction or any string that an astro:before-preparation event listener might have set.

`from`

Type: URL

The URL of the page initiating the navigation.

`to`

Type: URL

The URL of the page being navigated to. This property can be modified, the value at the end of the lifecycle will be used in the NavigationHistoryEntry for the next page.

`formData`

Type: FormData | undefined
Available in: astro:before-preparation event

When set, a POST request will be sent to the to URL with the given FormData object as the content instead of the normal GET request.

When submitting an HTML form with view transitions enabled, this field is automatically set to the data in the form. When using the navigate() function, this value is the same as given in the options.

`loader()`

Type: () => Promise<void>
Available in: astro:before-preparation event

Implementation of the following phase in the navigation (loading the next page). This implementation can be overridden to add extra behavior.

`viewTransition`

Type: ViewTransition
Available in: astro:before-swap event

The view transition object used in this navigation. On browsers that do not support the View Transitions API, this is an object implementing the same API for convenience but without the DOM integration.

`swap()`

Type: () => void
Available in: astro:before-swap event

Calls the default document swap logic. By default, this implementation will call the following functions in order:

deselectScripts()
swapRootAttributes()
swapHeadElements()
saveFocus()
swapBodyElement()

Read more about building a custom swap function in the View Transitions guide.

View Transitions Router API Reference

Imports from astro:transitions

<ClientRouter />

fallback

fade

slide

Imports from astro:transitions/client

navigate()

history option

formData option

info option

state option

sourceElement option

supportsViewTransitions

transitionEnabledOnThisPage()

getFallback()

swapFunctions

deselectScripts()

swapRootAttributes()

swapHeadElements()

saveFocus()

swapBodyElement()

Deprecated imports

isTransitionBeforePreparationEvent()

isTransitionBeforeSwapEvent()

TRANSITION_BEFORE_PREPARATION

TRANSITION_AFTER_PREPARATION

TRANSITION_BEFORE_SWAP

TRANSITION_AFTER_SWAP

TRANSITION_PAGE_LOAD

astro:transitions/client types

Direction

Fallback

NavigationTypeString

TransitionBeforePreparationEvent

TransitionBeforeSwapEvent

Lifecycle events

astro:before-preparation event

astro:after-preparation event

astro:before-swap event

astro:after-swap event

astro:page-load event

Lifecycle events attributes

info

sourceElement

newDocument

navigationType

direction

from

to

formData

loader()

viewTransition

swap()

Imports from `astro:transitions`

`<ClientRouter />`

`fallback`

`fade`

`slide`

Imports from `astro:transitions/client`

`navigate()`

`history` option

`formData` option

`info` option

`state` option

`sourceElement` option

`supportsViewTransitions`

`transitionEnabledOnThisPage()`

`getFallback()`

`swapFunctions`

`deselectScripts()`

`swapRootAttributes()`

`swapHeadElements()`

`saveFocus()`

`swapBodyElement()`

`isTransitionBeforePreparationEvent()`

`isTransitionBeforeSwapEvent()`

`TRANSITION_BEFORE_PREPARATION`

`TRANSITION_AFTER_PREPARATION`

`TRANSITION_BEFORE_SWAP`

`TRANSITION_AFTER_SWAP`

`TRANSITION_PAGE_LOAD`

`astro:transitions/client` types

`Direction`

`Fallback`

`NavigationTypeString`

`TransitionBeforePreparationEvent`

`TransitionBeforeSwapEvent`

`astro:before-preparation` event

`astro:after-preparation` event

`astro:before-swap` event

`astro:after-swap` event

`astro:page-load` event

`info`

`sourceElement`

`newDocument`

`navigationType`

`direction`

`from`

`to`

`formData`

`loader()`

`viewTransition`

`swap()`