https://github.com/hex-digital/vue-analytics-fb
Small wrapper around FBQ for analytics
https://github.com/hex-digital/vue-analytics-fb
Last synced: 11 months ago
JSON representation
Small wrapper around FBQ for analytics
- Host: GitHub
- URL: https://github.com/hex-digital/vue-analytics-fb
- Owner: hex-digital
- License: mit
- Created: 2018-08-16T12:04:57.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-08-16T12:29:37.000Z (almost 8 years ago)
- Last Synced: 2024-12-27T03:12:26.691Z (over 1 year ago)
- Language: JavaScript
- Size: 46.9 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# vue-analytics-fb
[](https://www.npmjs.com/package/vue-analytics-fb)
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
```bash
npm install vue-analytics-fb
```
Also, this library requires installing [Facebook Pixel API](https://developers.facebook.com/docs/ads-for-websites/tag-api/).
## Usage
### Preparations
```javascript
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.
```javascript
/**
* 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.
```javascript
/**
* 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](https://developers.facebook.com/docs/ads-for-websites/tag-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.