Waylume SDK

@gitsbt/waylume-sdk is an embeddable SDK for adding guided navigation to your website.

It is intended for teams that want to expose Waylume flows directly inside their own product rather than relying only on the browser extension.

What the SDK Does

With the SDK, you can:

• Define guidance flows as JSON
• Attach stable targets to your UI with data-waylume attributes
• Register flows in your application
• Render a launcher that opens the guidance experience
• Resume navigation across route changes

Good Fit

The SDK is a good fit when:

• You control the target application code
• You want the guide entry point to live inside your own UI
• You need a framework-agnostic integration path
• You want SSR-compatible usage patterns

Core Concepts

Targets

Waylume uses stable target identifiers such as data-waylume="upgrade-btn" to connect flow steps to real UI elements.

Flows

A flow is a JSON document that describes:

• The flow id
• A user-facing label
• A list of steps
• Each step target and expected action

Launcher

The launcher is the UI entry point that opens the guidance experience inside the host application.

Auto Resume

For apps with client-side routing, the SDK can resume a flow after page transitions so the user does not lose context.

Next Steps

• Quick Start
• Production Setup