Skip to content

maximillianfx/react-timeline

Repository files navigation

React Timeline

Timeline component to React library

NPM version npm download Dependencies DevDependencies Build Status

Screenshot

Usage

Install the package

npm i ac-react-timeline

Import

import ReactTimeline from 'ac-react-timeline'

Add to your page

<ReactTimeline list={list}/>

The list parameter must be a list with the following content:

list = [
    {
      "id": 1,
      "text": "Stage 1",
      "actual": false,
      "completed": true
    },
    {
      "id": 2,
      "text": "Stage 2",
      "actual": true,
      "completed": false
    },
    {
      "id": 3,
      "text": "Stage 3",
      "actual": false,
      "completed": false
    }
]

Parameters description

Parameter Type Description
Id number Id element
Text string Label stage
Actual boolean The actual stage among all
Completed boolean Stage completed

License

ReactTimeline is released under the MIT license.