scroll-progress-bar

![npm-version](https://img.shields.io/npm/v/scroll-progress-bar.svg) ![bundlesize-js-image](https://img.badgesize.io/https:/unpkg.com/scroll-progress-bar/es/index.js?label=gzip&compression=gzip&style=flat-square)

Usage no npm install needed!

<script type="module">
  import scrollProgressBar from 'https://cdn.skypack.dev/scroll-progress-bar';
</script>

README

scroll-progress-bar

npm-version bundlesize-js-image

A progress bar for scroll, support SSR.

Install

npm install scroll-progress-bar
yarn add scroll-progress-bar

Usage


import progressBar from 'scroll-progress-bar';
import "scroll-progress-bar/style.css";

// show scroll progress bar
progressBar.show();
// hide scroll progress bar
progressBar.hide();
// set scroll progress bar configuration
progressBar.setConfig({
    debounce: true,
})

configuration

export interface ScrollProgressConfig {
  // element id
  id?: string
  // element scroll offset
  offset?: number
  // scroll debounce
  debounce?: boolean
}