README.md

spyfu-vue-analytics

Installation

This plugin enables easy logging of events to third party analytics providers.

# install with yarn
yarn add spyfu-vue-analytics

# or install with npm
npm install spyfu-vue-analytics

Basic usage

Once the package is pulled in, you must instruct Vue to use it.

import Analytics from 'spyfu-vue-analytics';
import Vue from 'vue';

Vue.use(Analytics, {
    events: {
        userSignup: {
            google: {
                // define any additional data to pass to the
                // google handler when this event happens.
            },
        },
    },
    handlers: {
        google(eventName, eventConfig, payload) {
            // log event to google analytics
        },
    },
    logPageView(route) {
        // log page view event
    },
});

Finally, when an event you care about happens, use the $logEvent function to call your handlers.

// component.vue
export default {
    methods: {
        onUserSignup() {
            this.$logEvent('userSignup', payload);
        },
    },
};