cs-react-horizontal-timeline

    1.0.1 • Public • Published

    React Horizontal Timeline

    npm version Build Status Code Climate Dependency Status devDependency Status

    A react port of the horizontal time-line developed by CodyHouse. Here is a demo 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 array undefined sorted array of dates (format:mm/dd/yyyy) (required)
    indexClick function undefined function that takes the index of the array as argument (required)
    index number 0 the index of the selected date (useful if you want to control the selected date from outside like in case of react-swipeable-views)
    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' } 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.
    isTouchEnabled boolean true Enable touch events (swipe left, right)
    isKeyboardEnabled boolean true Enable keyboard events (up, down, left, right)

    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>
            <HorizontalTimeline
              indexClick={(index) => {
                this.setState({ value: index, previous: this.state.value });
              }}
              values={ VALUES } />
            <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.

    Todo

    • Start using react-motion to simplify code a bit.
    • Arrows on the buttons on either side.
    • Start using some solution for css (e.g. ReactCSS, ReactStyle, etc..).
    • Make it more customizable.
    • Improve the structure.
    • Keyboard movement controls
    • Touch controls
    • Customizable date points/event names/tooltip on the timeline
    • Make someone use it. :D

    Running the developmnt version

    • Just clone the repo and do an npm install followed by an npm run 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

    Demo

    Terms

    Install

    npm i cs-react-horizontal-timeline

    DownloadsWeekly Downloads

    3

    Version

    1.0.1

    License

    MIT

    Last publish

    Collaborators

    • cs_team