{"_id":"@data-visuals/analytics","_rev":"4-30072b551edab63ad8e15035d704b78b","name":"@data-visuals/analytics","dist-tags":{"latest":"0.1.1"},"versions":{"0.1.0":{"name":"@data-visuals/analytics","version":"0.1.0","description":"Consistently track how pages perform the Texas Tribune Data Visuals way.","source":"src/index.js","module":"dist/analytics.es.js","main":"dist/analytics.js","umd:main":"dist/analytics.umd.js","files":["dist","README.md"],"scripts":{"build":"npm run build-autotrack && microbundle","build-autotrack":"autotrack --output src/autotrack-plugins.js --plugins cleanUrlTracker,eventTracker","dev":"microbundle watch","docs":"documentation readme src/index.js --no-markdown-toc --quiet --section API","prepublish":"npm run build","postbuild":"npm run docs"},"repository":{"type":"git","url":"git+https://github.com/texastribune/data-visuals-analytics.git"},"keywords":["googleanalytics","tracking","performance"],"author":{"name":"Ryan Murphy"},"license":"MIT","bugs":{"url":"https://github.com/texastribune/data-visuals-analytics/issues"},"homepage":"https://github.com/texastribune/data-visuals-analytics#readme","devDependencies":{"autotrack":"2.4.1","documentation":"^5.4.0","microbundle":"^0.4.3","prettier":"^1.10.2"},"gitHead":"a63f98e6341418a0b7e70a8a2142eda146fed963","_id":"@data-visuals/analytics@0.1.0","_npmVersion":"5.6.0","_nodeVersion":"8.9.4","_npmUser":{"name":"rdm","email":"npm@accounts.rdmurphy.org"},"dist":{"integrity":"sha512-IkzUE9a+nAMMm8w3SOMF0GvC0LBAhAQ9mAhKSxbwPFRGEgcGE1rKNhSVHyvTaicUHPNNjgdP3ElHw/btokhPrg==","shasum":"8598d939e66b567b3514b1b1f2c7210ae53564e9","tarball":"https://registry.npmjs.org/@data-visuals/analytics/-/analytics-0.1.0.tgz","fileCount":9,"unpackedSize":91466,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDHGBNmHTQMLkkBcl5Pm9iBLWq2jleAeOzAq5jC9t16bAIhAMxQ8MCWUvU8qHzMzPndzretMyJRFsyxy2luUcU9kAuU"}]},"maintainers":[{"name":"rdm","email":"npm@accounts.rdmurphy.org"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analytics_0.1.0_1518469425449_0.2557174759172274"},"_hasShrinkwrap":false},"0.1.1":{"name":"@data-visuals/analytics","version":"0.1.1","description":"Consistently track how pages perform the Texas Tribune Data Visuals way.","source":"src/index.js","module":"dist/analytics.es.js","main":"dist/analytics.js","umd:main":"dist/analytics.umd.js","files":["dist","README.md"],"scripts":{"build":"npm run build-autotrack && microbundle","build-autotrack":"autotrack --output src/autotrack-plugins.js --plugins cleanUrlTracker,eventTracker","dev":"microbundle watch","docs":"documentation readme src/index.js --no-markdown-toc --quiet --section API","prepublish":"npm run build","postbuild":"npm run docs"},"repository":{"type":"git","url":"git+https://github.com/texastribune/data-visuals-analytics.git"},"keywords":["googleanalytics","tracking","performance"],"author":{"name":"Ryan Murphy"},"license":"MIT","bugs":{"url":"https://github.com/texastribune/data-visuals-analytics/issues"},"homepage":"https://github.com/texastribune/data-visuals-analytics#readme","devDependencies":{"autotrack":"2.4.1","documentation":"^5.4.0","microbundle":"^0.4.3","prettier":"^1.10.2"},"gitHead":"93a4a861bb414fe95a54868dda53fba2faa9ec03","_id":"@data-visuals/analytics@0.1.1","_npmVersion":"5.6.0","_nodeVersion":"8.9.4","_npmUser":{"name":"rdm","email":"npm@accounts.rdmurphy.org"},"dist":{"integrity":"sha512-tXofJjvudrop0CwHVq/hLwbXTkjtYzw9YgErSexq+2+KzWfVC58uPsWHNLBU4Q+FFOZeS9TNP4d7Ma0deXAC+Q==","shasum":"b367a8585307ccb39825478a17e61f1aca478ffe","tarball":"https://registry.npmjs.org/@data-visuals/analytics/-/analytics-0.1.1.tgz","fileCount":9,"unpackedSize":92136,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDfO0gig+M/T0SJ/GVTLNdVCfpG6fM8xD94dwDKdCdiCQIgbNoqPInp9LW+OZ4iNvZXEjnxDQQmyDgsaI0FrFxniCY="}]},"maintainers":[{"name":"rdm","email":"npm@accounts.rdmurphy.org"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analytics_0.1.1_1518479223114_0.41518063655704984"},"_hasShrinkwrap":false}},"time":{"created":"2018-02-12T21:03:45.065Z","0.1.0":"2018-02-12T21:03:46.259Z","modified":"2022-04-05T02:50:56.555Z","0.1.1":"2018-02-12T23:47:03.832Z"},"maintainers":[{"email":"tech@texastribune.org","name":"ttribune"},{"email":"npm@accounts.rdmurphy.org","name":"rdm"}],"description":"Consistently track how pages perform the Texas Tribune Data Visuals way.","homepage":"https://github.com/texastribune/data-visuals-analytics#readme","keywords":["googleanalytics","tracking","performance"],"repository":{"type":"git","url":"git+https://github.com/texastribune/data-visuals-analytics.git"},"author":{"name":"Ryan Murphy"},"bugs":{"url":"https://github.com/texastribune/data-visuals-analytics/issues"},"license":"MIT","readme":"# Data Visuals Analytics\n\nAn easy way to hook up Google Analytics (and any future trackers!) in Data Visuals projects.\n\n## Installation\n\n```sh\nnpm install @data-visuals/analytics\n```\n\n## Usage\n\nTwo of [autotrack's](https://github.com/googleanalytics/autotrack) plugins are included in this library — [`cleanUrlTracker`](https://github.com/googleanalytics/autotrack/blob/master/docs/plugins/clean-url-tracker.md) and [`eventTracker`](https://github.com/googleanalytics/autotrack/blob/master/docs/plugins/event-tracker.md). `cleanUrlTracker` is already pre-configured and requires no extra work, but `eventTracker` only enables what's detailed in the documentation for that plugin and will require extra tagging in your HTML.\n\nThis library **does not** load the Google Analytics library for you. You'll still need to ensure that makes it on the page. However, `@data-visuals/analytics` expects that to happen asynchronously so it can be loaded at any time.\n\nIn your HTML (either right before your `<body>` element closes, or at the bottom of the `<head>`), load the Google Analytics library.\n\n```html\n<!-- Google Analytics -->\n<script async src=\"https://www.google-analytics.com/analytics.js\"></script>\n<!-- End Google Analytics -->\n```\n\nThe library exports an `init()` function to be called. It's recommended that you use Webpack's code splitting functionality (if your environment supports it) to load this library so nothing is blocked by its loading.\n\n```js\nimport(/* webpackChunkName: \"analytics\" */ '@data-visuals/analytics').then(\n  analytics => analytics.init()\n);\n```\n\nIf for some reason you don't want to do that, or you're using this somewhere that isn't allowed, importing it and calling it normally will also work.\n\n```js\nimport { init } from '@data-visuals/analytics';\n\ninit();\n```\n\n## API\n\n<!-- Generated by documentation.js. Update this documentation by updating the source code. -->\n\n### init\n\nInitializes all the analytics setup. Creates trackers and sets initial\nvalues on the trackers.\n\n**Parameters**\n\n-   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**  (optional, default `{}`)\n    -   `options.linkerDomains` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** List of domains to pass to linker plugin (optional, default `DEFAULT_LINKER_DOMAINS`)\n    -   `options.trackingId` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Google Analytics tracking ID (optional, default `DEFAULT_TRACKING_ID`)\n\n**Examples**\n\n```javascript\n// Async method\nimport('@data-visuals/analytics').then(analytics => analytics.init());\n\n// Standard import method\nimport { init } from '@data-visuals/analytics';\n\ninit();\n```\n\nReturns **void** \n\n## License\n\nMIT\n","readmeFilename":"README.md"}