@domchristie/turn

v3.1.1

Published

8 months ago

Animate page transitions in Turbo Drive apps.

Downloads

1,017

0High
0Medium
0Low

domchristie

hotwire turbo animations

Turn

Animate page transitions in Turbo Drive apps.

Installation

Install @hotwired/turbo, then

npm install @domchristie/turn

Usage

Include Turbo, dist/turn.js and dist/turn.css however you build your JavaScript & CSS
Add data-turn-enter and data-turn-exit to the elements you wish to animate (optional if you're only using View Transitions)
import Turn from '@domchristie/turn' and call Turn.start() in your application JavaScript
Navigate between pages … ✨

Customizing Animations

Turn adds turn-before-exit, turn-exit, and turn-enter classes to the HTML element at the appropriate times. Apply your own animations by scoping your animation rules with this selector. For example:

html.turn-advance.turn-exit [data-turn-exit] {
  animation-name: MY_ANIMATE_OUT;
  animation-duration: .3s;
  animation-fill-mode: forwards;
}

html.turn-advance.turn-enter [data-turn-enter] {
  animation-name: MY_ANIMATE_IN;
  animation-duration: .6s;
  animation-fill-mode: forwards;
}

@keyframes MY_ANIMATE_OUT {
  …
}

@keyframes MY_ANIMATE_IN {
  …
}

This is how turn.css is organized, so you may want to get rid of that file altogether. animation-fill-mode: forwards is recommended to prevent your transitions from jumping back.

Custom Class Names

The values set in the data-turn-exit and data-turn-enter attributes will be applied as class names to that element. This lets you customize animations for each element. Styles should still be scoped by html.turn-exit and html.turn-enter.

Class List

The following class names are added to the HTML element at various time during a navigation lifecycle.

`turn-view-transitions`

Added on start if the device supports View Transitions, and View Transitions are enabled.

`turn-no-view-transitions`

Added on start if the device does not support View Transitions, or View Transitions are disabled.

`turn-advance`

Added when a visit starts and the action is advance. You'll probably want to scope most animations with this class. Removed when the navigation has completed and all animations have ended.

`turn-restore`

Added when a visit starts and the action is restore. Given the number of ways it's possible to navigate back/forward (back button, swipe left/right, history.back()), it's generally recommended that restoration visits are not animated. Removed when the navigation has completed and all animations have ended.

`turn-replace`

Added when a visit starts and the action is replace. Removed when the navigation has completed and all animations have ended.

`turn-before-exit`

Added when a visit starts. Useful for optimising animations with will-change. (See turn.css for an example.) Removed when the exit animations start.

`turn-exit`

Added when a visit starts. Use this to scope exit animations. Removed when the exit animations complete.

`turn-before-transition` (if View Transitions supported & enabled)

Added after the exit animations and any request has completed, but before the View Transitions have taken their snapshot. Useful when combining View Transitions with custom exit/enter animations. To avoid a flash of content, use this class to target exited elements, and style them in their final "exit" state. (See turn.css for an example.) Removed when the transition starts.

`turn-transition` (if View Transitions supported & enabled)

Adding during a View Transition. Useful when combining View Transitions with custom exit/enter animations.

`turn-enter`

Added after any requests have completed and previous animations/transitions have completed. Removed once the animations have completed.

Events

event.details may contain:

action: the action of the visit (advance or restore)
initiator: the element the visit was triggered from (an a, form, or html element if a Back/Forward navigation)
referrer: the URL the page is transitioning from
url: the URL the page is transitioning to
newBody: the incoming <body> that will be transitioned to

`turn:before-exit`

Dispatched before exit animations are started. event.detail includes:

action
initiator
referrer
url

`turn:before-transition`

Dispatched before a View Transition is started (after exit animations if present). Ideal for setting up view-transition-names before the View Transition performs its capturing. event.detail includes:

action
initiator
newBody
referrer

`turn:before-enter`

Dispatched before enter animations are started (after Vire Transitions if present). event.detail includes:

action
initiator
newBody
referrer

`turn:enter`

Dispatched after the all transitions and animations have completed. event.detail includes:

action
referrer
url
timing: the visit's timing metrics

Usage with Tailwind CSS

Define animations in tailwind.config.js, and add a plugin that scopes the styles, e.g.:

const plugin = require('tailwindcss/plugin')

module.exports = {
  theme: {
    extend: {
      animation: {
        exit: 'fade-out-up 0.3s cubic-bezier(0.65, 0.05, 0.35, 1) forwards',
        enter: 'fade-in-up 0.6s cubic-bezier(0.65, 0.05, 0.35, 1) forwards'
      },
      keyframes: {
        'fade-out-up': {/* … */},
        'fade-in-up': {/* … */}
      }
    }
  },

  plugins: [
    plugin(function ({ addVariant }) {
      addVariant('turn-exit', 'html.turn-exit &')
      addVariant('turn-enter', 'html.turn-enter &')
    })
  ]
}

Then in your HTML:

<main data-turn-exit="turn-exit:animate-exit" data-turn-enter="turn-enter:animate-enter">
  <!-- … -->
</main>

Disabling Animations

Add data-turn="false" to the <body> to opt out of animations from that page.

(This currently rather basic, but is limited by the information available in Turbo events. Hopefully improvable if turbo:visit events are fired on the initiating element.)

Tip & Tricks

1. Animate Changes

Avoid animating the whole body. Animations should target elements that change on navigation. So avoid animating persistent headers and instead animate the main element or just the panels/cards within it.

2. Nesting

Nesting animating elements draws attention and brings screens to life. Add data-turn-exit/data-turn-enter attributes to elements such as headings and key images within an animating container. The compound animation effects means they'll exit faster, and enter slower than other elements. For example:

<main data-turn-exit data-turn-enter>
  <h1 data-turn-exit data-turn-enter>Hello, world!</h1>
</main>

3. Optimizing Animations

Jumpy exit animations can be prevented using the will-change CSS property. Turn adds a turn-before-exit class to the HTML element just before adding the exit classes. This provides an opportunity to notify the browser of upcoming changes. For example, by default turn.css does the following:

html.turn-before-exit [data-turn-exit],
html.turn-exit [data-turn-exit] {
  will-change: transform, opacity;
}

4. Loading Spinner

Exit animations on slow requests can leave users with a blank screen. Improve the experience with a loading spinner that appears a short time after the exit animation. For example, if your exit animation take 600ms, add a spinner that starts appearing 700ms after that by using transition-delay. This spinner can live permanently in the body and only transition when the turn-exit class is applied:

.spinner {
  position: fixed;
  top: 15%;
  left: 50%;
  transform: translateX(-50%);
  opacity: 0;
  transition: opacity 100ms;
}
html.turn-exit .spinner {
  opacity: 1;
  transition-delay: 700ms
}

Not seeing animations?

Check your device preferences to see if you have requested reduced motion. Turn will only animate transitions when the prefers-reduced-motion media query does not match reduce.

How does it work?

Turn adds exit and enter classes at the appropriate times like so:

on turbo:visit add the exit classes
pause turbo:before-render (wait for exit animations to complete before resuming)
on turbo:render, remove exit classes and add the enter classes
on turbo:load, wait for the enter animations to complete before removing the enter classes

Credits

Default fade in/out animations adapted from Jon Yablonski's Humane By Design.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Turn

Installation

Usage

Customizing Animations

Custom Class Names

Class List

turn-view-transitions

turn-no-view-transitions

turn-advance

turn-restore

turn-replace

turn-before-exit

turn-exit

turn-before-transition (if View Transitions supported & enabled)

turn-transition (if View Transitions supported & enabled)

turn-enter