npm package: @nhuthuy96/react-horizontal-timeline
Description: A horizontal timeline component made using react
Author: Thuy Nguyen
Latest version: 1.6.2

# React Horizontal Timeline

This project if forked for my personal usage, I modified... things from the source code  
[![npm version](https://badge.fury.io/js/%40nhuthuy96%2Freact-horizontal-timeline.svg)](https://badge.fury.io/js/%40nhuthuy96%2Freact-horizontal-timeline)
[![Dependency Status](https://david-dm.org/WaterNguyen96/react-horizontal-timeline.svg)](https://david-dm.org/WaterNguyen96/react-horizontal-timeline.svg)
[![devDependency Status](https://david-dm.org/WaterNguyen96/react-horizontal-timeline/dev-status.svg)](https://david-dm.org/WaterNguyen96/react-horizontal-timeline/dev-status#info=devDependencies)

A react port of the horizontal time-line developed by CodyHouse.
Here is a [demo](http://sherubthakur.github.io/react-horizontal-timeline) I hope you too are a fan of the elder scrolls.

## HorizontalTimeline

It will just render a timeline with the dates that you provided and it is up to you what to do when a date is selected. i.e. it will give you the index of the date that was clicked and you can do anything with it.

| Property                  | Type     | Default                                                                                       | Description                                                                                                                                                                                                                                                                                                                                                                               |
| :------------------------ | :------- | :-------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| values (**required**)     | array    | undefined                                                                                     | **sorted** array of dates (format:**yyyy-mm-dd**)                                                                                                                                                                                                                                                                                                                                         |
| indexClick (**required**) | function | undefined                                                                                     | function that takes the index of the array as argument                                                                                                                                                                                                                                                                                                                                    |
| index (**required**)      | number   | undefined                                                                                     | the index of the selected date                                                                                                                                                                                                                                                                                                                                                            |
| getLabel                  | function | date.toDateString().substring(4)                                                              | A function to calculate the label of the event based on the date of the event                                                                                                                                                                                                                                                                                                             |
| minEventPadding           | number   | 20                                                                                            | The minimum padding between two event labels                                                                                                                                                                                                                                                                                                                                              |
| maxEventPadding           | number   | 120                                                                                           | The maximum padding between two event labels                                                                                                                                                                                                                                                                                                                                              |
| linePadding               | number   | 100                                                                                           | Padding used at the start and end of the timeline                                                                                                                                                                                                                                                                                                                                         |
| labelWidth                | number   | 85                                                                                            | The width of an individual label                                                                                                                                                                                                                                                                                                                                                          |
| fillingMotion             | object   | { stiffness: 150, damping: 25 }                                                               | Sets the animation style of how filling motion will look                                                                                                                                                                                                                                                                                                                                  |
| slidingMotion             | object   | { stiffness: 150, damping: 25 }                                                               | Sets the animation style of how sliding motion will look                                                                                                                                                                                                                                                                                                                                  |
| styles                    | object   | { background: '#f8f8f8', foreground: '#7b9d6f', outline: '#dfdfdf' , noLinearGradient: false} | object containing the styles for the timeline currently outline (the color of the boundaries of the timeline and the buttons on it's either side), foreground (the filling color, active color) and background (the background color of your page) colors of the timeline can be changed, noLinearGradient determine whenever to draw linear gradient color in li.style:background-image. |
| isTouchEnabled            | boolean  | true                                                                                          | Enable touch events (swipe left, right)                                                                                                                                                                                                                                                                                                                                                   |
| isKeyboardEnabled         | boolean  | true                                                                                          | Enable keyboard events (up, down, left, right)                                                                                                                                                                                                                                                                                                                                            |
| isOpenBeginning           | boolean  | true                                                                                          | Show the beginning of the timeline as open ended                                                                                                                                                                                                                                                                                                                                          |
| isOpenEnding              | boolean  | true                                                                                          | Show the ending of the timeline as open ended                                                                                                                                                                                                                                                                                                                                             |

This is how it can be used.

```
const VALUES = [ /* The date strings go here */ ];

export default class App extends React.Component {
  state = { value: 0, previous: 0 };

  render() {
    return (
      <div>
        {/* Bounding box for the Timeline */}
        <div style={{ width: '60%', height: '100px', margin: '0 auto' }}>
          <HorizontalTimeline
            index={this.state.value}
            indexClick={(index) => {
              this.setState({ value: index, previous: this.state.value });
            }}
            values={ VALUES } />
        </div>
        <div className='text-center'>
          {/* any arbitrary component can go here */}
          {this.state.value}
        </div>
      </div>
    );
  }
}

```

For more advanced usage take a look at the demos directory.

## Running the development version

- Just clone the repo and do an `npm install` (or `yarn install`)
- Note: You will need to do `npm install react react-dom` to install `peerDependencies` as both `yarn` and `npm` don't do this.
- Run `npm run start`/`npm start`/`yarn start`.
- Then go to `localhost:5001/demos/<demo_name>/index.html` to see the fruits of your labor.

#### Here is the information provided by the original author.

An easy to customize, horizontal timeline powered by CSS and jQuery.

[Article on CodyHouse](http://codyhouse.co/gem/horizontal-timeline/)

[Demo](https://codyhouse.co/demo/horizontal-timeline/index.html)

[Terms](http://codyhouse.co/terms/)