├── package.json ├── index.js ├── LICENSE ├── .gitignore └── README.md /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "vue-mixin-tween", 3 | "version": "0.1.3", 4 | "description": "Vue mixin factory to tween component numerical data", 5 | "main": "index.js", 6 | "scripts": { 7 | "test": "echo \"Error: no test specified\" && exit 1" 8 | }, 9 | "repository": { 10 | "type": "git", 11 | "url": "git+https://github.com/lukechinworth/vue-mixin-tween.git" 12 | }, 13 | "keywords": [ 14 | "vue", 15 | "mixin" 16 | ], 17 | "author": "Luke Chinworth", 18 | "license": "MIT", 19 | "bugs": { 20 | "url": "https://github.com/lukechinworth/vue-mixin-tween/issues" 21 | }, 22 | "homepage": "https://github.com/lukechinworth/vue-mixin-tween#readme", 23 | "dependencies": { 24 | "@tweenjs/tween.js": "^17.1.1" 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | import TWEEN from '@tweenjs/tween.js'; 2 | 3 | export default (propName, duration = 500, ease = TWEEN.Easing.Quadratic.Out) => { 4 | const propNameTween = `${propName}Tween`; 5 | 6 | return { 7 | data() { 8 | return { 9 | [propNameTween]: this[propName], 10 | }; 11 | }, 12 | watch: { 13 | // watch when the prop changes and tween the tween prop from old to new 14 | [propName](newValue, oldValue) { 15 | new TWEEN.Tween({ 16 | number: oldValue, 17 | }) 18 | .to({ 19 | number: newValue, 20 | }, duration) 21 | .easing(ease) 22 | .onUpdate(tween => { 23 | this[propNameTween] = tween.number; 24 | }) 25 | .start(); 26 | 27 | animate(); 28 | }, 29 | }, 30 | }; 31 | }; 32 | 33 | function animate() { 34 | if (TWEEN.update()) { 35 | requestAnimationFrame(animate); 36 | } 37 | } 38 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2017 Luke Chinworth 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | 8 | # Runtime data 9 | pids 10 | *.pid 11 | *.seed 12 | *.pid.lock 13 | 14 | # Directory for instrumented libs generated by jscoverage/JSCover 15 | lib-cov 16 | 17 | # Coverage directory used by tools like istanbul 18 | coverage 19 | 20 | # nyc test coverage 21 | .nyc_output 22 | 23 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 24 | .grunt 25 | 26 | # Bower dependency directory (https://bower.io/) 27 | bower_components 28 | 29 | # node-waf configuration 30 | .lock-wscript 31 | 32 | # Compiled binary addons (http://nodejs.org/api/addons.html) 33 | build/Release 34 | 35 | # Dependency directories 36 | node_modules/ 37 | jspm_packages/ 38 | 39 | # Typescript v1 declaration files 40 | typings/ 41 | 42 | # Optional npm cache directory 43 | .npm 44 | 45 | # Optional eslint cache 46 | .eslintcache 47 | 48 | # Optional REPL history 49 | .node_repl_history 50 | 51 | # Output of 'npm pack' 52 | *.tgz 53 | 54 | # Yarn Integrity file 55 | .yarn-integrity 56 | 57 | # dotenv environment variables file 58 | .env 59 | 60 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Vue Mixin Tween 2 | Vue mixin factory to tween component numerical data (using Tween.js). 3 | 4 | ## Installation 5 | `npm install vue-mixin-tween` 6 | 7 | ## Usage 8 | To tween a component prop, e.g. `width`: 9 | 10 | ```javascript 11 | import VueMixinTween from 'vue-mixin-tween'; 12 | 13 | export default { 14 | props: { 15 | width: Number, 16 | }, 17 | mixins: [ 18 | VueMixinTween('width'), 19 | ], 20 | // this.widthTween now available in your component 21 | // update width to new value, and widthTween will tween from the old to the new 22 | }; 23 | ``` 24 | 25 | ## API 26 | ### `VueMixinTween(propName[, duration[, ease]])` 27 | #### `propName: String` (required) 28 | Component property to watch for changes. Tweened property available on component context at `${propName}Tween`. 29 | 30 | #### `duration: Number = 500` (optional) 31 | Duration of tween. 32 | 33 | #### `ease: Function = TWEEN.Easing.Quadratic.Out` (optional) 34 | Easing function to tween value with. 35 | 36 | ## Contributing 37 | Please send a pull request if you'd like to improve the project. 38 | 39 | ## Attribution 40 | This project borrows heavily from [Animating State with Watchers](https://vuejs.org/v2/guide/transitioning-state.html#Animating-State-with-Watchers) from the vue docs. It basically just moves that example into a reusable mixin. 41 | --------------------------------------------------------------------------------