@fw-components/trackers
TypeScript icon, indicating that this package has built-in type declarations

2.0.3 • Public • Published

@fundwave/trackers

A utility that traverses the DOM and registers listeners to elements (even those present within shadowDOMs) from a provided list of events that are to be tracked.

1. How it works

The consumer can either provide a store configuration and the events will be fetched and parsed from the store or an array of events to be tracked.

Schema of an event-config:

{
  "jsPath": "document.querySelector...",
  "location": "/dashboard", // glob pattern of the url where the target-element is to be tracked
  "title": "Clicked at dashboard edit-button",
  "event": "click" // type of event | All js events are supported
}

2. Usage

const tracker = new Trackers({
  store: {
    type: "notion",
    context: {
      url: "URL_TO_RETRIEVE_NOTION_DB",
      pageId: "<<PAGE_ID>>",
    },
  },
  track: yourTrackingMethod,
  debug: true,
});

tracker.initialize();

Note:

tracking multiple targets is also supported. Use :nth-child(+) identifier to highlight elements whose multiple instances are to be tracked

Supported selector

document.querySelector("div > div.main-content > div.page > route-page > request-grid:nth-child(+)")

Readme

Keywords

none

Package Sidebar

Install

npm i @fw-components/trackers

Weekly Downloads

14

Version

2.0.3

License

ISC

Unpacked Size

69.5 kB

Total Files

22

Last publish

Collaborators

  • rickygarg
  • ishasharma