@beyonk/svelte-google-analytics
v2.6.4
Published
<a href="https://beyonk.com"> <br /> <br /> <img src="https://user-images.githubusercontent.com/218949/144224348-1b3a20d5-d68e-4a7a-b6ac-6946f19f4a86.png" width="198" /> <br /> <br /> </a>
Downloads
5,061
Keywords
Readme
Svelte Google Analytics
Supports Google Analytics v4!
Install the package
pnpm i --save-dev @beyonk/svelte-google-analytics
Usage
In App.svelte
import { GoogleAnalytics } from '@beyonk/svelte-google-analytics'
<GoogleAnalytics properties={[ 'google property id A', ...'google property id X' ]} />
Component accepts two additional properties: enabled
and configurations
.
The configurations
property (optional)
configurations
props which accepts an object type with configurations for the properties. The key in this object is the id of the property.
Example on disabling automatic pageviews for the id-1
property:
<GoogleAnalytics
properties={[ 'id-1' ]}
configurations={{ 'id-1': { 'send_page_view': false } }} />
The enabled
property (optional)
The enabled
prop set to true
by default.
Logic can be added here to disable/enable analytics.
If you disable tracking by default, for instance, due to GDPR, then you can enable it later by calling init()
on your component:
<GoogleAnalytics
bind:this={ga}
properties={[ 'id-1' ]}
enabled={false} />
<script>
function enableAnalytics () {
ga.init()
}
</script>
Page Tracking
With Google Analytics v4, most basic events are automatic. See the docs
(see Google Analytics offical docs - Pageviews) for more info
Event Tracking
All events specified in the documentation are implemeneted (generated automatically from scraping the docs pages and building the project!)
<script>
import { ga } from '@beyonk/svelte-google-analytics'
function handleClick () {
ga.games.earnVirtualCurrency('SvelteBucks', 50)
}
</script>
<main>
<button on:click={handleClick}>Get 50 SvelteBucks</button>
</main>
Custom Events
Custom events can be tracked with addEvent
:
<script>
import { ga } from '@beyonk/svelte-google-analytics'
function handleClick () {
ga.addEvent('event_name', {
foo: 'bar',
baz: 'qux'
})
}
</script>
Multiple Properties
To send an event to a different property, specify the property id as the last parameter to the event: send_to
.
ga.games.earnVirtualCurrency('SvelteBucks', 50, 'Property Id B')
Set User Properties
To split user to different segment, such as language preference or geographic location, set the Properties with setUserProperties
and setup custom dimension on Google Analytics dashboard. For more information see Google Analytics Documentation.
ga.setUserProperties({
favorite_composer: 'Mahler',
favorite_instrument: 'double bass',
season_ticketholder: 'true'
})
Set User Id
To identify user inside GA and link their sessions together, set the Properties with setUserId
.
ga.setUserId('user_id_here')
Set config
To add a Google Analytics ID after initialization call the setConfig
and pass optional configuration options.
ga.setConfig('ga_id', opts)