react-chrono

Try it on CodeSandbox!

Features

• 🚥 Render timelines in three different modes (Horizontal, Vertical, Tree).
• 🌲  Use the Tree mode to layout the timeline cards vertically in a tree like fashion.
• 📺  Auto play the timeline with the slideshow mode.
• 🖼️  Display images in the timeline with ease.
• ⌨  Navigate the timeline via Keyboard.
• 🔧  Optimized to render images efficiently on (tree & vertical mode). Images not visible are automatically hidden.
• 🎨  Customize colors with ease.
• 💪  Built with Typescript.

Table of Contents

• ⚡ Installation
• 🚀 Getting Started
  • Vertical Mode
  • Tree View
  • Slideshow
• Props
  • Mode
  • Timeline item Model
  • ⌨ Keyboard Navigation & Disabling it
  • Slideshow Mode
  • Item Width
  • 🎨 Theme
• 📦Build Setup
• 🔨 Contributing
• 🧱 Built with
• 🔭 What's coming next
• Meta

⚡ 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 mode. Please check props for all the available options.

  const Home = () => {
    const items = [{
      title: "May 1940",
      contentTitle: "Dunkirk",
      contentText:"Men of the British Expeditionary Force (BEF) wade out to..",
      media: {
        type: "IMAGE",
        source: {
          url: "http://someurl/image.jpg"
        }
      }
    }, ...];

    return (
      <div style={{ width: "500px", height: "400px" }}>
        <chrono items={items} cardHeight={300} />
      </div>
    )
  }

Vertical Mode

To render the timeline vertically use the VERTICAL mode

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

Tree View

In Tree mode the timeline is rendered vertically with cards alternating between left and right side.

  <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}
      slideShow
      mode="TREE"
    />
  </div>

Props

name	description	default
mode	sets the layout of the component. can be HORIZONTAL, VERTICAL or TREE	HORIZONTAL
items	collection of timeline items. This should be a collection of Timeline Item Model	[]
disableNavOnKey	prop to disable keyboard navigation.	false
slideShow	starts the timeline in slideshow mode.	false
slideItemDuration	The amount of delay in ms for the timeline points in slideshow mode.	2500
itemWidth	width of the timeline section in HORIZONTAL mode.	300
cardHeight	sets the minimum height of the timeline card.	250
theme	prop to customize the colors.

Mode

react-chrono supports three modes HORIZONTAL, VERTICAL and TREE. No additional setting is required.

  <chrono items={items} mode="HORIZONTAL" />

  <chrono items={items} mode="VERTICAL" />

  <chrono items={items} mode="TREE" />

Timeline item Model

name	description	type
title	title of the timeline item	String
contentTitle	title that is displayed on the timeline card	String
contentText	text displayed in the timeline card	String
media	media object to set image.	Object

{
  title: "May 1940",
  contentTitle: "Dunkirk",
  media: {
    name: "dunkirk beach",
    source: {
      url: "http://someurl/image.jpg"
    },
    type: "IMAGE"
  },
  contentText:
    "Men of the British Expeditionary Force (BEF) wade out to a destroyer during the evacuation from Dunkirk."
}

⌨ Keyboard Navigation & Disabling it

The timeline can be navigated via keyboard.

• For HORIZONTAL mode use your LEFT RIGHT arrow keys for navigation.
• For VERTICAL or TREE mode, the timeline can be navigated 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.

To disable eyboard navigation set 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} />

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.

🎨 Theme

Customize colors with theme prop.

<chrono items={items}  titlePosition="BOTTOM" theme={{primary: "red", secondary: "blue" }} />

📦Build Setup

# install dependencies
yarn install

# start dev setup
yarn run start

# run css linting
yarn run lint:css

# package lib
yarn run rollup

🔨 Contributing

1. Fork it ( https://github.com/prabhuignoto/react-chrono/fork )
2. Create your feature branch (git checkout -b new-feature)
3. Commit your changes (git commit -am 'Add feature')
4. Push to the branch (git push origin new-feature)
5. Create a new Pull Request

🧱 Built with

• The Component is written in React and Typescript.
• Styled with emotion.

🔭 What's coming next

• Support for Mobile devices & Tablets (responsive).
• Support for embedding videos.

Meta

Prabhu Murthy – @prabhumurthy2 – [e-mail]

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

https://github.com/prabhuingoto/