NProgress

Minimalist progress bar

Slim progress bars for frontend applications.

Installation

version 1.0.0 and above

NProgress is an ES6 module available via npm.

$ npm install --save nprogress

Manual: Download the files and add nprogress.js and nprogress.css to your project.

<link rel='stylesheet' href='nprogress.css'/>
<script type="module">
  // Import the ES module
  import NProgressModule from './nprogress.js';
</script>

version 0.x.x

NProgress is an UMD module available via npm.

$ npm install --save nprogress

Manual: Download the files and add nprogress.js and nprogress.css to your project.

<script src='nprogress.js'></script>
<link rel='stylesheet' href='nprogress.css'/>

Basic usage

you should instantiate the progress bar from default import

var nprogress = NProgress();

then Simply call start() and done() to control the progress bar.

nprogress.start();
nprogress.done();

Advanced usage

Percentages: To set a progress percentage, call .set(n), where n is a number between 0..1.

var nprogress = NProgress();
nprogress.set(0.0);     // Sorta same as .start()
nprogress.set(0.4);
nprogress.set(1.0);     // Sorta same as .done()

Incrementing: To increment the progress bar, just use .inc(). This increments it with a random amount. This will never get to 100%: use it for every image load (or similar).

nprogress.inc();

If you want to increment by a specific value, you can pass that as a parameter:

nprogress.inc(0.2);    // This will get the current status value and adds 0.2 until status is 0.994

Force-done: By passing true to done(), it will show the progress bar even if it's not being shown. (The default behavior is that .done() will not do anything if .start() isn't called)

nprogress.done(true);

Get the status value: To get the status value, use .status

Configuration

minimum

Changes the minimum percentage used upon starting. (default: 0.08)

nprogress.configure({ minimum: 0.1 });

template

You can change the markup using template. To keep the progress bar working, keep an element with role='bar' in there. See the [default template] for reference.

nprogress.configure({
  template: "<div class='....'>...</div>"
});

easing and speed

Adjust animation settings using easing (a CSS easing string) and speed (in ms). (default: ease and 200)

nprogress.configure({ easing: 'ease', speed: 500 });

trickle

Turn off the automatic incrementing behavior by setting this to false. (default: true)

nprogress.configure({ trickle: false });

trickleSpeed

Adjust how often to trickle/increment, in ms.

nprogress.configure({ trickleSpeed: 200 });

showSpinner

Turn off loading spinner by setting it to false. (default: true)

nprogress.configure({ showSpinner: false });

parent

Specify this to change the parent container. (default: body). Can either specify a query selector (#id, .class, tag) or an HTMLElement directly.

nprogress.configure({ parent: '#container' });
// OR
var elt = document.getElementById('#container')
nprogress.configure({ parent: elt });

When you want to have multi progress bar in your page you need to give different parent for each

var nprogress1 = NProgress();
var nprogress2 = NProgress();

nprogress1.configure({ parent: '#container1' });
nprogress2.configure({ parent: '#container2' });

Customization

Just edit nprogress.css to your liking. Tip: you probably only want to find and replace occurrences of #29d.

The included CSS file is pretty minimal... in fact, feel free to scrap it and make your own!

Support

Bugs and requests: submit them through the project's issues tracker.

License

This is a fork from NProgress Released under the MIT License.