when
@blackbyte.sugar.js.dom.when
This function listen for passed trigger(s) on the passed HTMLElement and resolve the promise once one of them has reached his state.
Params
- $elm*-HTMLElement
The element to listen on
- trigger*-String|String[]
The trigger(s) to listen on
- settings{}TwhenSettings
Some settings like offset, etc…
Return
- -SPromise<HTMLElement>
A promise resolved when all the triggers are fulfilled
Example
import { when } from '@blackbyte/sugar/dom';
when($elm, 'inViewport', {
whenInViewport: {
offset: 50
}
}).then(() => {
// do something
});Settings
- whenInViewport[object Object]Partial<TWhenInViewportSettings>
Some settings for the whenInViewport function
- whenNearViewport[object Object]Partial<TWhenNearViewportSettings>
Some settings for the whenNearViewport function
- whenEntersViewport[object Object]Partial<IWhenEntersViewportSettubgs>
Some settings for the whenEntersViewport function
- whenOutOfViewport[object Object]Partial<TWhenOutOfViewportSettings>
Some settings for the whenOutOfViewport function
- whenInteract[object Object]Partial<TWhenInteractSettings>
Some settings for the whenInteract function
- whenVisible[object Object]Partial<TWhenVisibleSettings>
Some settings for the whenVisible function
- whenStylesheetsReady[object Object]Partial<IWhenStyleSheetsReadySettings>
Some settings for the whenStylesheetsReady function
Todo
- testsnormal