Docs
Every non-router snippet on these pages is mirrored in examples/docs-samples and typechecked in CI, so the docs cannot drift away from the API. Each code block carries a copy button and a one-click handoff to Claude or ChatGPT with the snippet and page context already written.
Install, then a working tour in four steps on either platform.
Adding it to an appWhere each file goes in Next.js, Vite and Expo Router, and where the client boundary falls.
Step referenceEvery TourConfig and TourStep field, gates, and conditional steps.
Provider referenceMounting TourProvider, its props per platform, events, and useTour().
Theme tokens, component slots, and fully headless rendering.
NavigationSteps that cross routes, and createNavAdapter for Next, React Router and Expo.
Interactionblock, passthrough and advance-on-press, and when to reach for each.
React NativePeer dependencies, TourTarget traps, safe areas, and how measurement works.
HintsStandalone dots with popovers, independent of any running tour.
AccessibilityThe keyboard map, the focus trap, screen readers, and what a custom card takes on.
RecipesEleven task-shaped snippets for the situations that actually come up.
Click through your app and get a committable tour file.
CLI referencetourkit init and tourkit record, flag by flag, and what init writes and wires.
Self-healing targetsFingerprints, the scoring rules, and why it refuses to guess.
Ask and be shownA user question becomes a tour of the real interface, with no tourkit service.
Every export from core, react, native, ai and ai/server, with signatures.
Theme referenceEvery token, its type, its default, and the four that differ per platform.
TestingTesting the config with no renderer, the tour in a DOM, and layout in a browser.
TroubleshootingSymptoms, what causes them, and what to change.
MigratingMapping tables from driver.js, react-joyride, copilot and rn-tourguide.