trackEvent
First, it determines the Location of a TrackableElement or EventTarget, then enriches the given Event with the Location and triggers it.
trackEvent = (parameters: {
event: UntrackedEvent;
element?: TrackedElement;
tracker?: BrowserTracker;
trackerId?: string;
onError?: TrackOnErrorCallback;
}) => void
caution
trackEvent is a lower-level API. It's main purpose is to ease the development of new Event Trackers.
Parameters
| type | default value | ||
|---|---|---|---|
| required | event | Instance returned by any Event Factory | |
| optional | element | TrackedElement | documentElement |
| optional | tracker | BrowserTracker | The default tracker as returned by getTracker |
| optional | trackerId | string | |
| optional | onError | TrackerErrorHandlerCallback | TrackerConsole.error |
Returns
trackEvent is a void function.
Usage example
import { trackEvent, makePressEvent } from '@objectiv/tracker-browser';
export const trackPressEvent = (parameters: {
element: TaggableElement | EventTarget;
tracker?: BrowserTracker;
onError?: TrackOnErrorCallback;
}) => {
return trackEvent({ event: makePressEvent(), ...parameters });
};