What is nprogress?
The nprogress npm package is a lightweight JavaScript library for creating slim and beautiful progress bars. It is often used to indicate the progress of page loads or asynchronous operations. The library is highly customizable and easy to integrate into web projects.
What are nprogress's main functionalities?
Basic Progress Bar
This code demonstrates how to start and complete the progress bar. `NProgress.start()` initiates the progress bar at the top of the page, and `NProgress.done()` completes the progress and removes the bar.
NProgress.start();
// Some loading process goes here
NProgress.done();
Setting a Specific Progress
This code snippet shows how to set the progress bar to a specific percentage. The `NProgress.set()` function takes a decimal number between 0 and 1 to set the progress accordingly.
NProgress.set(0.4); // Sets the progress bar to 40%
Incremental Progress
This demonstrates how to incrementally increase the progress bar. The `NProgress.inc()` function increases the progress by a small, random amount. This is useful for indicating progress when the exact time to completion is unknown.
NProgress.inc(); // Increments the progress bar by a little
Configuration
This code snippet shows how to configure the behavior and appearance of the progress bar. In this example, the minimum size of the bar is set to 10%, and the spinner is disabled.
NProgress.configure({ minimum: 0.1, showSpinner: false });
Other packages similar to nprogress
pace-js
Pace is a similar package that automatically monitors your ajax requests, event loop lag, document ready state, and elements on your page to decide the progress. Compared to nprogress, Pace provides more automatic progress detection features but might be more intrusive in its default configuration.
topbar
Topbar is another lightweight library for creating a top progress bar. Similar to nprogress, it's easy to use and customize. However, Topbar focuses more on simplicity and has fewer configuration options compared to nprogress.
NProgress
Slim progress bars for Ajax'y applications. Inspired by Google, YouTube, and
Medium.
Installation
Add nprogress.js and nprogress.css to your project.
<script src='nprogress.js'></script>
<link rel='stylesheet' href='nprogress.css'/>
NProgress is available via bower and npm and spm.
$ bower install --save nprogress
$ npm install --save nprogress
Basic usage
Simply call start()
and done()
to control the progress bar.
NProgress.start();
NProgress.done();
Using Turbolinks or similar? Ensure you're using Turbolinks 1.3.0+, and use
this: (explained
here)
$(document).on('page:fetch', function() { NProgress.start(); });
$(document).on('page:change', function() { NProgress.done(); });
$(document).on('page:restore', function() { NProgress.remove(); });
Ideas
Advanced usage
Percentages: To set a progress percentage, call .set(n)
, where n is a
number between 0..1
.
NProgress.set(0.0);
NProgress.set(0.4);
NProgress.set(1.0);
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);
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 });
trickleRate
and trickleSpeed
You can adjust the trickleRate (how much to increase per trickle) and
trickleSpeed (how often to trickle, in ms).
NProgress.configure({ trickleRate: 0.02, trickleSpeed: 800 });
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
)
NProgress.configure({ parent: '#container' });
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!
Resources
Support
Bugs and requests: submit them through the project's issues tracker.
Questions: ask them at StackOverflow with the tag nprogress.
Chat: join us at gitter.im.
![Chat](http://img.shields.io/badge/gitter-rstacruz / nprogress-brightgreen.svg)
Thanks
NProgress © 2013-2014, Rico Sta. Cruz. Released under the MIT License.
Authored and maintained by Rico Sta. Cruz with help from contributors.
ricostacruz.com ·
GitHub @rstacruz ·
Twitter @rstacruz