1.0.1 • Published 7 years ago

vue-sprite-animator v1.0.1

Weekly downloads
4
License
MIT
Repository
-
Last release
7 years ago

vue-sprite-animator

Install

Install with npm or yarn:

$ npm install --save vue-sprite-animator
# or
$ yarn add vue-sprite-animator

Example

Use spritesheet.js to generate spritesheet with the jsonarray format.

Install the plugin

import Vue from 'vue'
import App from './App'

import VueSpriteAnimator from 'vue-sprite-animator'
Vue.use(VueSpriteAnimator)

new Vue({
  components: { App },
  template: '<App/>'
}).$mount('#app')

Use it

<template>
  <div id="wrapper">
    <v-sprite :id="'sprite'"
      :spritesheet="require('../assets/spritesheet.png')"
      :json="require('../assets/spritesheet.json')"
      :yoyo="false"
      :fps="30"
      ref="sprite"
    ></v-sprite>
    <button @click="play">play</button>
    <button @click="stop">stop</button>
  </div>
</template>

<script>
  export default {
    methods: {
      play () {
        this.$refs.sprite.play()
      },
      stop () {
        this.$refs.sprite.stop()
      }
    }
  }
</script>

Available props

  • spritesheet (required): path to the spritesheet image
  • json (required): path to the spritesheet json descriptor (use spritesheet.js)
  • fps: default is 30
  • autoplay: default is true
  • yoyo: default is false
  • id: default is vue-sprite