Skip to content

A re-frame effects handler for performing Google Analytics tasks

License

Notifications You must be signed in to change notification settings

district0x/re-frame-google-analytics-fx

Repository files navigation

re-frame-google-analytics-fx

This is re-frame library, which contains several Effect Handlers for working with Google Analytics.

Installation

[district0x.re-frame/google-analytics-fx "1.0.0"]
(ns my.app
  (:require [district0x.re-frame.google-analytics-fx])

Add Google Analytics snippet to your page. Don't copy this one, may be outdated

<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-XXXXX-Y', 'auto');
</script>

Usage

To enable or disable logging use:

(district0x.re-frame.google-analytics-fx/set-enabled! false)
; To Disable while developing:
(district0x.re-frame.google-analytics-fx/set-enabled! (not goog.DEBUG))

Following effect handlers are available. Note, none of parameters is mandatory. fields-object always goes through clj->js

:ga/page-view

Page Tracking

(reg-event-fx
  :some-event
  (fn []
    {:ga/page-view [url fields-object]}))

:ga/event

Event Tracking

(reg-event-fx
  :some-event
  (fn []
    {:ga/event [category action label value fields-object]}))

:ga/social

Social Interactions

(reg-event-fx
  :some-event
  (fn []
    {:ga/social [social-network social-action social-target fields-object]}))

:ga/screen-view

Screen Tracking

(reg-event-fx
  :some-event
  (fn []
    {:ga/screen-view [fields-object]}))

:ga/timing

User Timings

(reg-event-fx
  :some-event
  (fn []
    {:ga/timing [timing-category timing-var timing-value timing-label fields-object]}))

:ga/exception

Exception Tracking

(reg-event-fx
  :some-event
  (fn []
    {:ga/exception [description fatal?]}))

:ga/send

Send

(reg-event-fx
  :some-event
  (fn []
    {:ga/send [fields-object]}))

:ga/set

Set

(reg-event-fx
  :some-event
  (fn []
    {:ga/set [fields-object]}))

:ga/create

Create

(reg-event-fx
  :some-event
  (fn []
    {:ga/create [tracking-id cookie-domain name fields-object]}))

About

A re-frame effects handler for performing Google Analytics tasks

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages