Skip to content

Zero-dependency progress bar/skeleton for Next.js

Notifications You must be signed in to change notification settings

aldabil21/next-progress

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Zero-dependency Progress Bar/Skeleton

npm package Follow on Twitter

Install

npm i @aldabil/next-progress

Usage

In your custom _app.tsx|js.

//...some impotrs...
import { Router } from "next/router";
import Progress from "@aldabil/next-progress";

//Progress setup
Progress.configure({
  type: "bar",
  background:
    "linear-gradient(90deg, rgba(251,175,0,1) 0%, rgba(251,175,0,1) 81%, rgba(127,137,0,1) 100%)",
  height: 3,
  //svg: "used with type='fullpage' ",
});
Router.events.on("routeChangeStart", () => Progress.start());
Router.events.on("routeChangeComplete", () => Progress.complete());
Router.events.on("routeChangeError", () => Progress.complete());

const MyApp = (props: MyAppProps) => {
  //...
};

And that's it.

Demo

Bar Sandbox
Bar type

SVG Sandbox
Bar type

Options

Option Value
type bar / fullpage. When use fullpage type, you need to provide svg as a string toload with skeleton effect.
background string - background CSS property. bar color or fullpage background
height number. bar height or svg height
svg string. Like `<svg> .... </svg>` with backticks.

About

Zero-dependency progress bar/skeleton for Next.js

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published