viewportEvents

Type:Function

Status:stable

Since:1.0.0

Platform:js

@blackbyte.sugar.js.dom.event

Monitor when the passed element enter or exit the viewport

Params

$elm*-HTMLElement
The element to monitor
$settings{}Partial<TViewportEventsSettings>
Some settings to configure your detector

Return

-Function
The passed HTMLElement

Example

import { viewportEvents } from '@blackbyte/sugar/dom';
viewportEvents($elm);
$elm.addEventListener('viewport.enter', (e) => {
  // do something on enter
});
$elm.addEventListener('viewport.leave', (e) => {
  // do something on leave
});

Settings

offset25String
An offset to detect the enter/leave earlier or later
oncefalseBoolean
Specify if you want to event to be dispatched only once

Todo

testsnormal

Author

Olivier Bosselolivier.bossel@gmail.com https://blackbyte.space

Changelog

1.0.0
Rename events from viewport.in / viewport.out to viewport.enter / viewport.leave