NProgress V2 and Next NProgress Bar become BProgress!
The nprogress-v2 and next-nprogress-bar packages remain available and usable in their current versions, but will no longer be maintained. We therefore advise you to migrate to @bprogress/core.
Go to the migration documentation
Add [index.js] and [index.css] to your project.
<script src="index.js"></script>
<link rel="stylesheet" href="index.css" />npm install nprogress-v2Also available via [unpkg] CDN:
- https://unpkg.com/[email protected]/dist/index.js
- https://unpkg.com/[email protected]/dist/index.css
Simply call start() and done() to control the progress bar.
NProgress.start();
NProgress.done();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.994Force-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
Changes the minimum percentage used upon starting. (default: 0.08)
NProgress.configure({ minimum: 0.1 });Changes the maximum percentage used upon finishing. (default: 1)
NProgress.configure({ maximum: 0.9 });You can change the markup using template. To keep the progress
bar working, keep an element with role='bar' in there.
NProgress.configure({
template: `<div class="bar" role="bar"><div class="peg"></div></div><div class="spinner" role="spinner"><div class="spinner-icon"></div></div>`,
});You can also set the template to null to use your own template in your code.
NProgress.configure({
template: null,
});In your code, you can use the following template:
<div class="nprogress">
<div class="bar" role="bar">
<div class="peg"></div>
</div>
<div class="spinner" role="spinner">
<div class="spinner-icon"></div>
</div>
</div>Note: You can add multiple templates in your code to have multiple progress bars.
Adjust animation settings using easing (a CSS easing string) and speed (in ms). (default: ease and 200)
NProgress.configure({ easing: 'ease', speed: 500 });Turn off the automatic incrementing behavior by setting this to false. (default: true)
NProgress.configure({ trickle: false });Adjust how often to trickle/increment, in ms.
NProgress.configure({ trickleSpeed: 200 });Turn off loading spinner by setting it to false. (default: true)
NProgress.configure({ showSpinner: false });Specify this to change the bar selector. (default: [role="bar"])
NProgress.configure({ barSelector: '.my-custom-bar' });Specify this to change the spinner selector. (default: [role="spinner"])
NProgress.configure({ spinnerSelector: '.my-custom-spinner' });Specify this to change the parent container. (default: body)
NProgress.configure({ parent: '#container' });Specify progress bar direction: ltr or rtl. (default ltr)
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!
If you encounter any problems, do not hesitate to open an issue or make a PR here.
MIT