anime README

The project's README from github.com/juliangarnier/anime. As one markdown file: README.md.

Anime.js

Anime.js V4 logo animation

Anime.js is a fast, multipurpose and lightweight JavaScript animation library with a simple, yet powerful API.
It works with CSS properties, SVG, DOM attributes and JavaScript Objects.

NPM Downloads jsDelivr hits (npm) GitHub Sponsors

Sponsors

Anime.js is 100% free and is only made possible with the help of our sponsors. Help the project become sustainable by sponsoring us on GitHub Sponsors.

Platinum sponsors

Silver sponsors

Get featured here by becoming a GitHub Sponsor.

Usage

Anime.js V4 works by importing ES modules like so:

import {
  animate,
  stagger,
} from 'animejs';

animate('.square', {
  x: 320,
  rotate: { from: -180 },
  duration: 1250,
  delay: stagger(65, { from: 'center' }),
  ease: 'inOutQuint',
  loop: true,
  alternate: true
});
Anime.js code example

V4 Documentation

The full documentation is available here.

V3 Migration guide

You can find the v3 to v4 migration guide here.

NPM development scripts

First, run npm i to install all the necessary packages. Then, execute the following scripts with npm run <script>.

script action
dev Watches for changes in src/**/*.js, bundles the ESM version to lib/ and creates type declarations in types/
dev:test Runs dev and test:browser concurrently
build Bundles ESM / UMD / CJS / IIFE versions to lib/ and creates type declarations in types/
test:browser Starts a local server and runs all browser-related tests
test:node Starts Node-related tests
open:examples Starts a local server to browse the examples locally

© Julian Garnier | MIT License

anime (juliangarnier/anime)

Searching Database…

73.7K ·GitHub
Anime
Что это такое?Anime.js — это быстрая, многофункциональная и лёгкая JavaScript-библиотека анимаций с простым, но мощным API для анимации всего на веб-страницах.
Это библиотека, которую я подключаю в свой код, или готовое приложение?Это библиотека: anime.js V4 подключается импортом её ES-модулей в ваш собственный проект, а не как отдельная программа, которую запускают сама по себе.
Как добавить её в проект?Установите npm-пакет и импортируйте его модули в своём коде; в README есть ссылка на полную документацию V4 с пошаговым описанием использования.
Подтягивает ли anime.js другие библиотеки?Нет — в пакете ноль runtime-зависимостей, поэтому вместе с ним ничего дополнительно не устанавливается.
Я использовал anime.js v3 — будет ли мой старый код работать на v4?В V4 API изменился по сравнению с v3, и в репозитории есть официальное руководство по миграции с v3 на v4 для переноса существующего кода.
Что с его помощью можно анимировать?CSS-свойства, SVG, атрибуты DOM и обычные JavaScript-объекты — то есть стили, векторную графику и даже произвольные значения объектов.
Он работает вне браузера, например в Node?Он создан для браузера (CSS, SVG, DOM), но в репозитории есть тесты под Node и публикуются CJS-сборки, так что анимация обычных объектов работает и в Node.
Есть ли в комплекте типы для TypeScript?Да — сборка генерирует файлы объявлений типов вместе с бандлами ESM, UMD, CJS и IIFE, а сам репозиторий проверяет свой код и примеры через tsc.
What are similar projects?GSAP, jquery, vivus, svg.js, velocity, popmotion, snabbdom, classnames
Which topics is it in?css-animations, svg-animation, engine, esm, anime, mit-license, dom, lightweight, canvas, svg, javascript-library, animation
Creator
juliangarnier
Size
180.7 MB
Stars
73.7K
Updated
CommitAug 09Releasev4.5.0Jun 22
Age
10y
Commits · 90 Days