scroll-percentage

2.0.0 • Public • Published
yarn add scroll-percentage
import { calculateScrollPercentage } from 'scroll-percentage'

Or attach this script in your html.

<script src="https://unpkg.com/scroll-percentage@1.0.9/dist/index.js"></script>
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 -
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.

Readme

Keywords

none

Package Sidebar

Install

npm i scroll-percentage

Weekly Downloads

228

Version

2.0.0

License

MIT

Unpacked Size

2.15 kB

Total Files

5

Last publish

Collaborators

  • srsajjad