An implementation of n-progress for use with the Next.js 13 app router.
npm install nextjs13-nprogress-app-routerbash
npm i nextjs13-nprogress-app-router
`
Usage
In your layout.tsx:
`tsx
import './globals.css';
import type { Metadata } from 'next';
import { Inter } from 'next/font/google';
import { Next13NProgress, Link } from 'nextjs13-nprogress-app-router';
const inter = Inter({ subsets: ['latin'] });
export const metadata: Metadata = {
title: 'Create Next App',
description: 'Generated by create next app',
};
export default function RootLayout({ children }: { children: React.ReactNode }) {
return (
Home
Page2
{children}
);
}
`
NOTE: You must use the Link component from this package in order to initiate the start of n-progress. This component is a wrapper for Next/Link.
Default Config
If no props are passed to , below is the default configuration applied.
`tsx
`
- 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%.
- stopDelayMs: time for delay to stop progressbar in ms.
- height: height of progressbar in px.
- showOnShallow: You can choose whether you want the progressbar to be displayed if you're using shallow routing. It takes a boolean. Learn more about shallow routing in Next.js docs.
Advanced usage
$3
The provided Link component adds an onClick event to the links it generates. This handler will:
1. Verify the href attribute of the link, and the characteristics of the click event. Depending on both conditions, it will start the progress bar.
2. Fire any additional onClick event that you provided
In some cases, you might need a greater level of control over the onClick event. For that reason, the handler can be imported so as to create your own Link component as needed.
#### Example 1:
Don't attach the progressbar onClick event if we've already supplied an onClick event of our own.
`tsx
'use client';
import NextLink, { LinkProps } from 'next/link';
import { forwardRef } from 'react';
import { linkClicked as progressBarLinkClicked } from 'nextjs13-nprogress-app-router';
export const Link = forwardRef((
{ onClick, ...rest },
ref,
) => (
if (onClick) {
// fire only the existing event only
onClick(event);
} else {
// fire the progressbar event
progressBarLinkClicked(event);
}
}}
{...rest}
ref={ref}
/>
));
`
#### Example 2:
Clicking a link triggers a browser prompt. Since the link only clicks through if the user confirms, we need to also assure that the progress bar also only starts if that condition is met.
`tsx
'use client';
import NextLink, { LinkProps } from 'next/link';
import { forwardRef, ReactNode } from 'react';
import { onStart } from '../events';
import { shouldTriggerStartEvent } from './should-trigger-start-event';
type ExtendedLinkProps = LinkProps & {
className?: string;
children?: ReactNode | string;
};
export const Link = forwardRef(function Link(
{ onClick, className, children, ...rest },
ref,
) {
return (
linkClicked(event);
if (onClick) onClick(event);
}}
className={className}
{...rest}
ref={ref}
>
{children}
);
});
export function linkClicked(event: React.MouseEvent) {
const anchorElement = event.currentTarget as HTMLAnchorElement;
const { href } = anchorElement;
if (href || href.startsWith('/')) {
if (shouldTriggerStartEvent(href, event)) onStart();
}
}
``