Repository files navigation

Rekapi is a keyframe animation library for JavaScript. It gives you an APIfor:

• Defining keyframe-based animations
• Controlling animation playback

Rekapi is renderer-agnostic. At its core, Rekapi does not perform anyrendering. However, it does expose an API for defining renderers, and comesbundled with renderers for the HTML DOM and HTML5 2D<canvas>.

Rekapi officially supports Evergreen browsers.

npm install --save rekapi

First, install the dependencies via npm like so:

npm install

Once those are installed, you can generatedist/rekapi.js with:

npm run build

To run the tests in CLI:

npm test

To generate the documentation (dist/doc):

npm run doc

To generate, live-update, and view the documentation in your browser:

npm run doc:live

To start a development server:

npm start

Once that's running, you can run the tests athttp://localhost:9010/test/ andview the documentation athttp://localhost:9010/dist/doc/.

Rekapi exposes a UMD module, so you can load it however you like:

// ES6import{Rekapi,Actor}from'rekapi';

Or:

// AMDdefine(['rekapi'],rekapi=>{});

Or even:

// CommonJSconstrekapi=require('rekapi');

Take a peek at theNetworkpage to see all of the Rekapi contributors.

Rekapi is distributed under theMITlicense. You are encouraged to use andmodify the code to suit your needs, as well as redistribute it.