trackVisibility

Triggers either a VisibleEvent or HiddenEvent for the given TrackedElement based on state.

trackVisibility = (parameters: {
element: TrackedElement;
isVisible: boolean,
locationStack?: LocationStack;
globalContexts?: GlobalContexts;
tracker?: BrowserTracker;
onError?: TrackerErrorHandlerCallback;
}) => void

Parameters

typedefault value
requiredelementTrackedElement
requiredisVisibleboolean
optionallocationStackLocationStack
optionalglobalContextsGlobalContexts
optionaltrackerBrowserTracker
optionalonErrorTrackerErrorHandlerCallbackTrackerConsole.error

Returns

trackVisibility is a void function.

Usage example

import { trackVisibility } from '@objectiv/tracker-browser';
<Accordion
onChange={(event, expanded) => {
trackVisibility({ element: event.target, isVisible: expanded })
}}
>
...
</Accordion>

Did you know ?

trackVisibility is just syntactic sugar on top of trackEvent.