README

Super lighweight, pure JavaScript page load progress bar

Status

View Preview

Status
Quick Start
What's included
Bugs and feature requests
Installation
How to Use
Versioning
Changelog
Team
Code of Conduct
Copyright and License

Quick Start

Several options are available:

Download the latest release.
Clone the repo: git clone https://github.com/the-muda-organization/nanobar.git
Install with Composer: composer require the-muda-organization/nanobar

What's included

Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations. You'll see something like this:

There are no dependencies. See below for Installation Guide and How to Use

nanobar/
 │
 └─ dist/
    │
    ├── nanobar.js
    └── nanobar.min.js

Bugs and feature requests

Have a bug or a feature request? Before opening a new issue search for existing and closed issues. If your problem or idea is not addressed yet, open a new issue.

Installation

Download and copy files to your project
Add JS to your project:

    <script src="https://example.com/nanobar/1.x.x/nanobar.min.js"></script>

OR add script inline (recommended):

    <script>Paste script here</script>

Place nanobar <script> right after opening <body> tag.
Ready to use!

How to Use

Nanobar is designed to be placed in CDN and used on multiple pages. Nanobar has default background color set to red. You may set custom background color you like the most in JavaScript variables (at the beginning of the script).

If you want to change color on a single page add data-nanobar="" attribute to <body>. You can use any color value that is usually used in CSS #nanobar{background: something} - color name, hex value, gradients and more.

    <body data-nanobar="#ff8c00">
    <body data-nanobar="blue">
    <body data-nanobar="linear-gradient(to right,#40e0d0,#ff8c00,#ff0080)">

Do not add this attribute and do not leave blank if you don't want to change background color. JavaScript checks if data-nanobar="#ff8c00" has a new background color value.

Nanobar has assigned ID: <div id="nanobar"></div>

Versioning

Nanobar will be maintained under the Semantic Versioning guidelines as much as possible. Releases will be numbered with the following format: <major>.<minor>.<patch>

Changelog

For last releases see detailed CHANGELOG.

Team

Jakub Muda

Code of conduct

We will behave ourselves if you behave yourselves. For more details see our CODE OF CONDUCT.

Copyright and license

Code released under the MIT License.

the-muda-organization / nanobar

Maintainers

Details