Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Tracks: Add basic util methods for tracks. (https://github.com/woocommerce/woocommerce-admin/pull/397)

This commit is contained in:
Timmy Crawford 2018-09-17 09:42:04 -07:00 committed by GitHub
parent c8ee6cf8e3
commit e541d4032f
1 changed files with 36 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
plugins/woocommerce-admin/client/lib/tracks.js Normal file
View File

@ -0,0 +1,36 @@
/** @format */
/**
* Record an event to Tracks
*
* @param {String} eventName The name of the event to record, always prefixed with wca_
* @param {Object} eventProperties event properties to include in the event
*/
export function recordEvent( eventName, eventProperties ) {
if ( ! wcSettings.trackingEnabled ) {
return false;
}
// TODO - should we add validation/whitelist of tracks
// TODO - Don't send tracks in dev envs maybe based off WP_DEBUG?
const event = `wca_${ eventName }`;
// Should already be initialized via inline ./lib/clicent-assets.php
// but just being extra safe
window._tkq = window._tkq || [];
window._tkq.push( [ 'recordEvent', event, eventProperties ] );
}
/**
* Record a page view to Tracks
*
* @param {String} path the page/path to record a page view for
*/
export function recordPageView( path ) {
if ( ! path ) {
return;
}
recordEvent( 'page_view', { path } );
}