🌜
🌞
@knight-lab/timelinejs

@knight-lab/timelinejs

v3.8.18

TimelineJS v3: A Storytelling Timeline built in JavaScript, made by Northwestern University Knight Lab.

npm install @knight-lab/timelinejs

README

TimelineJS3

TimelineJS v3: A Storytelling Timeline built in JavaScript. https://timeline.knightlab.com

Overview

TimelineJS is a tool designed to help people with minimal technical skill tell rich, dynamic stories on the web. Most people will create timelines using the official authoring tool and embed their creations using a snip of HTML code offered at the end of that process.

For users of these content management systems (CMSes), there are plugins to facilitate the embedding process:

Getting Started

General users of TimelineJS should consult timeline.knightlab.com for instructions and documentation. Information on GitHub is primarily directed at those who are interested in working with the TimelineJS source code.

The authoritative documentation list is also on the main website, but here are some direct links which may be useful:

Contributing to TimelineJS

Are you trying to contribute to or develop TimelineJS3? Here's where you should start.

API

For users who instantiate a timeline in a page (as opposed to using the iframe embed model), this page roughly documents TimelineJS's JavaScript API, but note that because TimelineJS's primary use case is the embedded iframe, some of these methods have not been thoroughly tested.

Use via ES6 modules/webpack

To use in a project that uses ES6 modules and webpack, import the Timeline class and the CSS as follows

import { Timeline } from '@knight-lab/timelinejs';
import '@knight-lab/timelinejs/dist/css/timeline.css';

General

License
MPL-2.0
Typescript Types
None found
Tree-shakeable
No

Popularity

GitHub Stargazers
2,579
Community Interest
2,964
Number of Forks
569

Maintenance

Commits
11/2110/22045
Last Commit
Open Issues
170
Closed Issues
492
Open Pull Requests
2
Closed Pull Requests
33

Versions

Versions Released
11/2110/2201
Latest Version Released
Jun 8, 2021
Current Tags
latest3.8.18

Contributors

JoeGermuska
JoeGermuska
Commits: 684
zachwise
zachwise
Commits: 308
hbillings
hbillings
Commits: 130
scott2b
scott2b
Commits: 70
mazhang2718
mazhang2718
Commits: 26
thehandsomepanther
thehandsomepanther
Commits: 26
bdin
bdin
Commits: 19
rosaliechan
rosaliechan
Commits: 16
ashwu
ashwu
Commits: 7
Hammatt
Hammatt
Commits: 6
sehmon
sehmon
Commits: 6
songpatriciaa
songpatriciaa
Commits: 6
bronzehedwick
bronzehedwick
Commits: 5
AditiBhandari
AditiBhandari
Commits: 4
binary-koan
binary-koan
Commits: 3