TS 中文文档

tween.js


JavaScript (TypeScript) tweening engine for easy animations, incorporating optimised Robert Penner's equations.

Build and Tests

  1. ``` html
  2. <script src="https://cdnjs.cloudflare.com/ajax/libs/tween.js/20.0.0/tween.umd.js"></script>
  4. <div id="box"></div>
  6. <style>
  7. #box {
  8.   background-color: deeppink;
  9.   width: 100px;
  10.   height: 100px;
  11. }
  12. </style>
  14. <script>
  15. const box = document.getElementById('box') // Get the element we want to animate.
  17. const coords = {x: 0, y: 0} // Start at (0, 0)
  19. const tween = new TWEEN.Tween(coords, false) // Create a new tween that modifies 'coords'.
  20.   .to({x: 300, y: 200}, 1000) // Move to (300, 200) in 1 second.
  21.   .easing(TWEEN.Easing.Quadratic.InOut) // Use an easing function to make the animation smooth.
  22.   .onUpdate(() => {
  23.    // Called after tween.js updates 'coords'.
  24.    // Move 'box' to the position described by 'coords' with a CSS translation.
  25.    box.style.setProperty('transform', 'translate(' + coords.x + 'px, ' + coords.y + 'px)')
  26.   })
  27.   .start() // Start the tween immediately.
  29. // Setup the animation loop.
  30. function animate(time) {
  31.   tween.update(time)
  32.   requestAnimationFrame(animate)
  33. }
  34. requestAnimationFrame(animate)
  35. </script>
  36. ```

Try this example on CodePen

Installation


From CDN


Install from a content-delivery network (CDN) like in the above example.

From cdnjs:

  1. ``` html
  2. <script src="https://cdnjs.cloudflare.com/ajax/libs/tween.js/20.0.0/tween.umd.js"></script>
  3. ```

Or from unpkg.com:

  1. ``` html
  2. <script src="https://unpkg.com/@tweenjs/tween.js@^20.0.0/dist/tween.umd.js"></script>
  3. ```

Note that unpkg.com supports a semver version in the URL, where the ^ in the URL tells unpkg to give you the latest version 20.x.x.

Build and include in your project with script tag


Currently npm is required to build the project.

  1. ``` shell
  2. git clone https://github.com/tweenjs/tween.js
  3. cd tween.js
  4. npm install
  5. npm run build
  6. ```

This will create some builds in the dist directory. There are currently two different builds of the library:

UMD : tween.umd.js
ES6 Module : tween.es.js

You are now able to copy tween.umd.js into your project, then include it with a script tag, which will add TWEEN to the global scope,

  1. ``` html
  2. <script src="path/to/tween.umd.js"></script>
  3. ```

or import TWEEN as a JavaScript module,

  1. ``` html
  2. <script type="module">
  3. import * as TWEEN from 'path/to/tween.es.js'
  4. </script>
  5. ```

where path/to is replaced with the location where you placed the file.

With npm install and import from node_modules


You can add tween.js as an npm dependency:

  1. ``` shell
  2. npm install @tweenjs/tween.js
  3. ```

With a build tool


If you are using Node.js, Parcel, Webpack, Rollup, Vite, or another build tool, then you can now use the following to include tween.js:

  1. ``` js
  2. import * as TWEEN from '@tweenjs/tween.js'
  3. ```

Without a build tool


You can import from node_modules if you serve node_modules as part of your website, using an importmap script tag. First, assuming node_modules is at the root of your website, you can write an import map:

  1. ``` html
  2. <script type="importmap">
  3. {
  4.   "imports": {
  5.    "@tweenjs/tween.js": "/node_modules/@tweenjs/tween.js/dist/tween.es.js"
  6.   }
  7. }
  8. </script>
  9. ```

Now in any of your module scripts you can import it by its package name:

  1. ``` js
  2. import * as TWEEN from '@tweenjs/tween.js'
  3. ```

Features


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

Documentation


User guide
Contributor guide
Tutorial using tween.js with three.js
Also: libtween, a port of tween.js to C by jsm174
Understanding tween.js

Examples


:--- :--- :--- :---
hello world hello world (source) Bars Bars (source)
Black and red Black and red (source) Graphs Graphs (source)
Simplest possible example Simplest possible example (source) Video and time Video and time (source)
Array interpolation Array interpolation (source) Dynamic to, object Dynamic to, object (source)
Dynamic to, interpolation array Dynamic to, interpolation array (source) Dynamic to, large interpolation array Dynamic to, large interpolation array (source)
Repeat Repeat (source) Relative values Relative values (source)
Yoyo Yoyo (source) Stop all chained tweens Stop all chained tweens (source)
Custom functions Custom functions (source) Relative start time Relative start time (source)
Pause tween Pause tween (source) Complex properties Complex properties (source)
Animate an array of values Animate an array of values (source)

Tests


You need to install npm first--this comes with node.js, so install that one first. Then, cd to tween.js 's (or wherever you cloned the repo) directory and run:

  1. ``` shell
  2. npm install
  3. ```

To run the tests run:

  1. ``` shell
  2. npm test
  3. ```

If you want to add any feature or change existing features, you mustrun the tests to make sure you didn't break anything else. Any pull request (PR) needs to have updated passing tests for feature changes (or new passing tests for new features or fixes) in src/tests.ts a PR to be accepted. See contributing for more information.

People


Maintainers: mikebolt, sole, Joe Pea (@trusktr).

All contributors.

Projects using tween.js


Lume