Skip to content

@guideflow/svelte

Svelte stores and utilities for GuideFlow product tours.

npm version

Installation

bash
npm install @guideflow/core @guideflow/svelte

Key Exports

ExportDescription
createTourStore()Creates a reactive tour store

TourStore Properties

PropertyTypeDescription
isActiveReadable<boolean>Tour running state
currentStepIdReadable<string | null>Current step ID
currentStepIndexReadable<number>Current step index
totalStepsReadable<number>Total steps
start(flow)MethodStart a tour
stop()MethodStop the tour
next()MethodNext step
prev()MethodPrevious step

Peer Dependencies

  • svelte ^4.0.0 || ^5.0.0

Released under the MIT License.