npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

nprogresse

v0.2.6

Published

See the original [nprogress](https://github.com/rstacruz/nprogress) written by rstacruz, without whom this project wouldn't exist.

Downloads

11

Readme

NProgressE

See the original nprogress written by rstacruz, without whom this project wouldn't exist.

The last letter e is used for package name distinction, while the usages are almost the same, see the following.

Minimalist progress bar

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

Table of Contents

Installation

$ npm install --save nprogresse

Examples

Here is an example code for usages.

example usage

Basic usage

<!-- in standalone html -->
<script src="nprogresse/index.js"></script>
<link rel="stylesheet" href="nprogresse/style.css" />
<script>
  window.NProgressE.start();

  // time elapsed
  window.NProgressE.done();
  // or
  window.NProgressE.error();
</script>

Simply call start(), done() and error() to control the progress bar.

import NProgressE from 'nprogresse';
import 'nprogresse/style.css';
// start the progress
NProgressE.start();

// finish the progress in good status
NProgressE.done();

// finish the progress in error status
NProgressE.error();
$(document).on('ajax:start', function () {
  NProgressE.start();
});
$(document).on('ajax:end', function () {
  if ('ajax:success') {
    NProgressE.done();
  } else {
    NProgressE.error();
  }
});

Ideas

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

    • done() for ajaxSuccesss.

    • error() for ajaxError.

  • 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.

NProgressE.set(0.0); // same as .start()
NProgressE.set(0.4);
NProgressE.set(1.0); // 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).

NProgressE.inc();

If you want to increment by a specific value, you can pass that as a parameter:

NProgressE.inc(0.2); // This will get the current status value and adds 0.2 until status is 0.994

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)

NProgressE.done(true);

Force-error

By passing true to error(), it will show the progress bar even if it's not being shown.

NProgressE.error(true);

Get the status value

To get the status value, use .status.

console.log(NProgressE.status);

Get the progress element

To get the element, use .el;

console.log(NProgressE.el);

Configuration

minimum

Changes the minimum percentage used upon starting, (default: 0.08).

NProgressE.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.

NProgressE.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).

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

trickle

Turn off the automatic incrementing behavior by setting this to false. (default: true)

NProgressE.configure({ trickle: false });

trickleSpeed

Adjust how often to trickle/increment, in ms.

NProgressE.configure({ trickleSpeed: 200 });

showSpinner

Turn on loading spinner by setting it to true, (default: false).

NProgressE.configure({ showSpinner: true });

parent

Specify this to change the parent container, (default: body).

NProgressE.configure({ parent: '#container' });

Customization

Modify the built style.css to your liking.

The included CSS file is pretty minimal.

Tip: you probably only want to find source less file here.

In fact, feel free to scrap it and make your own style!