Code Monkey home page Code Monkey logo

react-horizontal-timeline's Introduction

#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] (http://jckdrpr.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 upto 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 undefind sorted array of dates (format:mm/dd/yyyy) (required)
indexCLick function undefind 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)
eventsMinDistance number 80 The minimum distance between consecutive events
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', maxSize: 800 } object containging the styles for the timeline currently outline (the color of the boundries of the thimeline and the buttons on it's either side), foreground (the filling color, active color) and background (the background color of your page) colors along with the max length of the timeline can be changed.

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:5000/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

react-horizontal-timeline's People

Contributors

nixypanda avatar claudia-romano avatar rohitrehan avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.