https://github.com/zhangyu1818/scroll-progress-bar

A progress bar for scroll, support SSR.
https://github.com/zhangyu1818/scroll-progress-bar

progress-bar scroll-progress-bar

Last synced: 6 months ago
JSON representation

A progress bar for scroll, support SSR.

• Host: GitHub
• URL: https://github.com/zhangyu1818/scroll-progress-bar
• Owner: zhangyu1818
• Created: 2021-06-02T09:54:21.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2021-07-09T07:43:27.000Z (over 4 years ago)
• Last Synced: 2025-03-01T16:04:57.424Z (10 months ago)
• Topics: progress-bar, scroll-progress-bar
• Language: TypeScript
• Homepage: https://zhangyu1818.github.io/scroll-progress-bar/
• Size: 10.7 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# 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)

A progress bar for scroll, support SSR.

## Install

```npm

npm install scroll-progress-bar

```

```yarn

yarn add scroll-progress-bar

```

## Usage

``` javascript

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**

```javascript

export interface ScrollProgressConfig {

  // element id

  id?: string

  // element scroll offset

  offset?: number

  // scroll debounce

  debounce?: boolean

}

```