NProgress V2

NProgress, which has not been maintained for over 4 years, requires a maintained V2 with recent code.

Installation

Add [index.js] and [index.css] to your project.

<script src="index.js"></script>
<link rel="stylesheet" href="index.css" />

npm install nprogress-v2

Also available via [unpkg] CDN:

• https://unpkg.com/[email protected]/dist/index.js
• https://unpkg.com/[email protected]/dist/index.css

Basic usage

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.

NProgress.set(0.0); // Sort a same as .start()
NProgress.set(0.4);
NProgress.set(1.0); // Sort a 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 });

maximum

Changes the maximum percentage used upon finishing. (default: 1)

NProgress.configure({ maximum: 0.9 });

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 });

barSelector

Specify this to change the bar selector. (default: [role="bar"])

NProgress.configure({ barSelector: '.my-custom-bar' });

spinnerSelector

Specify this to change the spinner selector. (default: [role="spinner"])

NProgress.configure({ spinnerSelector: '.my-custom-spinner' });

parent

Specify this to change the parent container. (default: body)

NProgress.configure({ parent: '#container' });

direction

Specify progress bar direction: ltr or rtl. (default ltr)

Customization

Just edit index.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!

Issues

If you encounter any problems, do not hesitate to open an issue or make a PR here.

LICENSE

MIT