vue-analytics-fb

1.1.2 • Public • Published

vue-analytics-fb

npm

A small wrapper around fbq. This package integrates Facebook pixel into your Vue app.

This is originally forked from wemake-services/vue-analytics-facebook-pixel, with the plan to expand it further.

Installation

npm install vue-analytics-fb

Also, this library requires installing Facebook Pixel API.

Usage

Preparations

import Vue from 'Vue'
import VueFacebookPixel from 'vue-analytics-fb'
 
Vue.use(VueFacebookPixel)

Calling API

To start using this script you will have to call init(...) first.

/**
 * Init facebook tracking pixel
 * @param  {String} appId 
 * @param  {object} [data={}] 
 */
Vue.analytics.fbq.init('YOUR_FACEBOOK_CODE', {
  em: 'user@mail.com'
})

Make sure init(...) is called only once.

Then you will have full access to the event(...) method.

/**
 * Event tracking
 * @param  {String} name 
 * @param  {object} [data={}] 
 */
Vue.analytics.fbq.event('ViewContent', {
  content_name: 'Really Fast Running Shoes'
})

Inside component

All component instances can call this.$analytics.fbq

Naming convention

All vue-analytics-* share the same analytics object, where all the providers are stored.

Facebook script

Facebook Pixel API is required to be installed. You can skip the default window.fbq('init', 'KEY') part and use Vue.analytics.fbq.init(...) which will do the same.

Dependencies (0)

    Dev Dependencies (27)

    Package Sidebar

    Install

    npm i vue-analytics-fb

    Weekly Downloads

    7

    Version

    1.1.2

    License

    MIT

    Unpacked Size

    16.3 kB

    Total Files

    10

    Last publish

    Collaborators

    • jamiewarb