Skip to content

@guideflow/core

Zero-dependency FSM engine for product tours, spotlights, hotspots, and hints.

npm versionBundle Size

The core engine behind GuideFlow. Framework-agnostic — use it with vanilla JS or pair it with a framework adapter.

Installation

bash
npm install @guideflow/core

Key Exports

ExportDescription
createGuideFlow()Main factory — returns a GuideFlowInstance
createMachine()Low-level FSM state machine
TourEngineTour lifecycle management
SpotlightOverlayAnimated SVG cutout overlay
HotspotManagerPersistent pulsing beacons
HintSystemHint badge management
ProgressStorelocalStorage / IndexedDB persistence
BroadcastSyncCross-tab sync via BroadcastChannel
I18nRegistryTranslation registry with locale fallback
DefaultRendererBuilt-in step renderer

Released under the MIT License.