Skip to content

README.md

Latest commit

 

History

History
69 lines (41 loc) · 1.09 KB

README.md

File metadata and controls

69 lines (41 loc) · 1.09 KB

jProgress

Simple slim lightweight(<2KB) JavaScript progress bar, good for visual loading indicator of callbacks, promises and similar stuff.

Install

With npm:

npm install jprogress

Usage

Just include required JavaScript:

<script src="jProgress.js"></script>

or

import jProgress from 'jProgress';

Demo

Demo available here.

Options

  • brandColor (default:#de6c4f) - background color of progress bar
  • progressHeight (default:3) - progress bar height
  • zIndex (default:9999) - z-index value of progress bar
  • parent (default:body) - parent container in which jProgress is appended

Example

<script>
    jProgress.configure({

        progressHeight: '5',
        zIndex: '2'

    }).start();

    window.onload = function() {

        jProgress.stop();

    };
</script>

API

start() - start progress

stop() - stop progress

configure() - set options

License

jScrolly is licensed under the MIT license.