spiritjs
TypeScript icon, indicating that this package has built-in type declarations

3.1.14 • Public • Published

Spirit

Spirit ⚡️ Web Player

travis version greensock downloads release

Lightweight and easy to use
Play your animations on the web

Getting Started:

Browser:

<svg>
  <g id="container">
    <path d="..." data-spirit-id="body" />
    <path d="..." data-spirit-id="mouth" />
    <path d="..." data-spirit-id="legs" />
  </g>
</svg>

<script src="https://unpkg.com/spiritjs/dist/spirit.min.js"></script>
<script>
  spirit
    .loadAnimation({
      path: './animation.json',
      container: dcument.getElementById('container'),
    })
    .then(timeline => timeline.play());
</script>

Node:

install:

npm install spiritjs --save

Usage:

// load GSAP from CDN

import spirit from 'spiritjs';

spirit.loadAnimation({ path: './animation.json' }).then(timeline => timeline.play());
// use existing GSAP instance

import gsap from 'gsap';
import spirit from 'spiritjs';

spirit.setup(gsap).then(() => {
  spirit.loadAnimation({ path: './animation.json' }).then(timeline => timeline.play());
});

For more info check out the API Documentation.

Examples

Package Sidebar

Install

npm i spiritjs

Homepage

spiritapp.io

Weekly Downloads

651

Version

3.1.14

License

MIT

Unpacked Size

528 kB

Total Files

44

Last publish

Collaborators

  • inlet