Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adding progress bar pause feature #195

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Adding progress bar pause feature #195

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
58da90e
Adding "pause" feature
jung-kim Jan 7, 2018
7976452
Adding test
jung-kim Jan 7, 2018
e3660a7
Adding tests
jung-kim Jan 7, 2018
fd0b57a
Making pause feature non persistant
jung-kim Jan 7, 2018
1bcb129
Adding doc
jung-kim Jan 7, 2018
a0ed421
Making pause to be an unpersisted operation
jung-kim Jan 7, 2018
835f57a
Bumping up travis' nodejs version
jung-kim Jan 9, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion .travis.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
language: node_js
node_js: ["iojs"]
node_js: ["node"]
9 changes: 6 additions & 3 deletions Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
NProgress
=========

[![Status](https://api.travis-ci.org/rstacruz/nprogress.svg?branch=master)](http://travis-ci.org/rstacruz/nprogress)
[![Status](https://api.travis-ci.org/rstacruz/nprogress.svg?branch=master)](http://travis-ci.org/rstacruz/nprogress)
[![npm version](https://img.shields.io/npm/v/nprogress.png)](https://npmjs.org/package/nprogress "View this project on npm")
[![jsDelivr Hits](https://data.jsdelivr.com/v1/package/npm/nprogress/badge?style=rounded)](https://www.jsdelivr.com/package/npm/nprogress)

Expand Down Expand Up @@ -44,7 +44,7 @@ NProgress.done();
~~~

### Turbolinks (version 5+)
Ensure you're using Turbolinks 5+, and use
Ensure you're using Turbolinks 5+, and use
this: (explained [here](https://github.com/rstacruz/nprogress/issues/8#issuecomment-239107109))

~~~ js
Expand All @@ -58,7 +58,7 @@ $(document).on('turbolinks:render', function() {
~~~

### Turbolinks (version 3 and below)
Ensure you're using Turbolinks 1.3.0+, and use
Ensure you're using Turbolinks 1.3.0+, and use
this: (explained [here](https://github.com/rstacruz/nprogress/issues/8#issuecomment-23010560))

~~~ js
Expand Down Expand Up @@ -120,6 +120,9 @@ NProgress.done(true);

__Get the status value:__ To get the status value, use `.status`

__Pause progress:__ To temporary halt trickling of progress, call `.pause` and resume with `.continue`.
This is a non persistent operation, which means next `.start` will make progress continuously if trickle is true

Configuration
-------------

Expand Down
14 changes: 12 additions & 2 deletions nprogress.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@
barSelector: '[role="bar"]',
spinnerSelector: '[role="spinner"]',
parent: 'body',
template: '<div class="bar" role="bar"><div class="peg"></div></div><div class="spinner" role="spinner"><div class="spinner-icon"></div></div>'
template: '<div class="bar" role="bar"><div class="peg"></div></div><div class="spinner" role="spinner"><div class="spinner-icon"></div></div>',
isPaused: false
};

/**
Expand Down Expand Up @@ -119,6 +120,7 @@
*/
NProgress.start = function() {
if (!NProgress.status) NProgress.set(0);
Settings.isPaused = false;

var work = function() {
setTimeout(function() {
Expand Down Expand Up @@ -176,8 +178,16 @@
}
};

NProgress.continue = function() {
return NProgress.configure({isPaused: false});
}

NProgress.pause = function() {
return NProgress.configure({isPaused: true});
}

NProgress.trickle = function() {
return NProgress.inc();
return Settings.isPaused ? this : NProgress.inc();
};

/**
Expand Down