zeitline v0.1.1

Zeitline

Zeitline is a flexible timeline implemented in D3.

Please don't forget to check the Zeitline documentation for more information.

Installing

If you use NPM or Yarn, you can simply install Zeitline like that:

npm install zeitline
or
yarn add zeitline

Otherwise, you can download the UMD release (in the dist folder).

Example to use Zeitline in vanilla javascript:

<script src="zeitline.bundle.min.js"></script>
<script>
var t = new Zeitline.Timeline();
t.render();
</script>

Example to use Zeitline in ES6:

import {Timeline} from 'Zeitline';

let t = new Timeline(conf);
t.render();

Getting started

To instantiate the timeline, simple import Timeline from Zeitline. An optional configuration can be passed in the constructor Timeline(configuration: object).

import {Timeline} from 'Zeitline';

// instantiate the timeline with an optional configuration
let t = new Timeline({/* config */});

To render the timeline, use the render() function.

// render the timeline
t.render();

To update the timeline with a new configuration, use the update(configuration: object) function and pass the new configuration.

// update the timeline with a new configuration
t.update({/* config */});

For more information about the configuration, please check the documentation.

Dev

Firstly you need to install all the dependencies

npm install
or
yarn install

Running the dev server

Simply run the dev script with

npm run dev
or
yarn dev

The project is then served on http://localhost:8080/

Build the project

To build Zeitline, run the build script

npm run build
or
yarn build

It will will build two files; ./dist/zeitline.bundle.js and the minified version ./dist/zeitline.bundle.min.js.

Tests

Test can be run with the test script.

npm run test
or
yarn test