Spyes

Detect when a DOM element changes size or position.

Installation

Node.js

npm install spyes --save

Browser

Local

<script src="node_modules/spyes/dist/spyes.min.js"></script>

CDN unpkg

<script src="https://unpkg.com/spyes/dist/spyes.min.js"></script>

Example

const spyes = require('spyes');
 
new spyes(document.getElementById('my-element'))
    .onSize((newSize, oldSize)=> console.log('size changed', newSize, oldSize))
    .onPosition((newPosition, oldPosition)=> console.log('position changed', newPosition, oldPosition));

API

Spyes

Kind: global class

• Spyes
  • new Spyes(element, [opts])
  • .sizeIsChanged() ⇒ boolean
  • .positionIsChanged() ⇒ boolean
  • .watch() ⇒ Spyes
  • .unwatch() ⇒ Spyes
  • .onSize(callback) ⇒ Spyes
  • .onPosition(callback) ⇒ Spyes

new Spyes(element, [opts])

Create instance

Param	Type	Default	Description
element	String | Element		element that you want watch
[opts]	Object		configuration object
[opts.autoWatch]	boolean	true	auto watch
[opts.checkMs]	number	50	interval in milliseconds for every check
[opts.unwatchAfterSize]	boolean	false	stop check after detect element resize
[opts.unwatchAfterPosition]	boolean	false	stop check after detect element position

spyes.sizeIsChanged() ⇒ boolean

Check if size is changed

Kind: instance method of Spyes

spyes.positionIsChanged() ⇒ boolean

Check if position is changed

Kind: instance method of Spyes

spyes.watch() ⇒ Spyes

Start watching

Kind: instance method of Spyes

spyes.unwatch() ⇒ Spyes

Stop watching

Kind: instance method of Spyes

spyes.onSize(callback) ⇒ Spyes

Fired when element changes size

Kind: instance method of Spyes

Param
callback

spyes.onPosition(callback) ⇒ Spyes

Fired when element changes position

Kind: instance method of Spyes

Param
callback

Changelog

You can view the changelog here

License

spyes is open-sourced software licensed under the MIT license

Author

Fabio Ricali