TourProvider

API reference and demos for TourProvider.

Source

Import

import { TourProvider } from "@flanksource/clicky-ui/components";

Demos

No dedicated Storybook demo is available for this component yet.

The props table documents the component-specific surface. Standard DOM attributes inherited from React, such as className, event handlers, and accessibility attributes, may also be accepted when the component’s prop type extends a native element.

Props

Prop	Type	Default	Description
currentRoute	string	—	The app's current route. Used only for auto-start eligibility, never for step sequencing.
defaults	Pick<TourProps, "anchorRoot" | "portalContainer" | "missingAnchor" | "anchorTimeoutMs" | "navigateTimeoutMs" | "padding" | "interaction" | "keyboard" | "closeOnEsc" | "scrollIntoView" | "labels" | "onStepError" | "backdropClassName">	—	Defaults shared by every tour; an explicit `<Tour>` prop still wins.
matchRoute	(…) => …	—	Auto-start route matcher. Defaults to exact match with the trailing slash normalised.
onFinish	(…) => …	—	Fired when a tour ends, either way.
onNavigate	(…) => …	—	Navigation callback threaded into every tour. Required for multi-route tours.
storage	TourStorage	—	Completion persistence. Defaults to `localStorageTourStorage()`.
tours*	TourDefinition[]	—	Tours available to `start(id)`. Each is validated on registration.