@webticks/sveltekit

SvelteKit integration for WebTicks analytics.

Installation

npm install @webticks/sveltekit

Quick Start

Add the component to your root layout with explicit configuration:

<!-- src/routes/+layout.svelte -->
<script>
  import { WebticksAnalytics } from '@webticks/sveltekit';
</script>

<WebticksAnalytics 
  serverUrl="https://your-api.com/track" 
  appId="your-app-id" 
/>
<slot />

Best Practices: Environment Variables

For security and flexibility, it is highly recommended to source your configuration from SvelteKit's environment modules.

<!-- src/routes/+layout.svelte -->
<script>
  import { PUBLIC_WEBTICKS_BACKEND_URL, PUBLIC_WEBTICKS_APP_ID } from '$env/static/public';
</script>

<WebticksAnalytics 
  serverUrl={PUBLIC_WEBTICKS_SERVER_URL} 
  appId={PUBLIC_WEBTICKS_APP_ID} 
/>

Props

| Prop | Type | Description | |------|------|-------------| | serverUrl | string | Recommended. URL to send analytics. Defaults to /api/track. | | appId | string | Required. Your application ID. | | debug | boolean | Optional. Enable console logging. Defaults to false. |

[!NOTE] appId and serverUrl are typically provided by the webticks-api project, which you can self-host. Alternatively, you can use any backend that implements the WebTicks ingestion API.

License

MPL-2.0