nx
nprogress-x
npm i nprogress-x
nx

nprogress-x

Slim progress bars that you can append to any part of your DOM.

by Sílvia Mur Blanch

1.0.1 (see all)License:MITTypeScript:Not Found
npm i nprogress-x
Readme

NProgress-X

Slim progress bars that you can append to any part of your DOM.

Inspired by Google, YouTube, and Medium. Based on and forked from Rico Sta. Cruz's NProgress.

Introduction

I came across Rico Sta. Cruz's awesome NProgress while searching the web for cool tools to improve the looks and responsiveness of the web application my colleague codecoding and I were working on at the time. We had many many screens that displayed multiple controls which loaded data dynamically through AJAX requests. All these controls were independent from one another, and we thought it would be cool to display an animated progress bar on top of each of them. So we took Rico Sta. Cruz's NProgress, forked it, refactored it, added to it, and created our very own NProgress-X: a progress bar that you can append to any part of your DOM.

NOTE: NProgress-X is so different to the original NProgress (and purposely so) that I have never thought of doing a pull request on GitHub, and never will.

Installation

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

Basic usage

I refactored the original NProgress mainly for the purpose of having multiple instances of it at once on the same page, so NProgress-X must be instantiated in order to be used. Like this:

var np = new NProgress();

Configuration

I've kept most of the original settings and added a few more. Check them out.

minimum

Minimum percentage of increment. Default value is 0.05.

easing

CSS easing string for the animation settings. Default value is 'ease'.

speed

Animation speed in milliseconds. Default value is 200.

trickle

Set to false to turn off the trickling (automatic progress increment). True by default.

trickleRate

How much to increase per trickle. Default value is 0.02.

trickleSpeed

How often to trickle, in milliseconds. Default value is 800.

container

jQuery selector of the container DOM element. The progress bar will be PREPENDED TO this container (this means it will be inserted as the first child of the container element). If you do not set this parameter -or if you use the selector 'body'- the progress bar will be inserted BEFORE the body (on the very top of the page).

renderOnInit

Set to true to render the progress bar upon instantiation (though it will remain hidden until the progress is set). False by default.

removeOnFinish

Set to true to remove the progress bar from the DOM when it reaches 100%. If you're gonna be reusing it a lot, you might as well leave it there -hidden- rather than creating it every time you want to display it. True by default.

randomTrickle

Set to true to use random trickle increments. False by default.

startOnInit

Set to true to start running the progress bar's progress upon instantiation. False by default.

template

HTML markup used to render the progress bar. To keep the progress bar working, keep an element with role='bar' in there.

Example:

var np = new NProgress({
    minimum: 0.08,
    easing: 'linear',
    speed: 500,
    trickle: true,
    trickleRate: 0.05,
    trickleSpeed: 500,
    container: '#divContainer',
    renderOnInit: true,
    removeOnFinish: false,
    startOnInit: true,
    template: '<div class="foo" role="bar"></div>'
});

Methods

configure

Override the initial configuration of an nprogress instance anytime by using this method.

var np = new NProgress();
np.configure({
    trickleRate: 0.05,
    trickleSpeed: 500,
    startOnInit: true
});

set

Sets the progress bar status, where n is a number from 0.0 to 1.0.

isStarted

This method will tell you whether the progress bar is already running or not.

start

Shows the progress bar. This is the same as setting the status to 0%, except that it doesn't go backwards.

done

Hides the progress bar. This is sort of the same as setting the status to 100%, with the difference being .done() makes some placebo effect of some realistic motion by executing an animation. 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 the progress bar is not started.

stop

Actually it's just a call to .reset(), which stops the progress bar's progress regardless of what its current status is. But the name is more intuitive and the purpose of this is to give the idea that something went wrong and therefore the progress bar could not reach its 100% successfully.

pause

Pause the progress bar's progress. It will start running again and pick up from where it left off by calling .keepGoing().

keepGoing

Starts running the progress bar's progress again after it's been paused. It picks up status from where it left off.

reset

Reset's the progress bar after it's done, so it can start running again anytime.

inc

Increments the progress bar's percentage by a specific amount.

trickle

Increments the progress bar's percentage by the specified trickleRate if randomTrickle was set to false, or by a random amount if randomTrickle was set to true.

remove

Removes the progress bar from the DOM. Opposite of .render().

demo

Runs the progress bar in demo mode.

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.

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!

Acknowledgements

Give credit where it's due!

The original NProgress is authored and maintained by Rico Sta. Cruz with help from his contributors. You will probably acknowledge that I've taken many definitions straight from Rico's source code comments, and also taken some design ideas and styles from his project's website. But I've done it with the purpose of paying homage to him, not for plagiarism!

Downloads/wk

3

GitHub Stars

10

LAST COMMIT

6yrs ago

MAINTAINERS

1

CONTRIBUTORS

8

OPEN ISSUES

0

OPEN PRs

0
VersionTagPublished
1.0.1
latest
6yrs ago
No alternatives found
No tutorials found
Add a tutorial