Drop-in product analytics for Vue 3 & Nuxt auto-captures user behaviour, and lets AI tell you what happened in plain language.
--- tigr is a product analytics platform that turns raw events into clear, actionable insights. No charts to decode, no data team required you install the SDK, and tigr does the rest. This package is the Vue/Nuxt client. > The framework-agnostic engine lives in [`src/core/`](./src/core) with zero Vue > imports, so the same folder powers `tigr-react` (and friends) unchanged. ## Install ```bash npm install tigr-vue ``` ## Quick start Install the plugin once with your project API key. That's it page views, rage clicks, scroll depth, errors and page leaves are captured automatically. ### Vue ```ts // main.ts import { createApp } from 'vue' import { TigrPlugin } from 'tigr-vue' import App from './App.vue' createApp(App) .use(TigrPlugin, { apiKey: 'tigr_pk_...' }) .mount('#app') ``` ### Nuxt Register it as a **client-only** plugin (the SDK only runs in the browser): ```ts // plugins/tigr.client.ts import { TigrPlugin } from 'tigr-vue' export default defineNuxtPlugin((nuxtApp) => { nuxtApp.vueApp.use(TigrPlugin, { apiKey: 'tigr_pk_...' }) }) ``` > Get your API key from your project's **Settings** at > [usetigr.app](https://usetigr.app). ## Tracking custom events Grab the client in any component with `useTigr()`: ```vue ``` ## Identifying users Attach a stable user id (and optional traits) so events are tied to a person: ```ts const tigr = useTigr() // after login tigr.setUser('user_123', { email: 'jane@acme.io', plan: 'pro' }) // on logout tigr.reset() ``` `identify()` is the same as `setUser()` — use whichever reads better. ## Configuration ```ts app.use(TigrPlugin, { apiKey: 'tigr_pk_...', autoCapture: true, // true | false | { pageview, scrollDepth, error, pageLeave } flushInterval: 2000, // ms before a buffered batch is sent (default 2000) batchSize: 20, // force a flush at this many events (default 20) debug: false, // log every event + flush to the console devMode: false, // when true, the SDK does nothing (use in development) }) ``` | Option | Type | Default | Description | | --------------- | ------------------------------------- | ------- | ----------- | | `apiKey` | `string` | — | **Required.** Your project API key. | | `host` | `string` | tigr cloud | Where events are sent. Override to point at a self-hosted / local ingestion service. | | `autoCapture` | `boolean \| Partial