# scroll-percentage

> get scrolled percentage of a scrollable element

Latest version **2.0.0** (published 2019-06-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install scroll-percentage
pnpm add scroll-percentage
yarn add scroll-percentage
bun add scroll-percentage
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2019-06-02 |
| First published | 2018-08-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 2.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | srsajjad |
| Maintainers | srsajjad |

## Links

- npm: https://www.npmjs.com/package/scroll-percentage
- Homepage: https://github.com/srsajjad/scroll-percentage#readme
- Issues: https://github.com/srsajjad/scroll-percentage/issues
- npm.io page: https://npm.io/package/scroll-percentage

## Recent versions

- 2.0.0 (latest) — 2019-06-02
- 1.0.9 — 2019-06-02
- 1.0.8 — 2019-06-02
- 1.0.7 — 2019-06-02
- 1.0.6 — 2018-08-28
- 1.0.5 — 2018-08-09
- 1.0.3 — 2018-08-08
- 1.0.2 — 2018-08-08
- 1.0.1 — 2018-08-08
- 1.0.0 — 2018-08-08

## README

```sh
yarn add scroll-percentage
```

```javascript
import { calculateScrollPercentage } from 'scroll-percentage'
```

Or attach this `script` in your `html`.

```html
<script src="https://unpkg.com/scroll-percentage@1.0.9/dist/index.js"></script>
```


```javascript
document.querySelector('.parent-elem').addEventListener('scroll',e => {
  let scrollPercentage = calculateScrollPercentage(e.target)
  console.log('scroll percentage', scrollPercentage)
})
```

```
// If the parent/scrolling element is `window`, 
// then provide a second parameter - height of the child element.
// Which is basically - the element `window` is scrolling by -
```

```javascript
let childElemHeight = document.querySelector('.child-elem').clientHeight

window.addEventListener('scroll', e => {
  let scrollPercentage = calculateScrollPercentage(e.target, childElemHeight)
  console.log('scroll percentage', scrollPercentage)
})
```

`N.B: While calculating the height of child elemenet,
adjust the value with margin/padding size.`

---
_Source: https://npm.io/package/scroll-percentage · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
