@ops-ai/nuxt-toggly-client

@ops-ai/nuxt-toggly-client

Client-side feature flag composables and components for Nuxt/Vue 3

Install

npm install @ops-ai/nuxt-toggly-client

Documentation

• docs.toggly.io
• SDK catalog: root README

License

MIT — see also the repository LICENSE.

Issues

Use the structured issue templates.

SSR and hydration

Nuxt module 1.2.0 supplies an isolated Vue provider per SSR request, then hydrates its evaluated flags in the browser. getTogglyClient() is a browser convenience; on the server, retain the instance returned by createToggly() or use the provided useToggly() instance. Ordinary uninitialized gates keep their loading behavior; a ready hydration snapshot can render boolean gates synchronously.

Frontend telemetry

Configured browser clients send compact feature checks and app-level metrics by default. SSR projection, keyless clients, and server rendering remain silent. Refresh alone is not a check; mounted consumers that recompute their visibility evaluate effective local/entity gates and record checks. Configure the independent browser transport through enableTelemetry, metricsBaseUrl, and telemetryFlushIntervalMs (30–60 seconds). Existing enableUsageTracking: false and enableMetrics: false settings opt out of their respective categories.

const toggly = createToggly({
  appKey: 'your-app-key',
  metricsBaseUrl: 'https://metrics.toggly.io',
})

await toggly.init()
toggly.telemetry.recordUsage('checkout', 'blue')
toggly.telemetry.recordView('checkout')
toggly.telemetry.incrementCounter('checkout-completed')
toggly.telemetry.setGauge('cart-items', 3)
await toggly.telemetry.flushTelemetry()

// When the application owner is finally disposed:
toggly.client.destroy()

The legacy recordUsage(feature, identity?, variant?) and recordView signatures are unchanged; browser forwarding uses only the third argument as the variant. The second per-call identity is not used for attribution; the owner supplies optional i (host-provided instanceId) or u (identity, including a generated identity). Use setContext to rotate context; queued records retain their original attribution. Legacy browser measure and observe calls are unsupported payload-free no-ops with bounded diagnostics. Migrate accumulating whole-number values to telemetry.incrementCounter and current values to telemetry.setGauge.

Browser identity changes clear an omitted token. Failed refreshes retain the new context and matching cache/defaults. Persisted feature bodies and validators are scoped together by context and response mode, bounded to eight snapshots per route/mode. Cold hydration remains check-free; actual mounted consumer recomputation records checks. Pending consumer results cannot overwrite a newer evaluation or unmounted UI.