npm i react-event-timeline



React component to generate a responsive event timeline.

npm version Build Status codecov license

alt tag

See the storybook demo here:

CodeSandbox version to play with (in typescript):

Edit Timeline Example

Note: CodeSandbox version has styling and icons loaded in index.html for better presentation!


  • It's lightweight
  • Responsive and extensible

Getting started

To install the dependency

npm install --save react-event-timeline

or if you use yarn

yarn add react-event-timeline


The following snippet generates the timeline you see in the screenshot:

import {Timeline, TimelineEvent} from 'react-event-timeline'

            <TimelineEvent title="John Doe sent a SMS"
                           createdAt="2016-09-12 10:06 PM"
                           icon={<i className="material-icons md-18">textsms</i>}
                I received the payment for $543. Should be shipping the item within a couple of hours.
                title="You sent an email to John Doe"
                createdAt="2016-09-11 09:06 AM"
                icon={<i className="material-icons md-18">email</i>}
                Like we talked, you said that you would share the shipment details? This is an urgent order and so I
                    am losing patience. Can you expedite the process and pls do share the details asap. Consider this a
                    gentle reminder if you are on track already!

Please refer storybook to check out code for all the examples in the storybook folder.

API Documentation


This is the wrapper component that creates the infinite vertical timeline

classNamestringThe css class name of timeline container
styleobjectOverride inline styles of timeline container
orientationstringDisplay the timeline on right or left. Default: left
lineColorstringCSS color code to override the line color
lineStylestringOverride the appearance of line with custom css styling


Each event in the timeline will be represented by the TimelineEvent component. There can be multiple repeating instances of this component inside Timeline wrapper

titlenodeThe title of the event. Can be string or any DOM element node(s)
createdAtnodeThe time at which the event occurred. Can be datetime string or any DOM element node(s)
subtitlenodeIf you prefer having the title at the top and some caption below, omit createdAt and specify title and subtitle
iconnodeThe icon to show as event lable. Can be a SVG or font icon
iconStyleobjectCustom CSS styling for the icon
bubbleStyleobjectCustom CSS styling for the bubble containing the icon
buttonsnodeAction buttons to display to the right of the event content
contentStylenodeOverride content style
containerstringOptional value card will render event as a Card
styleobjectOverride style for the entire event container. Can be used to modify card appearance if container is selected as card
titleStyleobjectOverride style for the title content
subtitleStyleobjectOverride style for the subtitle content
cardHeaderStyleobjectOverride style for the card header if container is card
collapsiblebooleanMake the timeline event collapse body content
showContentbooleanif collapsible is true, should content be shown by default. false is default value


Use this component if your event footprint is too small and can be described in a single line

titlenodeThe title of the event. Can be string or any DOM element node(s)
iconnodeThe icon to show as event label. Can be a SVG or font icon
iconColorstringCSS color code for icon
iconStyleobjectCustom CSS styling for the icon
styleobjectOverride style for the entire event container

Refer to Condensed Timeline in Storybook for examples of using this component


This project recommends using react-storybook as a UI component development environment. Use the following scripts for your development workflow:

  1. npm run storybook: Start developing by using storybook
  2. npm run lint : Lint all js files
  3. npm run lintfix : fix linting errors of all js files
  4. npm run build: transpile all ES6 component files into ES5(commonjs) and put it in dist directory
  5. npm run docs: create static build of storybook in docs directory that can be used for github pages

The storybook artefacts can be found in stories folder. Run npm run storybook and you should see your code changes hot reloaded on the browser

Also use semantic-release to automate release to npm. Use npm run commit to commit your changes and raise a PR.



Jump To