es6-tween

ES6 implementation of tween.js

let coords = { x: 0, y: 0 };
let tween = new TWEEN.Tween(coords)
    .to({ x: 100, y: 100 }, 1000)
    .on('update', object => {
        console.log(object.x, object.y);
    })
    .start();

requestAnimationFrame(animate);

function animate(time) {
    requestAnimationFrame(animate);
    TWEEN.update(time);
}

Installation

Download the library and include it in your code:

<script src="js/Tween.js"></script>

CDN-Hosted version

Using unpkg hosted version

You can also reference a unpkg-hosted version in your code, thanks to unpkg. For example:

<script src="https://unpkg.com/es6-tween/dist/Tween.min.js"></script>

Using jsdelivr hosted version

You can also reference a @jsdelivr-hosted version in your code, thanks to jsdelivr. For example:

<script src="https://cdn.jsdelivr.net/es6-tween/latest/Tween.min.js"></script>

Using cdnjs hosted version

You can also reference a @cdnjs-hosted version in your code, thanks to cdnjs. For example:

<script src="https://cdnjs.cloudflare.com/ajax/libs/es6-tween/1.11.2/Tween.min.js"></script>

More advanced users might want to...

Use import

import * as TWEEN from './node_modules/es6-tween/src/Tween';

Using npm, yarn or bower

$ yarn add es6-tween
# or
$ npm install es6-tween
# or
$ bower install es6-tween

Then include the Tween.js module with the standard node.js require:

let TWEEN = require('es6-tween');

And you can use Tween.js as in all other examples--for example:

let t = new TWEEN.Tween( /* etc */ );
t.start();

You can run script commands to build modules into single UMD compatible file:

Use Webpack + Babel Transpiler

npm run build

Then reference the library source:

<script src="dist/Tween.min.js"></script>

Bugs/Fixes

Helping to avoid false log of jscs

git config core.eol lf
git config core.autocrlf input
git rm --cached -r .
git reset --hard

Features

• Does one thing and one thing only: tween properties
• Doesn't take care of CSS units (e.g. appending px)
• Doesn't interpolate colours
• Easing functions are reusable outside of Tween
• Can also use custom easing functions

Documentation

• Original source: check out at here
• User guide
• Compatiblity
• Tutorial using tween.js with three.js

Examples

source source source source source source source source source source source source source

Tests

You need to install npm first--this comes with node.js, so install that one first. Then, cd to es6-tween's directory and run:

npm install

if running the tests for the first time, to install additional dependencies for running tests, and then run

npm test

or you can go here for more information, tests and etc...

every time you want to run the tests.

If you want to add any feature or change existing features, you must run the tests to make sure you didn't break anything else. If you send a PR to add something new and it doesn't have tests, or the tests don't pass, the PR won't be accepted. See contributing for more information.

Every PR, Commits and Update now automacilly updates the version based on commit message with semantic-release with Travis CI

People

Maintainers: sole, dalisoft.

All contributors.

Thanks to:

• @sole (author of this library)
• tween.js contributors
• @michaelvillar for physics easing
• Webpack, Babel, Travis CI, semantic-release and others (make issue, if i'm missed you) with their teams, devs and supporters

Projects using tween.js