https://github.com/vuejs/vue-animated-list

A Vue.js plugin for easily animating `v-for` rendered lists.
https://github.com/vuejs/vue-animated-list

Last synced: 22 days ago
JSON representation

A Vue.js plugin for easily animating `v-for` rendered lists.

• Host: GitHub
• URL: https://github.com/vuejs/vue-animated-list
• Owner: vuejs
• License: mit
• Archived: true
• Created: 2016-02-18T15:50:52.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2016-09-29T00:09:18.000Z (over 8 years ago)
• Last Synced: 2024-10-30T00:55:16.253Z (3 months ago)
• Language: JavaScript
• Size: 10.7 KB
• Stars: 461
• Watchers: 11
• Forks: 47
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-vue-cn - vue-animated-list ★88 - for` rendered lists. (Awesome Vue.js [](https://github.com/sindresorhus/awesome) / Libraries & Plugins)

README

        
# vue-animated-list

> **NOTE:** this plugin is for Vue 1.x only. Vue 2.0 supports moving animations out of the box.

A Vue.js plugin for easily animating `v-for` rendered lists.

[Live Demo](http://vuejs.github.io/vue-animated-list/example.html)

Compatibility: [IE10+](http://caniuse.com/#search=css%20transition).

## Installation

- #### With Modules

  ``` js

  // ES6

  import Vue from 'vue'

  import VueAnimatedList from 'vue-animated-list'

  Vue.use(VueAnimatedList)

  // ES5

  var Vue = require('vue')

  Vue.use(require('vue-animated-list'))

  ```

- #### `` Include

  Just include `vue-animated-list.js` after Vue itself.

## Usage

There's nothing you need to do in JavaScript except for installation. In your markup, make sure the `v-for` has a transition attribute:

``` html

<div v-for="item in items" transition="item">

  {{ item.text }}

</div>

```

Now, all you need to do is define the `.item-move` CSS class:

``` css

.item-move {

  /* applied to the element when moving */

  transition: transform .5s cubic-bezier(.55,0,.1,1);

}

```

And that's it! You can also add CSS classes for enter and leave transitions - they all work nicely together!

A few things to note:

1. The animation is done using the CSS `transform` property. So make sure when `.item-move` is applied its `transform` property is transition-enabled.

2. Move animations can only work on elements, so it doesn't work for `<template v-for>` and fragment instance components.

## How Does It Work?

This is inspired by [this great post by Joshua Comeau](https://medium.com/@joshuawcomeau/animating-the-unanimatable-1346a5aab3cd#.sen3tgomb), which is in turn based on the [FLIP technique by Paul Lewis](https://aerotwist.com/blog/flip-your-animations/). So read those if you are interested in the technical details!

## License

[MIT](http://opensource.org/licenses/MIT)