User Onboarding for Vue | BreakGround

User Onboarding for Vue

BreakGround works in any Vue app via a single JavaScript snippet — Vue 3, Vue 2, Nuxt 3, Nuxt 2, or vanilla Vue. The runtime SDK is framework-agnostic, so it doesn't conflict with Pinia, Vuex, or your reactivity setup.

BreakGround is delivered as a client-side script that runs in the browser, not as a Vue plugin. Vue 3 Composition API, Vue 2 Options API, Nuxt 3, Nuxt 2 — all supported. The SDK doesn't interact with Vue's reactivity system, so it can't break Pinia, Vuex, or any state-management library. Route changes are detected via the History API, so vue-router navigations are picked up automatically.

How to set up

  1. Install in your entry HTML: Add the snippet to `index.html` (Vite) or `nuxt.config.ts` (Nuxt).
  2. Identify users (optional): Identify users once they log in, from any composable.
  3. Generate guides from your URL: Paste your Vue app URL into the BreakGround dashboard. AI generates the first onboarding guide automatically.

Capabilities

  • Vue 3 and Vue 2 both supported: Same snippet for both Vue versions. No fork in the codebase based on which Vue version you ship.
  • Nuxt-friendly: Works with Nuxt 3 (Vite + Nitro) and Nuxt 2 (Webpack + classic Nuxt). SSR is unaffected.
  • No reactivity interference: BreakGround targets the rendered DOM, not Vue's reactivity system, so Pinia/Vuex stores are untouched.
  • vue-router-aware guides: Guides targeting specific Vue routes only fire on those routes — vue-router navigations are detected automatically.

Frequently asked questions

Does BreakGround interfere with Pinia or Vuex?

No. The SDK doesn't touch Vue's reactivity system. It targets the rendered DOM directly, so your store implementation — Pinia, Vuex, or homegrown — is untouched.

Do I need a developer to set this up?

No. After the snippet is installed once, every guide, tooltip, and announcement is authored by a non-technical user through the BreakGround dashboard. Engineering is involved for the install only — typically a 5-minute task.

Will the BreakGround snippet slow down my site?

The runtime SDK is loaded asynchronously and tree-shaken to ship only what each user needs. Typical impact on Core Web Vitals is below 50ms. The snippet does not block first paint.