This was originally posted on my blog on 27th October 2020.
In this post I'll show how to implement a page loading indicator like in YouTube, GitHub and my own site.
The example above is running with the cache disabled and the "Slow 3G" preset.
To get started, install the @badrap/bar-of-progress dependency.
yarn add @badrap/bar-of-progress
Then create the _app.js file in pages if you haven't done so already.
// pages/_app.js
const MyApp = ({ Component, pageProps }) => {
return <Component {...pageProps} />;
};
export default MyApp;
Next import the bar-of-progress dependency into _app.js and declare a new progress bar.
import ProgressBar from "@badrap/bar-of-progress";
const progress = new ProgressBar({
size: 2,
color: "#38a169",
className: "bar-of-progress",
delay: 100,
});
// ...
We'll be using the Next.js Router's events to control the progress bar.
// ...
import Router from "next/router";
// ...
Router.events.on("routeChangeStart", progress.start);
Router.events.on("routeChangeComplete", progress.finish);
Router.events.on("routeChangeError", progress.finish);
// ...
Finally your _app.js file should look like this.
import ProgressBar from "@badrap/bar-of-progress";
import Router from "next/router";
const progress = new ProgressBar({
size: 2,
color: "#38a169",
className: "bar-of-progress",
delay: 100,
});
Router.events.on("routeChangeStart", progress.start);
Router.events.on("routeChangeComplete", progress.finish);
Router.events.on("routeChangeError", progress.finish);
const MyApp = ({ Component, pageProps }) => {
return <Component {...pageProps} />;
};
export default MyApp;
If all goes well, you should be seeing a progress bar on the top of your site while transitioning between pages.
Sometimes the progress bar might be hidden behind another element, as was the case in my own site.
To solve it all you have to do is increase the z-index of the progress bar in your css.
.bar-of-progress {
z-index: 50;
}
The class name is the className property we gave when declaring the progress bar.
const progress = new ProgressBar({
size: 2,
color: "#38a169",
className: "bar-of-progress",
delay: 100,
});
Top comments (6)
Thanks bruh, It helped
This article the documentation of the mentioned package, not their README.md. Well done.
Really helpful thanks
Glad you it found it useful!!!! 😊
Am looking for a scenario where you are not changing route. but just a page refresh
You can probably use something like
router.replace(router.asPath);to refresh the page. Check theuseRouterhook.