Skip to content

bespokejs/bespoke-progress

Repository files navigation

Build Status Coverage Status

bespoke-progress

Progress Bar for Bespoke.js

Download

Download the production version or the development version, or use a package manager.

Usage

This plugin is shipped in a UMD format, meaning that it is available as a CommonJS/AMD module or browser global.

For example, when using CommonJS modules:

var bespoke = require('bespoke'),
  progress = require('bespoke-progress');

bespoke.from('article', [
  progress()
]);

When using browser globals:

bespoke.from('article', [
  bespoke.plugins.progress()
]);

Two elements will be added to your presentation: a progress bar, and a container for it.

By default, the .bespoke-progress-bar element's width will be dynamically set to a percentage width.

If you'd prefer a vertical progress bar, simply specify 'vertical' as the plugin option:

bespoke.from('article', [
  progress('vertical')
]);

CSS

The following classes are available on the generated progress elements.

bespoke-progress-parent The progress bar's parent element
bespoke-progress-bar The progress bar

Package managers

npm

$ npm install bespoke-progress

Bower

$ bower install bespoke-progress

Credits

This plugin was built with generator-bespokeplugin.

License

MIT License