react-vertical-timeline

vertical timeline bar with bookmarks support

Demonstration

Documentation

react-vertical-timeline - Vertical progress bar with bookmarks support

Basic Usage

Testing - npm test and npm run tdd - Runs Karma/Mocha/Chai/Phantom. Code coverage report is generated through istanbul/isparta to build/.

Developing - npm start - Runs the development server at localhost:8080 and use Hot Module Replacement. You can override the default host and port through env (HOST, PORT).

  • Linting - npm run lint - Runs ESLint.
  • Testing - npm test and npm run tdd - Runs Karma/Mocha/Chai/Phantom. Code coverage report is generated through istanbul/isparta to build/.

  • Developing - npm start - Runs the development server at localhost:8080 and use Hot Module Replacement. You can override the default host and port through env (HOST, PORT).

  • Creating a version - npm version <x.y.z> - Updates /dist and package.json with the new version and create a version tag to Git.
  • Publishing a version - npm publish - Pushes a new version to npm and updates the project site.

If you don’t want to use universal rendering for the React portion, set RENDER_UNIVERSAL to false at webpack.config.babel.js.

Testing

The test setup is based on Karma/Mocha/Chai/Phantom. Code coverage report is generated through istanbul/isparta to build/.

  • Running tests once - npm test
  • Running tests continuously npm run test:tdd
  • Linting - npm run test:lint - Runs ESLint.

Demo Site

The boilerplate includes a GitHub Pages specific portion for setting up a demo site for the component. The main commands handle with the details for you. Sometimes you might want to generate and deploy it by hand, or just investigate the generated bundle.

  • Building - npm run gh-pages - Builds the demo into ./gh-pages directory.
  • Deploying - npm run deploy-gh-pages - Deploys the contents of ./gh-pages to the gh-pages branch. GitHub will pick this up automatically. Your site will be available through *<user name>.github.io/<project name>`.
  • Generating stats - npm run stats - Generates stats that can be passed to webpack analyse tool. This is useful for investigating what the build consists of.

Highlighting Demo for the Site

<Timeline height={300} progress={50} onSelect={fn..}>
  <Bookmark progress={20} onSelect={fn..}>
    Hi there 20%
  </Bookmark>
  <Bookmark progress={55} onSelect={fn..}>
    Hi there 55%
  </Bookmark>
  <Bookmark progress={75} onSelect={fn..}>
    Hi there 75%
  </Bookmark>
</Timeline>

License

react-vertical-timeline is available under MIT. See LICENSE for more details. Based on react-component-boilerplate