Initializes the InView module.
Optionalprops: StaticProps & MutablePropsProtected_callbacksCallbacks instance
Protected_destroyableStores actions that need to be executed when the module is destroyed
Protected_elementsStores the elements being observed.
Protected_isTracks whether the module has been destroyed
Protected_isTracks whether this is the first time the elements are being observed.
Protected Optional_observerIntersection observer for detecting elements entering the viewport.
Protected Optional_observerIntersection observer for detecting elements leaving the viewport.
Protected_propsCurrent properties
Retrieves the module's callbacks instance.
Returns all elements currently being observed.
Checks if the module has been destroyed.
Indicates whether the observation has started for the first time.
The name of the module, derived from the class name
Optional prefix for classnames used by the module
Current properties. Do not mutate these directly, use updateProps instead.
Protected_addAdds a class name on an element, and keeps track of it for removal when the module is destroyed.
The target DOM element.
The class name to toggle.
Protected_cnHelper function to generate classnames with the module's prefix.
The class names to generate.
A string of class names with the module's prefix applied.
Protected_destroyCleans up the module and disconnects all observers and listeners.
Protected_getCalculates the delay before triggering an element's visibility event.
Returns default mutable properties.
Returns default static properties.
Protected_handleHandles elements entering the viewport.
Protected_handleToggles visibility classes and emits events for visibility changes.
Protected_handleHandles elements leaving the viewport.
Protected_handleHandles property mutations and updates observation events accordingly.
Protected_removeRemoves all observation events and disconnects observers.
Protected_setupConfigures or reconfigures the view observation events.
Protected_setSets up IntersectionObserver instances to detect visibility changes.
Registers an element for visibility observation.
If the element has a data-in-view-class attribute, the specified class will be applied upon entering the viewport.
A function to stop observing the element.
Destroys the module, cleaning up resources, callbacks, and event listeners.
Adds a custom callback to the module.
The event type to listen for (e.g., 'props', 'destroy').
The function to execute when the event is triggered.
Additional settings for the callback.
Adds a callback on the module's destruction.
The function to execute during destruction.
Removes an element from observation, preventing further visibility tracking.
InView is a visibility detection utility that leverages the
IntersectionObserverAPI to monitor when elements enter or leave the viewport. It provides customizable options for triggering events, delaying visibility changes, and dynamically adding CSS classes to elements based on their visibility state.Documentation