Getting Started
Installation
Install @tour-kit/core and @tour-kit/react with npm, pnpm, yarn, or bun and configure peer dependencies for React 18+
domidex01Published
Quick Install
pnpm add @tour-kit/reactnpm install @tour-kit/reactyarn add @tour-kit/reactbun add @tour-kit/reactPackage Options
| Package | Use Case |
|---|---|
@tour-kit/react | Pre-styled components (recommended) |
@tour-kit/core | Headless hooks only |
@tour-kit/hints | Persistent hints system |
Peer Dependencies
userTourKit requires React 18 or 19:
{
"peerDependencies": {
"react": "^18.0.0 || ^19.0.0",
"react-dom": "^18.0.0 || ^19.0.0"
}
}If using Tailwind CSS, userTourKit components are pre-styled and ready to use.
Related
- Quick start — build your first tour in 5 minutes.
- TypeScript guide — strict-mode types, typed step IDs, generic step data.
@tour-kit/reactoverview — components, hooks, and provider you'll wire next.- Coming from another library? Migrate from react-joyride, shepherd.js, or driver.js.
Ship onboarding, not config.
npm i @tour-kit/core is MIT and free. The Pro packages work unlicensed too — a one-time $99 license removes the production watermark when you ship.
MIT-licensed — no signup, no credit card. Pay once, only when you ship.