README.md

bianco.viewport

Usage

import viewport from 'bianco.viewport'

// get the current scroll top position
const offsetTop = viewport.scrollTop()

API

Table of Contents

• scrollbarWidth
• documentHeight
• documentWidth
• scrollTop
• scrollLeft
• elementOffsetTop
  • Parameters
• elementOffsetLeft
  • Parameters

scrollbarWidth

Return the size of the scrollbar that depends on the browser or device used on the client

Returns number the browser scrollbar width

documentHeight

Get the height of the whole page

Returns number height in px of the document

documentWidth

Get the width of the whole page

Returns number width in px of the document

scrollTop

Return amount of px scrolled from the top of the document

Returns number scroll top value in px

scrollLeft

Return amount of px scrolled from the left of the document

Returns number scroll left value in px

elementOffsetTop

Get the offset top of any DOM element

Parameters

• el HTMLElement the element we need to check

Returns number the element y position in px

elementOffsetLeft

Get the offset left of any DOM element

Parameters

• el HTMLElement the element we need to check

Returns number the element x position in px