Skip to content
This repository has been archived by the owner on Oct 20, 2020. It is now read-only.

JSainsburyPLC/react-timelines

Repository files navigation

React Timelines

Demo

Install

# with npm
npm install react-timelines

# or with Yarn
yarn add react-timelines

Use

import Timeline from 'react-timelines'

const MyWidget = () => <Timeline {...props} />

export default MyWidget

Styling

Using Webpack

Using Webpack with CSS loader, add the following:

import 'react-timelines/lib/css/style.css'

Using Sass (SCSS)

Using Sass you can configure the timeline with variables:

$react-timelines-font-family: MaryAnn;
$react-timelines-sidebar-width: 320px;

@import '~/react-timelines/src/scss/style';

Without build tools

Create a CSS file with the contents of react-timelines/lib/css/style.css and include it in <head>

Development

npm install
npm run watch

This library is developed using VSCode - opening it in VSCode will recommend extensions, and enable linting and auto-formatting of code.