Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

nuxt-facebook-pixel-module

1.3.0 • Public • Published

nuxt-facebook-pixel-module

npm (scoped with tag) npm js-standard-style CircleCI

A NuxtJS module thats injects Facebook Pixel code

Table of Contents

Requirements

  • npm or yarn
  • NuxtJS
  • NodeJS

Install

$ npm install --save nuxt-facebook-pixel-module
// or
$ yarn add nuxt-facebook-pixel-module

Getting Started

Add nuxt-facebook-pixel-module to modules section of nuxt.config.js.

{
  modules: [
    // Simple usage
    'nuxt-facebook-pixel-module',
 
    // With options
    ['nuxt-facebook-pixel-module', {
      /* module options */
      track: 'PageView',
      pixelId: 'FACEBOOK_PIXEL_ID',
      disabled: false
    }],
 ]
}

or even

{
  modules: [
    'nuxt-facebook-pixel-module',
  ],
  facebook: {
    /* module options */
    track: 'PageView',
    pixelId: 'FACEBOOK_PIXEL_ID',
    disabled: false
  },
}

Disabling the pixel (for GDPR)

If you'd like to install the pixel disabled, and enable it later after the user has consented to its use, you can do so by setting disabled: true in the pixel configuration:

{
  modules: [
    'nuxt-facebook-pixel-module',
  ],
  facebook: {
    ...
    disabled: true
  },
}

Now, in your component, you can call the following in order to start the pixel and track the current page.

this.$fb.enable()

Module options

List of possible options in the module:

Option Default Required Description
pixelId null true The unique pixel identifier provided by Facebook.
track PageView false Default tracking event.
version 2.0 false Tracking version.
disabled false false Disable the Pixel by default when initialized. Can be enabled later through $fb.enable().

Facebook pixel instance

The tracking pixel instance is available on all vue component instances as $fb. It has the following methods:

Method Purpose Equivalent to
enable() If you had previously set disabled: true in config, enables the pixel and tracks the current page view $fb.init(), $fb.track()
init() Initialises the pixel fbq('init', <options.pixelId>)
track(event) Sends a track event. It's PageView by default if the event is not defined. fbq('track', <options.track>)
query(key, value, parameters) Call the underlying fbq instance with anything else. The parameters attribute is optional. fbq(key, value, parameters)

License

MIT License

Keywords

none

Install

npm i nuxt-facebook-pixel-module

DownloadsWeekly Downloads

2,725

Version

1.3.0

License

MIT

Unpacked Size

9.23 kB

Total Files

6

Last publish

Collaborators

  • avatar