A Nuxt 3 module thats injects Meta Pixel (Facebook Pixel)

• Requirements
• Install
• Getting Started
• License

• npm or yarn
• NuxtJS
• NodeJS

$ npm install --save nuxt3-meta-pixel
// or
$ yarn add nuxt3-meta-pixel

Add nnuxt3-meta-pixel to modules section of nuxt.config.js.

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

By default, the module won't trigger any tracking event on route change. To enable this behaviour, you must specify the autoPageView option and set to true in the Nuxt module options.

{
  modules: [
    'nuxt3-meta-pixel',
  ],
  facebook: {
    /* module options */
    pixelId: 'FACEBOOK_PIXEL_ID',
    autoPageView: true
  },
}

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: [
    'nuxt3-meta-pixel',
  ],
  facebook: {
    ...
    disabled: true
  },
}

How to access $fb ?

import { useNuxtApp } from '#app';
const nuxtApp = useNuxtApp()
console.log(nuxtApp.$fb)

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

nuxtApp.$fb.enable()

The pixel can be disabled again later on by using the .disable() method.

It's possible to use multiple pixel codes according to the user's route. This can be made through the pixels property. The pixels property expects an array of options.

{
  modules: [
    'nuxt3-meta-pixel',
  ],
  facebook: {
    pixelId: 'DEFAULT_PIXEL_ID',
  },
}

Per this example, whenever the user is on the /my-custom-route, it will use the FACEBOOK_PIXEL_ID instead of the DEFAULT_PIXEL_ID. For all the other routes, it will use the default one.

Note : Since the pixels property is an array of options, any other valid option (track, manualMode, ...) can be passed.

To send custom user data when initializing the FB Pixel you'll have to disable the plugin in your Nuxt config file and enable it once you've set the user data.

Run the following from your Vue component once you've access to the user data:

nuxtApp.$fb.setUserData({ external_id: 32323, fn: 'John' })
nuxtApp.$fb.enable()

Read more about Advanced Matching.

List of possible options in the module:

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

MIT License