`tourStorage`

Package: @trailguide/core (also re-exported from @trailguide/runtime)

Utilities for persisting tour state in localStorage. Used internally by useTrailManager and available for custom integrations.

Import

import { tourStorage } from '@trailguide/core'
// or:
import { tourStorage } from '@trailguide/runtime'

Returns true if the tour has been completed or skipped.

tourStorage.hasCompleted('onboarding') // → boolean

Marks the tour as completed so it won’t auto-show again. Called automatically by useTrailManager when once: true.

tourStorage.markCompleted('onboarding')

Returns the last step index the user reached, or null if no progress has been saved.

const step = tourStorage.getProgress('onboarding') // → number | null

Saves the user’s current step. Called automatically by useTrailManager on each onStepChange when resumable: true.

tourStorage.saveProgress('onboarding', 3)

Clears the saved step index without touching the completion flag.

tourStorage.clearProgress('onboarding')

Clears both the completion flag and progress for a single tour. The next page visit will auto-show the tour again (if once: true).

tourStorage.reset('onboarding')

Clears all Trailguide keys from localStorage (any key starting with trailguide:).

tourStorage.resetAll()

All keys use the prefix trailguide::

Key	Purpose
`trailguide:completed:{id}`	Completion flag (`'true'`)
`trailguide:progress:{id}`	Step index (stringified number)

When using useTrailManager, the id is the storageKey option (default: trailguide:managed:{trail.id}).

tourStorage safely no-ops on the server. All reads return null / false and all writes are ignored when window is not available.