\nAn Angular library to simplify tracking using a Facebook Pixel.\n
\n\n---\n\n# Introduction\nUsing a Facebook Pixel is fairly simple. You add the script to the `head` section of all pages, after which you can use the `fbq` function. However, in Angular it's not as straight-forward. The main two problems are as follows:\n\n- Navigation using the Angular Router is not tracked.\n- There are no TypeScript definitions by default, so no Intellisense or linting.\n\n***ngx-pixel*** solves both of these issues. It adds a service that can be used in any component to track events and when enabled, it automatically tracks page views for each router navigation. \n\nBy default, ***ngx-pixel*** is **disabled** to make it easier to comply with GDPR and other privacy regulations. The Facebook script is only loaded after ***ngx-pixel*** is enabled, which also helps cut down the initial load time of your application. Read [here](#enabling) how to *enable* and *disable* ***ngx-pixel***.\n\n---\n\n# Usage\nUsing ***ngx-pixel*** is very simple.\n\n## 1. Installing the NPM package\nYou can install the NPM package with `npm install ngx-pixel`\n\n## 2. Add it to your app module\nAdd the library to your app's module, usually `app.module.ts`. Make sure you use the `forRoot()` method. Within this method, add your [Facebook Pixel ID](https://www.facebook.com/business/help/952192354843755). \n```typescript\nimport { PixelModule } from 'ngx-pixel';\n\n@NgModule({\n declarations: [\n AppComponent\n ],\n imports: [\n BrowserModule,\n PixelModule.forRoot({ enabled: true, pixelId: 'YOUR_PIXEL_ID' })\n ],\n providers: [],\n bootstrap: [AppComponent]\n})\nexport class AppModule { }\n```\n**NOTE:** By default, the library does not start tracking immediately. In most cases this requires user consent to comply with GDPR and other privacy regulations. If you would still like start tracking as soon as your app module loads, include the `enabled: true` parameter in when you call `forRoot()`.\n\n## 3. Add it to your components\nIn any component where you would like to track certain events, you can import the ***ngx-pixel service*** with `import { PixelService } from 'ngx-pixel';`\nThen you can inject the service into your component as follows:\n```TypeScript\nexport class HomeComponent {\n\n constructor(\n private pixel: PixelService\n ) { }\n\n}\n```\n\n## 4. Tracking events\nThere are two groups of events that you can track, namely *Standard events* and *Custom events*. \n\n### Standard events\n**Standard events** are common events that Facebook has created. You can find the full list [here](https://developers.facebook.com/docs/facebook-pixel/reference). You can track a Standard event like this:\n\n\nThe first argument is the type of event as defined by Facebook. The optional second argument can be used to pass more information about the event. E.g.: \n```typescript\nthis.pixel.track('InitiateCheckout', {\n content_ids: ['ABC123', 'XYZ456'], // Item SKUs\n value: 100, // Value of all items\n currency: 'USD' // Currency of the value\n});\n```\n\n### Custom events\nTracking **Custom events** works very similar to tracking Standard events. The only major difference is that there are no TypeScript interfaces and therefore no Intellisense. This is because the event *name* and optional *properties* can be anything. Tracking a custom event with ***ngx-pixel*** looks like this:\n```TypeScript\nthis.pixel.trackCustom('MyCustomEvent');\n```\n\nAnd just like with Standard events, you can add more properties. This is recommended, since this enables you to create even more specific audiences within Facebook Business Manager. Which properties you add is completely up to you. Here is an example:\n```TypeScript\nthis.pixel.trackCustom('MyCustomEvent', {\n platform: 'limewire'\n})\n```\n\n---\n\n# Enabling and disabling ***ngx-pixel*** \n***ngx-pixel*** is disabled by default. In many cases, tracking without user consent is not allowed by privacy regulations like the European GDPR. ***ngx-pixel*** also doesn't inject the Facebook scripts until it is iniaitlized (upon consent), which helps cut down the initial loading size and time of your application.\n\n## Enabling ***ngx-pixel*** immediately\nIt is still possible to initialize ***ngx-pixel*** as soon as your app module loads.\nWhen adding ***ngx-pixel*** to `app.module.ts`, add the parameter `enabled: true`.\n```TypeScript\nimports: [\n BrowserModule,\n PixelModule.forRoot({ enabled: true, pixelId: 'YOUR_PIXEL_ID'})\n],\n```\n\n## Enabling ***ngx-pixel*** from a component\nYou can also enable ***ngx-pixel*** from within any of your components, like so:\n```TypeScript\nexport class HomeComponent {\n\n constructor(\n private pixel: PixelService\n ) { }\n\n onConsent(): void {\n this.pixel.initialize();\n }\n\n}\n```\n\n## Enabling with a dynamic Pixel ID\nIn situations where the Pixel ID needs to be changed dynamically, this can be done using `initialize()` with the new Pixel ID as an optional argument. \n**Notes:** \n- A Pixel ID still needs to be provided when importing ***ngx-pixel*** in the module.\n- The previous instance should be removed with `remove()` before initializing a new Pixel ID. \n- This approach should **not** be used in combination with serverside rendering (SSR). As the module is initialized on each request, the Pixel script will default to the ID provided in the module. \n\n## Disabling ***ngx-pixel***\nDisabling works very similar to *enabling* from within a component and looks like this:\n```TypeScript\nexport class HomeComponent {\n\n constructor(\n private pixel: PixelService\n ) { }\n\n onRevokeConsent(): void {\n this.pixel.remove();\n }\n\n}\n```\n\n---\n\n# Important notes\n- Backwards compatibility is not guaranteed. ***ngx-pixel*** was developed using Angular 11, which uses the Ivy compiler instead of the older View Engine compiler. If your project uses Angular 8 or earlier, or if you've decided to keep using View Engine with newer Angular versions, ***ngx-pixel*** might not be compatible, although I have not yet tested this to confirm.\n\n---\n\n# What's next?\n- [X] Adding Angular Universal SSR support.\n- [ ] Adding tests.\n- [ ] Removing all Facebook scripts on removal, not just the initial script.\n\n---\n\nCreated with ❤️ by Niels Kersic, [niels.codes](https://niels.codes).\n\n\n\n\n\n\n\n","readmeFilename":"README.md"}