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: about 1 month 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 (about 14 years ago)
- Default Branch: main
- Last Pushed: 2024-05-05T21:18:05.000Z (about 2 months ago)
- Last Synced: 2024-05-06T21:20:18.877Z (about 2 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,647
- Watchers: 215
- Forks: 1,401
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Lists
- awesome-list - tween.js
- awesome-game-engine-dev - Tween.js - Tweening engine for easy animations using Robert Penner's equations. (Libraries / JavaScript)
- awesome-stars - tweenjs/tween.js - JavaScript/TypeScript animation engine (TypeScript)
- awesome-stars-coconut - tweenjs/tween.js - JavaScript/TypeScript animation engine (TypeScript)
- awesome-stars - tweenjs/tween.js - JavaScript/TypeScript animation engine (TypeScript)
- awesome-stars - tweenjs/tween.js - JavaScript/TypeScript animation engine (TypeScript)
- awesome-github-star - tween.js
- awesome-stars - tweenjs/tween.js - JavaScript/TypeScript animation engine (TypeScript)
- awesome-stars - tween.js
- awesome-stars - tweenjs/tween.js - JavaScript/TypeScript animation engine (TypeScript)
- awesome-stars - tweenjs/tween.js - JavaScript/TypeScript animation engine (typescript)
- awesome-web-development - **tween.js** - JavaScript tweening engine for easy animations, incorporating optimised Robert Penner's equations
- awesome-stars - tweenjs/tween.js - JavaScript/TypeScript animation engine (TypeScript)
- my-awesome-stars - tweenjs/tween.js - JavaScript/TypeScript animation engine (TypeScript)
- github-FE-project - tween.js
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)
# Example
```html
#box {
background-color: deeppink;
width: 100px;
height: 100px;
}
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.Tween(coords, false) // Create a new tween that modifies 'coords'.
.to({x: 300, y: 200}, 1000) // Move to (300, 200) in 1 second.
.easing(TWEEN.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 the above example on CodePen](https://codepen.io/trusktr/pen/KKGaBVz?editors=1000)
Animate numbers in any JavaScript object. For example, [rotate a 3D box made
with Three.js](https://codepen.io/trusktr/pen/ExJqvgZ):
# Installation
## From CDN
Install from a content-delivery network (CDN) like in the above example.
From cdnjs:
```html
```
Or from unpkg.com:
```html
```
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.
```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:
- 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,
```html
```
or import TWEEN as a JavaScript module,
```html
import * as TWEEN from 'path/to/tween.es.js'
```
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:
```bash
npm install @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 now use the following to include tween.js:
```javascript
import * as TWEEN from '@tweenjs/tween.js'
```
### 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:
```html
{
"imports": {
"@tweenjs/tween.js": "/node_modules/@tweenjs/tween.js/dist/tween.es.js"
}
}
```
Now in any of your module scripts you can import it by its package name:
```javascript
import * as TWEEN from '@tweenjs/tween.js'
```
# 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](./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)
# 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)
# 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` a PR 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