react-chrono

A timeline component for React

Features

• Modes - Layout the timeline either Vertically or Horizontally using the mode prop.
• Tree - In Tree mode the timeline cards are alternated between left and right.
• Slideshow - Play the timeline automatically with the slideShow prop.
• Keyboard Support - The timeline can be navigated with the UP , DOWN keys in vertical or tree mode. In horizontal mode LEFT , RIGHT keys can be used for navigation. Quickly jump to the start or end of the timeline by using the HOME or END key.
• Custom theme - Customize the colors using the theme prop

Installation

yarn install react-chrono

Getting Started

Please make sure you wrap the component in a container that has a width and height. When no mode is specified, the component defaults to HORIZONTAL.

Use the items prop to create the timeline. Each Timeline item must have the following properties.

title, contentTitle, contentText, contentDetailedText

  const items = [{
    title: "May 1940",
    contentTitle: "Dunkirk",
    contentText:"Men of the British Expeditionary Force (BEF) wade out to a destroyer during the evacuation from Dunkirk.",
    contentDetailedText: "On 10 May 1940, Hitler began his long-awaited offensive in the west...",
  }, ...];

  <div style={{ width: "500px", height: "400px" }}>
    <chrono items={items} />
  </div>

Vertical

  <div style={{ width: "500px", height: "950px" }}>
    <chrono
      items={items}
      mode="VERTICAL"
    />
  </div>

Tree

  <div style={{ width: "500px", height: "950px" }}>
    <chrono
      items={items}
      mode="TREE"
    />
  </div>

Slideshow

Play the timeline automatically with the slideShow mode.

  <div style={{ width: "500px", height: "950px" }}>
    <chrono
      items={items}
      mode="TREE"
      slideShow
    />
  </div>

Props

name	description	default
mode	sets the layout for the timeline component. can be HORIZONTAL, VERTICAL or TREE	HORIZONTAL
items	collection of timeline items
disableNavOnKey	disables timeline navigation through keyboard	false
slideShow	starts the timeline in slideshow mode
slideItemDuration	delay between timeline points during a slideshow	2500
titlePosition	sets the position of the title in HORIZONTAL mode	TOP
itemWidth	width of the timeline section in HORIZONTAL mode	320

Mode

react-chrono supports three modes HORIZONTAL, VERTICAL and TREE. The mode prop can be used to define the orientation of the cards.

Keyboard Navigation & Disabling it

The timeline by default can be navigated via keyboard.

• For HORIZONTAL mode use your LEFT RIGHT arrow keys for navigation.
• For VERTICAL or TREE mode, navigation can be done via the UP DOWN arrow keys.
• To easily jump to the first item or the last item in the timeline, use HOME or END key.

The keyboard navigation can be completely disabled by setting the disableNavOnKey to true.

  <chrono items={items} disableNavOnKey />

Slideshow Mode

Slideshow can be enabled by setting the slideShow prop to true. You can also set an optional slideItemDuration that sets the time delay between cards.

  <chrono items={items} slideShow slideItemDuration={4500} />

Title Position

This setting only applies for the HORIZONTAL mode. The prop titlePosition sets the position of the individual titles to either TOP or BOTTOM.

  <chrono items={items}  titlePosition="BOTTOM" />

Item Width

The itemWidth prop can be used to set the width of each individual timeline sections. This setting is applicable only for the HORIZONTAL mode.

Built with

• ReactJS - The Component is written in React and Typescript.

Meta

Prabhu Murthy – @prabhumurthy2 – [e-mail]

Distributed under the MIT license. See LICENSE for more information.

https://github.com/prabhuingoto/