rekapi-timeline

rekapi-timeline is a general-purpose timeline-editing interface for Rekapi meant to be integrated into graphical applications. It is designed to be feature-rich but flexible. rekapi-timeline is not intended to be used as a standalone application. A practical example of it in use is Mantra.

Dependencies

• Rekapi
  • Shifty
• Lateralus
  • jQuery
  • Backbone
  • Lodash
  • Mustache
• jQuery Dragon

Installation

npm install rekapi-timeline

Integration

To use rekapi-timeline in your app, just load dist/scripts/rekapi-timeline.js. This is a large file with styles and fonts embedded; if you would like to optimized your builds, you may want to consider loading the source files (in scripts/) directly into your application and customizing your build process to suit your needs.

rekapi-timeline bundles Rekapi and defines Rekapi.prototype.createTimeline. All you need is a DOM element to insert the timeline into:

<div id="rekapi-timeline"></div>
<div id="animation">
  <div id="actor-1" class="actor" style="background: #bada55; height: 150px; width: 150px;"></div>
</div>

import { Rekapi } from  'rekapi-timeline';

const timelineEl = document.querySelector('#rekapi-timeline');
const rekapi = new Rekapi(document.body);

const actor = rekapi.addActor({
  context: document.querySelector('#actor-1')
});

const timeline = rekapi.createTimeline(timelineEl);

This library exposes a UMD module named 'rekapi-timeline' that exports the rekapi classes.

License

MIT