API Reference

Comprehensive API reference for all useFlow functions, components, and types.

Core APIs

defineFlow()

Create typed flow definitions with steps, branching, and versioning.

<Flow /> component

Primary React component for rendering flows with full control over layout and behavior.

useFlowState() hook

Access flow state and navigation methods from step components.

FlowProvider

Configure default settings for all flows in your application.

Persistence APIs

createPersister()

Create persisters with validation, TTL, and callbacks.

Storage Stores

Built-in stores for localStorage, sessionStorage, AsyncStorage, and memory.

Custom Stores

Implement custom storage backends for databases, APIs, or cloud storage.

Type utilities

Comprehensive TypeScript types for type-safe flow development:

• FlowDefinition - Flow configuration type
• RuntimeFlowDefinition<TDefinition, TContext> - Returned by defineFlow()
• UseFlowReturn<TContext> - Return type of useFlowState()
• FlowContext - Base type for context objects
• PersistedFlowState<TContext> - Saved state structure
• MigrateFunction<TContext> - Migration function type
• ResolveFunction - Branching resolver type

See the Type Safety guide for detailed type information.