API Reference

Complete API documentation for all GuideFlow.js packages.

Core API

• createGuideFlow() — Factory function to create a GuideFlow instance
• FlowDefinition — Flow (state machine) definition type
• Step — Step configuration type
• TourEngine — Tour lifecycle management
• FlowMachine — Finite state machine internals
• ProgressStore — Persistence API

React API

• TourProvider — Context provider component
• useTour() — Tour state and controls hook
• TourStep — Step renderer component
• GuidePopover — Popover component

Vue API

• GuideFlowPlugin — Vue 3 plugin and useGuideFlow() accessor
• useTour() — Reactive composable for tour state and controls

Svelte API

• createTourStore() — Svelte store-based tour API

AI API

• createAI() — Attach AI capabilities to a GuideFlow instance
• GuideBrain — Tour generation, intent detection, and chat
• Providers — OpenAI, Anthropic, Ollama, and Mock providers

Analytics API

• AnalyticsCollector — Subscribe to tour events and forward to transports
• Transports — PostHog, Mixpanel, Amplitude, Segment, Webhook
• ExperimentEngine — Deterministic client-side A/B testing

CLI

• CLI Reference — guideflow init, studio, export, push