trackVisibleEvent

Triggers a VisibleEvent for the given TrackedElement.

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

info

trackVisibleEvent is triggered automatically by tagExpandable and tagOverlay.

Parameters

		type	default value
required	element	TrackedElement
optional	locationStack	LocationStack
optional	globalContexts	GlobalContexts
optional	tracker	BrowserTracker
optional	onError	TrackerErrorHandlerCallback	TrackerConsole.error

Returns

trackVisibleEvent is a void function.

Usage example

import { trackVisibleEvent } from '@objectiv/tracker-browser';

<Modal
  onShow={(event) => {
    trackVisibleEvent({ element: event.target })
  }}
  onHide={(event) => {
    trackHiddenEvent({ element: event.target })
  }}
>
  ...
</Modal>

const elementRef = createRef();
...
useEffect(() => {
  trackVisibleEvent({ element: elementRef.current });
  return () => {
    trackHiddenEvent({ element: elementRef.current });
  }
}, [])
...
return (
  <div ref={elementRef}>
    ...
  </div>
)

Did you know ?

trackVisibleEvent is just syntactic sugar on top of trackEvent.

See also

• trackHiddenEvent
• trackVisibility
• trackEvent :::