How do I install User Tour Kit?

Run pnpm add @tour-kit/core @tour-kit/react to install both packages. You can also use npm, yarn, or bun as your package manager.

Does User Tour Kit work with Next.js?

Yes, User Tour Kit works with Next.js App Router and Pages Router. Wrap your layout with TourProvider and use the Next.js App Router adapter for multi-page tours.

What are User Tour Kit's peer dependencies?

User Tour Kit requires React 18+ and React DOM 18+ as peer dependencies. TypeScript 4.7+ is recommended but not required.

Which User Tour Kit packages should I install?

@tour-kit/react is the main package for most projects. It includes @tour-kit/core automatically. Add @tour-kit/hints for feature discovery beacons.

Install @tour-kit/core and @tour-kit/react with npm, pnpm, yarn, or bun and configure peer dependencies for React 18+

Installation

Quick Install

pnpm add @tour-kit/react

npm install @tour-kit/react

yarn add @tour-kit/react

bun add @tour-kit/react

Package 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

TourKit 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, TourKit components are pre-styled and ready to use.

Installation

Installation

Quick Install

Package Options

Peer Dependencies

On this page