1.0.10 • Published 4 years ago

react-crono v1.0.10

Weekly downloads
20
License
MIT
Repository
-
Last release
4 years ago

DeepScan grade Depfu

logo

A timeline component for React

Features

  • Timeline modes - The component supports multiple modes to layout the timeline either Vertically or Horizontally.
  • Tree Mode - In Tree mode the individual timeline content boxes are alternated between left and right.
  • Timeline QuickScroll - The QuickScroll allows to jump through the Timeline items swiftly. QuickScroll is by default enabled on all the Modes.
  • Slideshow - The Slideshow starts the component in Slideshow mode. The component automatically plays the series for you.
  • QuickJump - Quickly jump to the start or end of the timeline by using the HOME or END key.
  • Keyboard Support - The timelines can be navigated with the UP , DOWN keys in vertical or tree mode. In horizontal mode LEFT , RIGHT keys can be used for navigation.

Installation

yarn install react-crono

Getting Started

react-crono has some great defaults to get you started quickly.

  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 by invading neutral Holland and Belgium and attacking northern France...",
  }, ...];

  <Crono items={items} />

app-home

Tree

react-crono also supports a Tree mode.

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

Slideshow

  <Crono
    items={items}
    mode="TREE"
    slideShow
  />

app-tree

Props

namedescriptiondefault
modesets the layout for the timeline component. can be HORIZONTAL, VERTICAL or TREEHORIZONTAL
disableNavOnScrolldisables timeline navigation through mouse scrollfalse
disableNavOnKeydisables timeline navigation through keyboardfalse
slideShowstarts the timeline in slideshow
slideItemDurationdelay between timeline points during a slideshow2500
titlePositionsets the position of the title in HORIZONTAL modeTOP
itemWidthwidth of the timeline section in HORIZONTAL mode320

Built with

Meta

Prabhu Murthy – @prabhumurthy2 – prabhu.m.murthy@gmail.com

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

https://github.com/prabhuingoto/

1.0.10

4 years ago

1.0.9

4 years ago

1.0.8

4 years ago

1.0.7

4 years ago

1.0.6

4 years ago

1.0.5

4 years ago

1.0.4

4 years ago

1.0.3

4 years ago

1.0.2

4 years ago

1.0.1

4 years ago