User Onboarding for Angular | BreakGround

User Onboarding for Angular

BreakGround works in any Angular application via a single JavaScript snippet. There's no Angular module to register, no zone-aware wrapper, and no integration with Angular's change detection — just a script that runs in the browser.

BreakGround supports Angular 14, 15, 16, 17, and 18 across both Standalone Components and NgModule architectures. The snippet runs outside Angular's zone, so it doesn't trigger unnecessary change detection. SPA navigations through Angular's `Router` are detected via the History API. Server-side rendering with Angular Universal is unaffected because the SDK runs only in the browser.

How to set up

  1. Add the snippet to index.html: Drop the BreakGround script tag into your project's `index.html`.
  2. Identify users from a service: Add a small Angular service that calls `BreakGround.identify` after login.
  3. Generate guides: Open the BreakGround dashboard, paste your Angular app URL, and AI generates the first onboarding guide automatically.

Capabilities

  • Standalone or NgModule: Same snippet for both architectures. The SDK is independent of how Angular is wired.
  • Zone-friendly: BreakGround runs outside Angular's zone, so it doesn't trigger spurious change detection runs.
  • Angular Universal compatible: SSR with Angular Universal works without modification — the SDK runs only on the browser side.
  • Router-aware guides: Guides targeting specific routes — `/admin`, `/onboarding`, etc. — fire only on those routes.

Frequently asked questions

Will BreakGround trigger unnecessary change detection?

No. The SDK runs outside Angular's zone, so its event listeners and DOM observers don't trigger Angular change detection cycles. Performance is unaffected.

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.