Socket
Socket
Sign inDemoInstall

nextjs-progressloader

Package Overview
Dependencies
7
Maintainers
1
Versions
13
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    nextjs-progressloader

Next.js library to manage navigation between pages/routes with loading animation


Version published
Weekly downloads
1.1K
increased by1.32%
Maintainers
1
Created
Weekly downloads
 

Changelog

Source

v1.2.0

Updated

  • Now ContainerLink has support to register a external link like (https://github.com/samuhmatos) don't forget to check out the rules

Readme

Source

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>
  );
}
Learn more about <ProgressLoader />

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.

Learn everything about the Usability flow

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>
    </>
  )
}
Learn everything about the Usability flow

Issues

Do you have any suggestions or issue? Please let me know
Check the changelog

Keywords

FAQs

Last updated on 13 Mar 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc