{"id":16239623,"url":"https://github.com/iantsch/es6-tracking-helper","last_synced_at":"2025-07-14T00:40:00.198Z","repository":{"id":57227282,"uuid":"121815543","full_name":"iantsch/es6-tracking-helper","owner":"iantsch","description":"ES6 tracking helper","archived":false,"fork":false,"pushed_at":"2019-07-17T19:54:10.000Z","size":130,"stargazers_count":0,"open_issues_count":2,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-16T04:47:13.884Z","etag":null,"topics":["analytics","es6","google","tagmanager","tracking","tracking-helper"],"latest_commit_sha":null,"homepage":"https://npm.im/es6-tracking-helper","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/iantsch.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-02-17T00:33:43.000Z","updated_at":"2021-02-26T19:54:09.000Z","dependencies_parsed_at":"2022-08-25T12:21:53.739Z","dependency_job_id":null,"html_url":"https://github.com/iantsch/es6-tracking-helper","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iantsch%2Fes6-tracking-helper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iantsch%2Fes6-tracking-helper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iantsch%2Fes6-tracking-helper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iantsch%2Fes6-tracking-helper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/iantsch","download_url":"https://codeload.github.com/iantsch/es6-tracking-helper/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247811320,"owners_count":21000083,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["analytics","es6","google","tagmanager","tracking","tracking-helper"],"created_at":"2024-10-10T13:44:25.043Z","updated_at":"2025-04-08T09:26:17.813Z","avatar_url":"https://github.com/iantsch.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ES6 Tracking Helper\n\n[![licence](https://img.shields.io/badge/licence-MIT-blue.svg?style=flat-square)]() [![tests](https://img.shields.io/badge/tests-8%20passed-brightgreen.svg?style=flat-square)]() [![coverage](https://img.shields.io/badge/coverage-90%25-brightgreen.svg?style=flat-square)]() [![tag](https://img.shields.io/badge/tag-v2.0.1-lightgrey.svg?style=flat-square)]()\n\nA tracking helper built in ES6 with Google Analytics and Google Tag Manager Support built in.\n\n## Usage\n\n```js\nimport TrackingHelper, {Tracker} from 'es6-tracking-helper'\n\nconst trackingHelper = new TrackingHelper({\n  availableTracker: {'gtm': Tracker.GoogleTagManager}\n})\n```\n\nUse the built in click listener\n\n```html\n\u003ca data-tracking-type=\"event\" data-tracking-name=\"click-event\"\u003eTrack\u003c/a\u003e\n```\n\nOr trigger the tracking via JS\n\n```js\ntrackingHelper.track({type: 'event', name: 'js-triggered-event'})\n```\n\n## API\n\n#### constructor\n\n| Parameter | Type | Description |\n|---|---|---|\n| options | ``Object`` | Options object |\n| options.debug | ``Boolean (false)`` | Enables debugging in the console |\n| options.init | ``Boolean (true)`` | Initiate click event listener |\n| options.context | ``Node (document)``  | Context for event listener |\n| options.availableTracker | ``Object`` | Tracker Classes |\n| options.pageName | ``String`` \\| ``Boolean (false)`` | Will be prepended to event/pageview names in built in tracker |\n| options.category | ``String (Global)`` | Global Category |\n| options.action | ``String (Global)`` | Global Action |\n| options.dataset | ``Object`` | Data attributes for event listener |\n| options.dataset.type | ``String (trackingType)`` | Data attribute for type |\n| options.dataset.category | ``String (trackingCategory)`` |  Data attribute for category |\n| options.dataset.action | ``String (trackingAction)`` |  Data attribute for action |\n| options.dataset.name | ``String (trackingName)`` |  Data attribute for name |\n| options.dataset.nonInteraction | ``String (trackingNonInteraction)`` |  Data attribute for non interaction flag |\n\n#### startTracking ⇨ ``TrackingHelper``\n\nStart listening for clicks on nodes with tracking data attributes\n\n*Returns*: ``TrackingHelper`` - This tracking helper instance\n\n#### stopTracking ⇨ ``TrackingHelper``\n\nStop listening for clicks on nodes with tracking data attributes\n\n*Returns*: ``TrackingHelper`` - This tracking helper instance\n\n#### onClick\n\nClick handler for nodes with tracking data attributes\n\n#### add(type) ⇨ ``TrackingHelper``\n\nAdds a tracking type\n\n| Parameter | Type | Description |\n|---|---|---|\n| type | ``String`` | tracking method type used to identify type in data attributes |\n\n*Returns*: ``TrackingHelper`` - This tracking helper instance\n\n#### remove(type) ⇨ ``TrackingHelper``\n\nRemoves a tracking type\n\n| Parameter | Type | Description |\n|---|---|---|\n| type | ``String`` | tracking method type used to identify type in data attributes |\n\n*Returns*: ``TrackingHelper`` - This tracking helper instance\n\n#### track ⇨ ``TrackingHelper``\n\nIterates over all trackers and tries to invoke the designated tracking type\n\n*Returns*: ``TrackingHelper`` - This tracking helper instance\n\n## License\n\nMIT\n\n## Credits\n[@iantsch](https://twitter.com/iantsch) - [web developer](https://mbt.wien) behind this and other projects.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiantsch%2Fes6-tracking-helper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fiantsch%2Fes6-tracking-helper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiantsch%2Fes6-tracking-helper/lists"}