Security News
The Unpaid Backbone of Open Source: Solo Maintainers Face Increasing Security Demands
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
@tweenjs/tween.js
Advanced tools
Super simple, fast and easy to use tweening engine which incorporates optimised Robert Penner's equations.
@tweenjs/tween.js is a simple but powerful tweening engine for JavaScript. It allows you to create smooth animations by interpolating between values over time. This can be used for animating properties of objects, such as position, scale, rotation, and more.
Basic Tweening
This code demonstrates basic tweening where an object's properties (x and y coordinates) are animated from one state to another over a duration of 1000 milliseconds.
const TWEEN = require('@tweenjs/tween.js');
let coords = { x: 0, y: 0 };
let tween = new TWEEN.Tween(coords)
.to({ x: 100, y: 100 }, 1000)
.onUpdate(() => {
console.log(coords);
})
.start();
function animate(time) {
requestAnimationFrame(animate);
TWEEN.update(time);
}
requestAnimationFrame(animate);
Easing Functions
This code demonstrates the use of easing functions to create more natural motion. The Quadratic.Out easing function is used to slow down the animation towards the end.
const TWEEN = require('@tweenjs/tween.js');
let coords = { x: 0, y: 0 };
let tween = new TWEEN.Tween(coords)
.to({ x: 100, y: 100 }, 1000)
.easing(TWEEN.Easing.Quadratic.Out)
.onUpdate(() => {
console.log(coords);
})
.start();
function animate(time) {
requestAnimationFrame(animate);
TWEEN.update(time);
}
requestAnimationFrame(animate);
Chaining Tweens
This code demonstrates chaining tweens, where one tween starts after another finishes. The x coordinate is animated first, followed by the y coordinate.
const TWEEN = require('@tweenjs/tween.js');
let coords = { x: 0, y: 0 };
let tween1 = new TWEEN.Tween(coords)
.to({ x: 100 }, 1000);
let tween2 = new TWEEN.Tween(coords)
.to({ y: 100 }, 1000);
tween1.chain(tween2);
tween1.start();
function animate(time) {
requestAnimationFrame(animate);
TWEEN.update(time);
}
requestAnimationFrame(animate);
GSAP (GreenSock Animation Platform) is a robust and high-performance JavaScript animation library. It offers more features and flexibility compared to @tweenjs/tween.js, including timeline management, advanced easing, and support for SVG animations.
Anime.js is a lightweight JavaScript animation library with a simple API. It supports various types of animations, including CSS properties, SVG, DOM attributes, and JavaScript objects. It is more feature-rich and versatile compared to @tweenjs/tween.js.
Popmotion is a functional, flexible JavaScript animation library. It provides a range of tools for creating animations and interactions, including physics-based animations. It offers more advanced features and flexibility compared to @tweenjs/tween.js.
JavaScript tweening engine for easy animations, incorporating optimised Robert Penner's equations.
Do you use tween.js? If you have some time, please fill out this short survey.
Update Note In v18 the script you should include has moved from src/Tween.js
to dist/tween.umd.js
. See the installation section below. v18 is not yet available on CDNJS.
const box = document.createElement('div');
box.style.setProperty('background-color', '#008800');
box.style.setProperty('width', '100px');
box.style.setProperty('height', '100px');
document.body.appendChild(box);
// Setup the animation loop.
function animate(time) {
requestAnimationFrame(animate);
TWEEN.update(time);
}
requestAnimationFrame(animate);
const coords = { x: 0, y: 0 }; // Start at (0, 0)
const tween = new TWEEN.Tween(coords) // Create a new tween that modifies 'coords'.
.to({ x: 300, y: 200 }, 1000) // Move to (300, 200) in 1 second.
.easing(TWEEN.Easing.Quadratic.Out) // 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.
Currently npm is required to build the project.
git clone https://github.com/tweenjs/tween.js
cd tween.js
npm i .
npm run build
This will create some builds in the dist
directory. There are currently four different builds of the library:
You are now able to copy tween.umd.js into your project, then include it with a script tag. This will add TWEEN to the global scope.
<script src="js/tween.umd.js"></script>
require('@tweenjs/tween.js')
You can add tween.js as an npm dependency:
npm i @tweenjs/tween.js@^18
If you are using Node, Webpack, or Browserify, then you can now use the following to include tween.js:
const TWEEN = require('@tweenjs/tween.js');
px
)
Custom functions (source) |
Stop all chained tweens (source) | ||
Yoyo (source) |
Relative values (source) | ||
Repeat (source) |
Dynamic to (source) | ||
Array interpolation (source) |
Video and time (source) | ||
Simplest possible example (source) |
Graphs (source) | ||
Black and red (source) |
Bars (source) | ||
hello world (source) |
You need to install npm
first--this comes with node.js, so install that one first. Then, cd to tween.js
'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
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 pull request (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.
FAQs
Simple and fast tweening engine with optimised Robert Penner's equations.
The npm package @tweenjs/tween.js receives a total of 376,402 weekly downloads. As such, @tweenjs/tween.js popularity was classified as popular.
We found that @tweenjs/tween.js demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.
Security News
A developer is accusing Tencent of violating the GPL by modifying a Python utility and changing its license to BSD, highlighting the importance of copyleft compliance.