The transition Property

Nuxt.js uses the <transition> component to let you create amazing transitions/animations between your pages.

  • Type: String or Object or Function

To define a custom transition for a specific route, simply add the transition key to the page component.

export default {
  // Can be a String
  transition: ''
  // Or an Object
  transition: {}
  // or a Function
  transition (to, from) {}
}

String

If the transition key is set as a string, it will be used as the transition.name.

export default {
  transition: 'test'
}

Nuxt.js will use these settings to set the component as follows:

<transition name="test">

Object

If the transition key is set as an object:

export default {
  transition: {
    name: 'test',
    mode: 'out-in'
  }
}

Nuxt.js will use these settings to set the component as follows:

<transition name="test" mode="out-in">

The following properties that the transition object can have:

key Type Default definition
name String "page" The transition name applied on all the route transitions.
mode String "out-in" The transition mode applied on all routes, see Vue.js documentation.
css Boolean true Whether to apply CSS transition classes. Defaults to true. If set to false, will only trigger JavaScript hooks registered via component events.
duration Integer n/a The duration (in milliseconds) applied on the transition, see Vue.js documentation.
type String n/a Specify the type of transition events to wait for to determine transition end timing. Available values are "transition" and "animation". By default, it will automatically detect the type that has a longer duration.
enterClass String n/a The starting state of the transition class. See Vue.js documentation.
enterToClass String n/a The ending state for the transition. See Vue.js documentation.
enterActiveClass String n/a The class applied across the entire transition duration. See Vue.js documentation.
leaveClass String n/a The starting state of the transition class. See Vue.js documentation.
leaveToClass String n/a The ending state for the transition. See Vue.js documentation.
leaveActiveClass String n/a The class applied across the entire transition duration. See Vue.js documentation.

You can also define methods in the transition, these are for the JavaScript hooks:

  • beforeEnter(el)
  • enter(el, done)
  • afterEnter(el)
  • enterCancelled(el)
  • beforeLeave(el)
  • leave(el, done)
  • afterLeave(el)
  • leaveCancelled(el)

Note: it’s also a good idea to explicitly add css: false for JavaScript-only transitions so that Vue can skip the CSS detection. This also prevents CSS rules from accidentally interfering with the transition.

Function

If the transition key is set as a function:

export default {
  transition (to, from) {
    if (!from) return 'slide-left'
    return +to.query.page < +from.query.page ? 'slide-right' : 'slide-left'
  }
}

Transitions applied on navigation:

  • / to /posts => slide-left,
  • /posts to /posts?page=3 => slide-left,
  • /posts?page=3 to /posts?page=2 => slide-right.

Caught a mistake or want to contribute to the documentation? Edit this page on GitHub!