@guideflow/core
Zero-dependency FSM engine for product tours, spotlights, hotspots, and hints.
The core engine behind GuideFlow. Framework-agnostic — use it with vanilla JS or pair it with a framework adapter.
Installation
bash
npm install @guideflow/coreKey Exports
| Export | Description |
|---|---|
createGuideFlow() | Main factory — returns a GuideFlowInstance |
createMachine() | Low-level FSM state machine |
TourEngine | Tour lifecycle management |
SpotlightOverlay | Animated SVG cutout overlay |
HotspotManager | Persistent pulsing beacons |
HintSystem | Hint badge management |
ProgressStore | localStorage / IndexedDB persistence |
BroadcastSync | Cross-tab sync via BroadcastChannel |
I18nRegistry | Translation registry with locale fallback |
DefaultRenderer | Built-in step renderer |