ProgressBar

This component adds an animated progress bar to the top of the page. The progress bar is shown when the page is scrolled.

Import

import { ProgressBar } from "@aeonkit/core";

<ProgressBar />

barClassName?

string

The class name for the progress bar.

Refer to the react-spring documentation for more information.

options?

UseScrollOptions

The react spring options for the progress bar.

getProgress?

({ scrollY, scrollYProgress, width }: GetProgress) => number

The function to get the progress of the scroll.