BProgress

A slim progress bar inspired by NProgress.

NProgress V2 and Next NProgress Bar become BProgress!

Migration from nprogress-v2

If you are using nprogress-v2, you can migrate to @bprogress/core by following the migration guide.

Installation

$3

To install BProgress, run the following command:

``bash
npm install @bprogress/core
`

$3

Use unpkg:

- JS: https://unpkg.com/@bprogress/core/dist/index.global.js
- ESM: https://unpkg.com/@bprogress/core/dist/index.js
- CSS: https://unpkg.com/@bprogress/core/dist/index.css

Use jsDelivr:

- JS: https://cdn.jsdelivr.net/npm/@bprogress/core/dist/index.global.js
- ESM: https://cdn.jsdelivr.net/npm/@bprogress/core/dist/index.js
- CSS: https://cdn.jsdelivr.net/npm/@bprogress/core/dist/index.css

$3

The following frameworks have a dedicated package for using BProgress:

- React
- Next.js
- Remix
- Vue

Quick Start

$3

#### CDN

Import CSS in your index.html file.

`html
rel="stylesheet"
type="text/css"
href="https://unpkg.com/@bprogress/core/dist/index.css"
/>
`

Import JavaScript in your index.html file.

`html

`

Or you can add BProgressJS as a global variable using the legacy include:

`html


`

#### Node.js

`js
import '@bprogress/core/css';
import { BProgress } from '@bprogress/core';
`

$3

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

`js
BProgress.start();
BProgress.done();
``

More information on documentation

Go to the documentation to learn more about BProgress.

Issues

If you encounter any problems, do not hesitate to open an issue or make a PR here.

LICENSE

MIT