Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tweenjs/tween.js
JavaScript/TypeScript animation engine
https://github.com/tweenjs/tween.js
animation easing easing-curves easing-equations easing-functions interaction interactive javascript tween tweenjs typescript
Last synced: 6 days ago
JSON representation
JavaScript/TypeScript animation engine
- Host: GitHub
- URL: https://github.com/tweenjs/tween.js
- Owner: tweenjs
- License: other
- Created: 2010-05-28T14:24:20.000Z (over 14 years ago)
- Default Branch: main
- Last Pushed: 2024-05-12T17:14:27.000Z (6 months ago)
- Last Synced: 2024-05-21T13:41:32.275Z (6 months ago)
- Topics: animation, easing, easing-curves, easing-equations, easing-functions, interaction, interactive, javascript, tween, tweenjs, typescript
- Language: TypeScript
- Homepage: https://tweenjs.github.io/tween.js/
- Size: 15.9 MB
- Stars: 9,665
- Watchers: 215
- Forks: 1,401
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-game-engine-dev - Tween.js - Tweening engine for easy animations using Robert Penner's equations. (Libraries / JavaScript)
- awesome-github-star - tween.js
- awesome-list - tween.js
- awesome - tweenjs/tween.js - JavaScript/TypeScript animation engine (TypeScript)
- awesome - tweenjs/tween.js - JavaScript/TypeScript animation engine (TypeScript)
README
# tween.js
JavaScript (TypeScript) tweening engine for easy animations, incorporating optimised Robert Penner's equations.
[![NPM Version][npm-image]][npm-url]
[![CDNJS][cdnjs-image]][cdnjs-url]
[![NPM Downloads][downloads-image]][downloads-url]
[![Build and Tests][ci-image]][ci-url]
More languages: [English](./README.md), [简体中文](./README_zh-CN.md)
---
```html
#box {
background-color: deeppink;
width: 100px;
height: 100px;
}
import {Tween, Easing} from 'https://unpkg.com/@tweenjs/[email protected]/dist/tween.esm.js'
const box = document.getElementById('box') // Get the element we want to animate.
const coords = {x: 0, y: 0} // Start at (0, 0)
const tween = new Tween(coords, false) // Create a new tween that modifies 'coords'.
.to({x: 300, y: 200}, 1000) // Move to (300, 200) in 1 second.
.easing(Easing.Quadratic.InOut) // Use an easing function to make the animation smooth.
.onUpdate(() => {
// Called after tween.js updates 'coords'.
// Move 'box' to the position described by 'coords' with a CSS translation.
box.style.setProperty('transform', 'translate(' + coords.x + 'px, ' + coords.y + 'px)')
})
.start() // Start the tween immediately.
// Setup the animation loop.
function animate(time) {
tween.update(time)
requestAnimationFrame(animate)
}
requestAnimationFrame(animate)
```
[Try this example on CodePen](https://codepen.io/trusktr/pen/KKGaBVz?editors=1000)
# Features
- Does one thing only and does it well: tweens properties of an object
- 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
- Doesn't make its own animation loop, making it flexible for integration into
any animation loop.
# Examples
hello world
(source)
Bars
(source)
Black and red
(source)
Graphs
(source)
Simplest possible example
(source)
Video and time
(source)
Array interpolation
(source)
Dynamic to, object
(source)
Dynamic to, interpolation array
(source)
Dynamic to, large interpolation array
(source)
Repeat
(source)
Relative values
(source)
Yoyo
(source)
Stop all chained tweens
(source)
Custom functions
(source)
Relative start time
(source)
Pause tween
(source)
Complex properties
(source)
Animate an array of values
(source)
# Installation
The recommended method is to use `import` syntax. Here we've listed various
install methods starting roughly with the most recommended first and least
desirable last. Evaluate all of the following methods to pick what is most
suitable for your project.
## With `npm install` and `import` from `node_modules`
You can add tween.js as an npm dependency:
```bash
npm install @tweenjs/tween.js
```
### Without a build tool
#### Installed locally
You can import from `node_modules` if you serve `node_modules` as part of your
website, using a standard `importmap` script tag. First, assuming `node_modules`
is at the root of your website, you can write an import map like so in your HTML
file:
```html
{
"imports": {
"@tweenjs/tween.js": "/node_modules/@tweenjs/tween.js/dist/tween.esm.js"
}
}
```
Now in any of your module scripts you can import Tween.js by its package name:
```html
import {Tween} from '@tweenjs/tween.js'
```
#### Import from CDN
Note that, without the `importmap`, you can import directly from a CDN as with the first example above, like so:
```html
import {Tween} from 'https://unpkg.com/browse/@tweenjs/[email protected]/dist/tween.esm.js'
```
You can also link your `importmap` to the CDN instead of a local `node_modules` folder, if you prefer that:
```html
{
"imports": {
"@tweenjs/tween.js": "https://unpkg.com/browse/@tweenjs/[email protected]/dist/tween.esm.js"
}
}
import {Tween} from '@tweenjs/tween.js'
```
### With a build tool
If you are using [Node.js](https://nodejs.org/),
[Parcel](https://parceljs.org/), [Webpack](https://webpack.js.org/),
[Rollup](https://rollupjs.org/), [Vite](https://vitejs.dev/), or another build
tool, then you can install `@tweenjs/tween.js` with `npm install
@tweenjs/tween.js`, and `import` the library into your JavaScript (or
TypeScript) file, and the build tool will know how to find the source code from
`node_modules` without needing to create an `importmap` script:
```javascript
import * as TWEEN from '@tweenjs/tween.js'
```
However, note that this approach requires always running a build tool for your
app to work, while the `importmap` approach will simply work without any build
tools as a simple static HTML site.
## Manual build
Another approach is to download the source code with git, manually build the
library, then place the output in your project. Node.js is required for this.
```bash
git clone https://github.com/tweenjs/tween.js
cd tween.js
npm install
npm run build
```
This will create some builds in the `dist` directory. There are currently two different builds of the library:
- ES6 Module in `/dist/tween.esm.js` (recommended)
- UMD in `/dist/tween.umd.js` (deprecated, will be removed in a future major version)
You are now able to copy one of those two files into your project, and use like this (recommended):
```html
import {Tween} from 'path/to/tween.esm.js'
```
or (deprecated, to be removed in future major):
```html
const {Tween} = TWEEN
```
where `path/to` is replaced with the location where you placed the file.
> [!Note]
> You can also download these files from unpkg, for example here:
> https://unpkg.com/browse/@tweenjs/[email protected]/dist/
## Global variable from CDN (deprecated)
> [!Note]
> This method is deprecated and will be removed in a future major version!
Install a global `TWEEN` variable from a content-delivery network (CDN) using the UMD file.
From cdnjs:
```html
```
Or from unpkg.com:
```html
```
Then use the `TWEEN` variable in any script:
```html
const {Tween, Easing, Group /*, ...*/} = TWEEN
const tween = new Tween(someObject)
// ...
```
> [!Note]
> 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.
## CommonJS (deprecated)
Skip this section if you don't know what CommonJS is!
> [!Note]
> This method is deprecated and will be removed in a future major version!
Any of the above methods work in older systems that still use CommonJS. Repeat
any of the above methods but using `dist/tween.cjs` instead of
`dist/tween.esm.js` or `dist/tween.umd.js`.
# Documentation
- [User guide](./docs/user_guide.md)
- [Contributor guide](./docs/contributor_guide.md)
- [Tutorial](https://web.archive.org/web/20220601192930/http://learningthreejs.com/blog/2011/08/17/tweenjs-for-smooth-animation/) using tween.js with three.js
- Also: [libtween](https://github.com/jsm174/libtween), a port of tween.js to C by [jsm174](https://github.com/jsm174)
# 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:
```bash
npm install
```
To run the tests run:
```bash
npm test
```
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. 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` to be accepted. See
[contributing](CONTRIBUTING.md) for more information.
# People
Maintainers: [Joe Pea (@trusktr)](https://github.com/trusktr).
[All contributors](http://github.com/tweenjs/tween.js/contributors).
# Projects using tween.js
[
](https://lume.io)
[](https://aframe.io)
[](http://www.moma.org/interactives/exhibitions/2012/inventingabstraction/)
[](http://www.chromeweblab.com/)
[](http://5013.es/toys/macchina)
[](http://egraether.com/mine3d/)
[](http://ro.me)
[](http://data-arts.appspot.com/globe)
[](http://www.androidify.com/)
[](http://thewildernessdowntown.com/)
[](http://dejavis.org/linechart)
[npm-image]: https://img.shields.io/npm/v/@tweenjs/tween.js.svg
[npm-url]: https://npmjs.org/package/@tweenjs/tween.js
[downloads-image]: https://img.shields.io/npm/dm/@tweenjs/tween.js.svg
[downloads-url]: https://npmjs.org/package/@tweenjs/tween.js
[ci-image]: https://github.com/tweenjs/tween.js/workflows/build%20and%20tests/badge.svg?branch=master
[ci-url]: https://github.com/tweenjs/tween.js/actions
[cdnjs-image]: https://img.shields.io/cdnjs/v/tween.js.svg
[cdnjs-url]: https://cdnjs.com/libraries/tween.js