Save to localStorage
Control how and when tour progress is persisted with the save-to-local-storage prop.
Save to localStorage
The save-to-local-storage prop controls when (if ever) tour progress is written to localStorage. Try each mode, then refresh the page to see the difference.
Three storage modes — pick one, run the tour, then refresh the page to see the difference.
never
Tour always shows — nothing is saved to localStorage.
Not started
step
Progress is saved after each step. Refresh mid-tour and it resumes.
Not started
end
Saved only when the tour finishes. Default behaviour.
Not started
Storage modes
never
Nothing is saved — the tour always shows on every visit. Useful for demos and development.
step
Progress is saved after each step. Close the browser mid-tour and it resumes where you left off.
end
Default
defaultSaved only when the tour finishes. This is the default behaviour.
TTL — re-show after N days
<!-- Show again after 30 days -->
<VTour :ttl="30" :steps="steps" />
Version-based global reset
Bump storageVersion in your nuxt.config to force all users to see the tour again, regardless of their saved state:
nuxt.config.ts
export default defineNuxtConfig({
tour: { storageVersion: "v2" },
});
Storage schema
Each tour is stored as a JSON object under the key
{storagePrefix}-{name} (e.g. nt-onboarding). Old boolean values from v0 are migrated automatically on first read.