Skip to content

update for vue 3 #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
agus24 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

update for vue 3 #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
122 changes: 64 additions & 58 deletions src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,38 +4,47 @@
* Configuration
* @type {Object}
*/
let config = {
const config = {
debug: false,
excludes: []
}

let standardEvents = [
'addpaymentinfo', 'addtocart', 'addtowishlist',
'completeregistration', 'contact', 'customizeproduct',
'donate',
'findlocation',
'initiatecheckout',
'lead',
'pageview', 'purchase',
'schedule', 'search', 'starttrial', 'submitapplication', 'subscribe',
'viewcontent'
]
excludes: [],
};

const standardEvents = [
"addpaymentinfo",
"addtocart",
"addtowishlist",
"completeregistration",
"contact",
"customizeproduct",
"donate",
"findlocation",
"initiatecheckout",
"lead",
"pageview",
"purchase",
"schedule",
"search",
"starttrial",
"submitapplication",
"subscribe",
"viewcontent",
];

// Private functions

const _fbqEnabled = () => {
if (typeof window.fbq === 'undefined') {
if (typeof window.fbq === "undefined") {
if (config.debug) {
console.log(
'[Vue Facebook Pixel]: `window.fbq` is not defined, skipping'
)
"[Vue Facebook Pixel]: `window.fbq` is not defined, skipping"
);
}

return false
return false;
}

return true
}
return true;
};

// Public functions

Expand All @@ -45,96 +54,93 @@ const _fbqEnabled = () => {
* @param {object} [data={}]
*/
const init = (appId, data = {}) => {
if (!_fbqEnabled()) return
if (!_fbqEnabled()) return;

if (config.debug) {
console.log(
`[Vue Facebook Pixel] Initializing app ${appId}`
)
console.log(`[Vue Facebook Pixel] Initializing app ${appId}`);
}

query('init', appId, data)
}
query("init", appId, data);
};

/**
* Event tracking
* @param {String} name
* @param {object} [data={}]
*/
const event = (name, data = {}) => {
if (!_fbqEnabled()) return
if (!_fbqEnabled()) return;

if (config.debug) {
console.groupCollapsed(
`[Vue Facebook Pixel] Track event "${name}"`)
console.log(`With data: ${data}`)
console.groupEnd()
console.groupCollapsed(`[Vue Facebook Pixel] Track event "${name}"`);
console.log(`With data: ${data}`);
console.groupEnd();
}

if (!standardEvents.includes(name.toLowerCase())) query('trackCustom', name, data)
else query('track', name, data)
}
if (!standardEvents.includes(name.toLowerCase()))
query("trackCustom", name, data);
else query("track", name, data);
};

/**
* Submit a raw query to fbq, for when the wrapper limits user on what they need.
* This makes it still possible to access the plain Analytics api.
* @param mixed ...args
*/
const query = (...args) => {
if (!_fbqEnabled()) return
if (!_fbqEnabled()) return;

if (config.debug) {
console.groupCollapsed(
`[Vue Facebook Pixel] Raw query`)
console.log(`With data: `, ...args)
console.groupEnd()
console.groupCollapsed(`[Vue Facebook Pixel] Raw query`);
console.log(`With data: `, ...args);
console.groupEnd();
}

window.fbq(...args)
}
window.fbq(...args);
};

/**
* Vue installer
* @param {Vue instance} Vue
* @param {Object} [options={}]
*/
const install = (Vue, options = {}) => {
const install = (app, options = {}) => {
//
const { router, debug, excludeRoutes } = options
const { router, debug, excludeRoutes } = options;

config.excludes = excludeRoutes || config.excludes
config.debug = !!debug
config.excludes = excludeRoutes || config.excludes;
config.debug = !!debug;

// These objects may contain different providers as well,
// or might be empty:
if (!Vue.analytics) {
Vue.analytics = {}
if (!app.analytics) {
app.analytics = {};
}

if (!Vue.prototype.$analytics) {
Vue.prototype.$analytics = {}
if (!app.config.globalProperties.$analytics) {
app.config.globalProperties.$analytics = {};
}

// Setting values for both Vue and component instances
// Usage:
// 1. `Vue.analytics.fbq.init()`
// 2. `this.$analytics.fbq.init()`

Vue.analytics.fbq = { init, event, query }
Vue.prototype.$analytics.fbq = { init, event, query }
app.analytics.fbq = { init, event, query };
app.config.globalProperties.$analytics.fbq = { init, event, query };

// Support for Vue-Router:
if (router) {
const { excludes } = config
const { excludes } = config;

router.afterEach(({ path, name }) => {
if (excludes.length && excludes.indexOf(name) !== -1) {
return
return;
}

Vue.analytics.fbq.event('PageView')
})
app.analytics.fbq.event("PageView");
});
}
}
};

export default { install }
export default { install };