Git Product home page Git Product logo

viewport-update's Introduction

viewport-update

Throttled window scroll and resize events. In the singleton + signal way

Install

npm i viewport-update

Package on npm

API

constructor(delay)

Create the first instance, otherwise return the internal instance already created

Argument Action
delay the throttling delay, default to 100 ms, min to 25 ms

The instance created has the following properties

Property Value
update the signal instance โ€“ see signalus-simplex
width the window innerWidth
height the window innerHeight
left the window scrollX
top the window scrollY
right the window scrollX + window.innerWidth
bottom the window scrollY + window.innerHeight

Receive data from the dispatched argument

const Viewport = require('viewport-update')

function onupdate(data) {
  // {with:.., height:.., left:.., top:.., right:.., bottom:..}
  console.log(data)
}

var viewport = new Viewport()
viewport.update.add(onupdate)

Get datas from the instance

const Viewport = require('viewport-update')

var viewport = new Viewport()

function onupdate() {
  // the viewport width and height
  console.log(viewport.width, viewport.height)
}

viewport.update.add(onupdate)

immediate()

Force the update signal to dispatch immediately instead of waiting the next scroll or resize event

Thanks

Mainly forked / inspired on

License

MIT

viewport-update's People

Contributors

jeromedecoster avatar

Watchers

 avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.