2.3.1 β€’ Published 1 year ago

next-progress v2.3.1

Weekly downloads
82
License
MIT
Repository
github
Last release
1 year ago

next-progress

No hassle Next.js - NProgress integration

Fully configurable & easy to use

πŸš€ Demo

πŸ”Œ Setup

it's so quick

βœ… Install

yarn add next-progress

or

npm install --save next-progress

βœ… Import

Important❗️ It has to be done in your custom App - pages/_app[.js / .jsx / .ts / .tsx]

import NextProgress from "next-progress";

βœ… Use

Anywhere in your custom App's return statement

<NextProgress />

🌟 Example pages\_app

Tip: This example is in typescript, if you use javascript then just remove the types.

import type { AppProps } from "next/app";
import Head from "next/head";
import NextProgress from "next-progress";

export default function App({ Component, pageProps }: AppProps) {
  return (
    <>
      <Head>
        <meta charSet="utf-8" />
        <meta name="viewport" content="width=device-width, initial-scale=1" />
        <meta name="theme-color" content="#000000" />
        <meta name="description" content="Lorem Ipsum..." />
        <title>Example</title>
      </Head>
      {
        //
        // Can be placed anywhere in the return statement
        //
      }
      <NextProgress delay={300} options={{ showSpinner: false }} />
      {
        //
        //
        //
      }
      <Layout>
        <Component {...pageProps} />
      </Layout>
    </>
  );
}

βš™οΈ Docs - Options

πŸ“ height

Height of the progress bar.

default = "2px"

🌈 color

Color of the progress bar.

default = "#29D"

🐒 delay

Delay of the animation - when page loads faster than the delay time progress bar won't be displayed.

default = 0

♻️ disableSameRoute

If true, progress bar won't be displayed when user travels the same route they're currently on.

default = false

βš™οΈ options

Options for - NProgress.configure(options).

See NProgress docs

default = undefined

πŸ‘  customGlobalCss

Css Custom NProgress styles - must be provided as a string that will go inside the <style jsx> tag.

Warning: color param won't work as you should set the color yourself inside custom css.

default = undefined

2.3.0

1 year ago

2.3.1

1 year ago

2.1.2

2 years ago

2.2.0

2 years ago

2.1.1

2 years ago

2.2.0-alpha.0

2 years ago

2.2.0-alpha.4

2 years ago

2.2.0-alpha.3

2 years ago

2.2.0-alpha.2

2 years ago

2.1.0

2 years ago

2.0.1

2 years ago

2.2.0-alpha.1

2 years ago

2.0.0

2 years ago

1.0.8

3 years ago

1.0.7

3 years ago

1.0.6

3 years ago

1.0.5

3 years ago

1.0.4

3 years ago

1.0.2

3 years ago

1.0.3

3 years ago

1.0.1

3 years ago

1.0.0

3 years ago