Skip to content

πŸŽ‰ A simple progressbar based on the scroll state of a page, as a react component.

License

Notifications You must be signed in to change notification settings

anuraglol/page-progressbar-react

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

32 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ’‘ A Simple progressbar based on scroll state of a page using framer-motion

πŸ‘€ Demo (https://page-progressbar-react.vercel.app/)

Installation

npm i page-progressbar-react
            or
yarn add page-progressbar-react

Usage

You can import the PageProgressBar component from the package after installing.

import PageProgressBar from "page-progressbar-react";

After importing, add <PageProgressBar /> to your desired page.

-pages / index.js;
import PageProgressBar from "page-progressbar-react";

export default function HomePage() {
  return (
    <>
      <PageProgressBar />

      {/* Your code here... */}
    </>
  );
}

Customization

Currently PageProgressBar supports color and height props.

export default function HomePage() {
  return (
    <>
      <PageProgressBar color="#2563eb" height={5} />

      {/* Your code here... */}
    </>
  );
}

Props:

prop type default
color string #ec4899
height number 4px

Author

About

πŸŽ‰ A simple progressbar based on the scroll state of a page, as a react component.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published