lost-civilizations-timeline

lost-civilizations-timeline

A JavaScript library for visualizing timelines of lost civilizations using vis-timeline and d3. This library allows you to easily create interactive timelines to explore events from civilizations long gone.

Installation

To use lost-civilizations-timeline in your project, run:

npm install lost-civilizations-timeline

Ensure you have vis-timeline, d3, and moment installed as they are peer dependencies:

npm install vis-timeline d3 moment

Usage

First, import LostCivilizationsTimeline into your project:

import LostCivilizationsTimeline from 'lost-civilizations-timeline';

Then, initialize the timeline by providing a container ID and an array of events:

const events = [
{
id: 1,
name: 'The Rise of Atlantis',
startDate: '2020-01-01',
endDate: '2020-12-31'
},
// Add more events here
];

new LostCivilizationsTimeline('timeline-container', events);

Ensure you have a div with the id timeline-container in your HTML:

<div id="timeline-container"></div>

API

Constructor

LostCivilizationsTimeline(containerId, events)

• containerId: String. The ID of the DOM element where the timeline will be rendered.
• events: Array. An array of event objects to be displayed on the timeline. Each event object should have the following properties:
  • id: Unique identifier for the event.
  • name: The name or title of the event.
  • startDate: The start date of the event in YYYY-MM-DD format.
  • endDate: (Optional) The end date of the event in YYYY-MM-DD format. If not provided, the event will be displayed as a point.

Event Object Properties

• id: Number or String. A unique identifier for the event.
• name: String. The name or description of the event.
• startDate: String. The start date of the event in 'YYYY-MM-DD' format.
• endDate: String (optional). The end date of the event in 'YYYY-MM-DD' format. If not provided, the event is considered as a single point in time.

Contributing

We welcome contributions to lost-civilizations-timeline! Please open an issue or submit a pull request if you have a feature request, bug fix, or improvement.

License

This project is licensed under the MIT License - see the LICENSE file for details.