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

1.2.0 • Public • Published

Next Js Progress Loader

Important context: Latter the Next.Js 13 update, router events has ben depreciated and still there's no 'next native resource' to manipulate router events as before. But this lib was build to solve this problem and bring a new way to make the UX/UI better!

Install

npm install nextjs-progressloader

yarn add nextjs-progressloader

Basic Usage

Import the animation component:

import { ProgressLoader } from 'nextjs-progressloader';

Usage with app/layout.js for app folder structure

For rendering add <ProgressLoader /> to your return() inside the <body></body> tag of RootLayout():

'use client';
import { ProgressLoader } from 'nextjs-progressloader';

export default function RootLayout({ children }) {
  return (
    <html lang="en">
      <body>
        <ProgressLoader />
        {children}
      </body>
    </html>
  );
}

Advanced Usage

If you would like to render some route with the Load Animation, use <ContainerLink /> component and our custom useRouter() hook to do it:

When render <ContainerLink /> you are required to pass a links prop which is responsible to create all the needed events to work.

And when using useRouter() a event will be emitted based on the function's param.

  • Important and required: To this feature work correctly, the links prop and the function's parameter must be equals.
  • You can render the component how many times you want and anywhere you want, being inside the <body></body>
  • Using the <ContainerLink /> next will identify the routes and will pre-render: verify the documentation

Once the links are defined, you can invoke the route wherever and whenever you want using the nickname or href.

Example usage

import { useRouter, ContainerLink, ContainerLinkProps } from 'nextjs-progressloader';

const links: ContainerLinkProps["links"] = [
  {
    href: "/",
    nickname: "home",
  },
  {
    href: "/posts",
    nickname: "posts"
  },
  {
    href: "/login",
  },
];

export function ComponentIWantToRender(){
  const router = useRouter()

  function validateSomeThing(){
    // your validation

    //Example
    if(userLogged){
      // calling by the nickname
      router.push("home")
    }else{
      //calling by the route
      router.push("/login")
    }
  }

  return (
    <>
      <ContainerLink links={links} />;

      <button className="bg-red-500" onClick={validateSomeThing}>
        Validating something
      </button>
    </>
  )
}

Issues

Package Sidebar

Install

npm i nextjs-progressloader

Weekly Downloads

809

Version

1.2.0

License

MIT

Unpacked Size

157 kB

Total Files

28

Last publish

Collaborators

  • samuhmatos