nextjs-progressbar-withdelay
TypeScript icon, indicating that this package has built-in type declarations

0.0.11 • Public • Published

Next.js Progressbar

How to install?

npm i nextjs-progressbar-withdelay

How to use?

After installing the package, import this in your pages/_app.js file.

import NextNprogress from 'nextjs-progressbar-withdelay';

And for rendering add <NextNProgress /> inside Container component.

Default Config

<NextNprogress
  color="#29D"
  startPosition={0.3}
  startDelayMs={200}
  stopDelayMs={200}
  height="3"
/>
  • color: to change the default color of progressbar. You can also use rgb(,,) or rgba(,,,).
  • startPosition: to set the default starting position : 0.3 = 30%.
  • startDelayMs: time for delay to start progressbar in ms. pages which load faster than this will not display the progress bar.
  • stopDelayMs: time for delay to stop progressbar in ms.
  • height: height of progressbar in px.

Advanced Config

You can use other configurations which NProgress provides by adding a JSON in options props.

<NextNprogress
  options={{ easing: 'ease', speed: 500 }}
/>

Package Sidebar

Install

npm i nextjs-progressbar-withdelay

Weekly Downloads

1

Version

0.0.11

License

MIT

Unpacked Size

9.94 kB

Total Files

6

Last publish

Collaborators

  • jacknight