@livelybone/scroll-get

@livelybone/scroll-get

pkg.module supported, which means that you can apply tree-shaking in you project

A module for get left/top distance of element, or get scrollLeft/scrollTop of document

repository

https://github.com/livelybone/scroll-get.git

Demo

https://github.com/livelybone/scroll-get#readme

Installation

npm i -S @livelybone/scroll-get

Global name

ScrollGet

Usage

import {getRect, posRelativeToPage, posRelativeToClient} from '@livleybone/scroll-get'

/**
 * @result { DOMRect | ClientRect | TextRectangle }
 * */
var rect = getRect(document.getElementById('id'))
/**
 * @result { Object: {pageLeft:Number, pageTop:Number} }
 * */
var pos = posRelativeToPage(document.getElementById('id'))
/**
 * @result { Object: {clientLeft:Number, clientTop:Number} }
 * */
var pos1 = posRelativeToClient(document.getElementById('id'))

// when you want to set this module as external while you are developing another module, you should import it like this
import * as ScrollGet  from '@livleybone/scroll-get'
const {getRect, posRelativeToPage, posRelativeToClient} = ScrollGet