dom-event-tracker
dom-event-tracker
npm i dom-event-tracker
dom-event-tracker

dom-event-tracker

Dynamically tracks mutations and listens for click and seen events

by Trendyol

1.3.3 (see all)License:ISCTypeScript:Not Found
npm i dom-event-tracker
Readme

🚀 Dom Event Tracker!

Dynamically tracks mutations and listens for click and seen events.

CircleCI codecov npm version

DOM Event Tracker uses IntersectionObserver and MutationObserver for tracking click and seen events. Whenever an element is visible in the users screen it fires seen event. Whenever user clicks an item, it fies click event.

Install

npm install dom-event-tracker

Custom Build

You can also clone repository and build.

git clone git@github.com:Trendyol/dom-event-tracker.git && cd dom-event-tracker
npm install
npm run build

Usage

  1. Add data-tracker-root attribute to root element. Root element is being tracked for mutations.
  2. Add tracking attributes to elements that you want to track data-tracker="seen:seenEventName click:clickEventName".
  3. Start Tracker
window.Tracker.init((eventName, eventType, element) => {
    //Report your event
    GoogleAnalytics.fireEvent(eventName);
});

Example

<html>
    <head></head>
    <body>
        <div class="container" data-tracker-root>
            <div>
                <div class="info-box" data-tracker="seen:infoBoxSeen"></div>
            </div>
            <div class="help-button" data-tracker="click:helpButtonClicked"></div>
            <div class="info-button" data-tracker="click-capture:infoButtonClicked"></div>
        </div>
        <script>
            window.Tracker.init(); // Without callback it uses console for notifying events
        </script>
    </body>
</html>

Event Types

Seen (seen:eventName)

Whenever an element is visible in the users screen it fires seen event. IntersectionObserver without threshold.

Whenever callback returns true, seen event won't be fired for that element. Otherwise it will always fire seen event. This means almost each scroll

Click (click:eventName)

Whenever user clicks an item, it fires click event. Uses event bubbling for listening click events.

ClickCapture (click-capture:eventName)

Whenever user clicks an item, it fires click event. Uses event capturing for listening click events.

Tracker Callback

Root Callback

You can provide root callback for async initialize.

<div data-tracker-root="onTrackerLoaded">
    <div data-tracker="seen:seenItem"></div>
</div>
<script>
function onTrackerLoaded(e){
  GoogleAnalytics.event(e);
}
</script>
<script src="cdn://tracker.min.js" defer></script>

Custom start

You can also call init manually

<div data-tracker-root="">
    <div data-tracker="seen:seenItem"></div>
</div>
<script src="cdn://tracker.min.js"></script>
<script>
    window.Tracker.init((e) => GoogleAnalytics.event(e));
</script>

Callback Params

function callbackHandler(eventName, eventType, element){
  
}

Downloads/wk

42

GitHub Stars

42

LAST COMMIT

2yrs ago

MAINTAINERS

1

CONTRIBUTORS

4

OPEN ISSUES

0

OPEN PRs

17
VersionTagPublished
1.3.3
latest
2yrs ago
No alternatives found
No tutorials found
Add a tutorial

Rate & Review

100
No reviews found
Be the first to rate