-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Idiomatic Angular wrapper for Takt, privacy-friendly analytics. Standalone APIs for Angular 17+.
pnpm add @vskstudio/takt-angular @vskstudio/takt-coreRegister Takt once at bootstrap with provideTakt. It boots only in the browser, fires the initial pageview, wires up the requested autocapture, and disposes everything when the app is destroyed.
import { bootstrapApplication } from '@angular/platform-browser'
import { provideTakt } from '@vskstudio/takt-angular'
import { AppComponent } from './app/app.component'
bootstrapApplication(AppComponent, {
providers: [
provideTakt({
// domain defaults to location.hostname, endpoint to /api/event
outbound: true, // auto-track outbound links
files: true, // auto-track downloads (or pass ['pdf', 'zip'])
// spa: true, respectDnt: true, excludeLocalhost: true (defaults)
}),
],
})SSR-safe: on the server provideTakt is inert and TaktService no-ops.
Inject TaktService anywhere. Every method is a never-throwing no-op before init or on the server.
import { Component, inject } from '@angular/core'
import { TaktService } from '@vskstudio/takt-angular'
@Component({ /* ... */ })
export class CheckoutComponent {
private readonly takt = inject(TaktService)
buy() {
this.takt.track('Purchase', {
props: { plan: 'pro' },
revenue: { amount: '29.00', currency: 'EUR' },
})
}
// takt.pageview(), takt.optOut(), takt.optIn() are also available.
}The taktEvent directive resolves the live instance at click time.
import { TaktEventDirective } from '@vskstudio/takt-angular'
@Component({
standalone: true,
imports: [TaktEventDirective],
template: `
<button
taktEvent="Signup"
[taktProps]="{ plan: 'pro' }"
[taktRevenue]="{ amount: '29.00', currency: 'EUR' }"
>
Sign up
</button>
`,
})
export class SignupComponent {}Standalone, server-rendered widget components. The badge is an <img> (SVG); the embed is a sandboxed <iframe> (sandbox="allow-scripts allow-same-origin", referrerpolicy="strict-origin-when-cross-origin"). Both lazy-load.
import { TaktBadgeComponent, TaktEmbedComponent } from '@vskstudio/takt-angular'
@Component({
standalone: true,
imports: [TaktBadgeComponent, TaktEmbedComponent],
template: `
<takt-badge domain="example.com" variant="d" glyph="dash" lang="fr" alt="Visits" />
<takt-embed domain="example.com" theme="dark" [width]="404" [height]="264" />
`,
})
export class StatsComponent {}<takt-badge> inputs: domain (required), variant ('a' | 'b' | 'd'), glyph ('unplug' | 'dash' | 'off' | 'eyeoff'), lang ('fr' | 'en'), host, and alt — an overridable label that defaults to "takt".
<takt-embed> inputs: domain (required), theme ('light' | 'dark' | 'auto'), lang, host, width (404), height (264), title ("takt").
The optional host input must be an absolute http(s) URL — core validates it (throwing on anything else, e.g. a javascript: URL) and reduces a valid host to its origin (dropping any path or query). An empty host targets the same origin. The embed src is built by core's trusted URL builder and only then passed through bypassSecurityTrustResourceUrl, so the sanitizer bypass only ever trusts a scheme-checked URL.
Read public stats programmatically with createStats:
import { createStats } from '@vskstudio/takt-angular'
const stats = createStats({ domain: 'example.com' })
const summary = await stats.summary({ period: '7d' })
const series = await stats.timeseries({ period: '30d' })For non-Angular pages (or a plain <script> tag), use the self-contained <takt-analytics> element. Privacy attributes are on by default; set them to false to disable.
import { defineTaktElement } from '@vskstudio/takt-angular/element'
defineTaktElement() // also auto-runs on import<takt-analytics domain="example.com" outbound files></takt-analytics>Via CDN (bundles core, no build step):
<script type="module" src="https://unpkg.com/@vskstudio/takt-angular/dist/element/index.js"></script>
<takt-analytics></takt-analytics>| Export | Description |
|---|---|
provideTakt(config?) |
EnvironmentProviders — install at bootstrap. |
TaktService |
Injectable: track, pageview, optOut, optIn, instance. |
TaktEventDirective |
[taktEvent] standalone directive for click tracking. |
TaktBadgeComponent |
<takt-badge> standalone component — server-rendered SVG badge. |
TaktEmbedComponent |
<takt-embed> standalone component — sandboxed server-rendered iframe. |
createStats(opts?) |
Public stats client (summary/timeseries/realtime/breakdown). |
TAKT_CONFIG |
InjectionToken holding the resolved config. |
defineTaktElement |
Registers <takt-analytics> (from ./element). |
domain?, endpoint?, outbound = false, files = false (or string[]), spa = true, respectDnt = true, excludeLocalhost = true.
MIT © VSK Studio
- Repository: github.com/vskstudio/takt-angular
-
npm:
@vskstudio/takt-angular - Core: takt-core · its wiki
Core
Framework wrappers