Skip to content

Latest commit

 

History

History
147 lines (104 loc) · 3.66 KB

Readme.md

File metadata and controls

147 lines (104 loc) · 3.66 KB
Raw

NProgress

Slim progress bars for Ajax'y applications. Inspired by Google, YouTube, and Medium.

Status

Installation

Add jQuery (1.8 or above), nprogress.js and nprogress.css to your project.

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

  • Add progress to your Ajax calls! Bind it to the jQuery ajaxStart and ajaxStop events.

  • Make a fancy loading bar even without Turbolinks/Pjax! Bind it to $(document).ready and $(window).load.

Advanced usage

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

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

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

Configuration

Change the minimum percentage using minimum.

NProgress.configure({ minimum: 0.1 });

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='....'>...</div>"
});

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

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

Want to turn off trickling? Set trickle to false.

NProgress.configure({ trickle: false });

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

Want to turn off loading spinner? Set showSpinner to false.

NProgress.configure({ showSpinner: false });

Customization

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

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

Resources

Acknowledgements

© 2013, Rico Sta. Cruz. Released under the MIT License.

NProgress is authored and maintained by Rico Sta. Cruz with help from its contributors