TourKit
Getting Started

Quick Start

Create your first multi-step product tour in under 5 minutes with Tour, TourStep, and useTour hook examples

Quick Start

Install the package

pnpm add @tour-kit/react

Create your first tour

app/page.tsx
'use client';

import { Tour, TourStep, useTour } from '@tour-kit/react';

export default function Page() {
  const { start } = useTour('welcome');

  return (
    <Tour id="welcome">
      <TourStep
        target="#hero"
        title="Welcome!"
        content="This is your first tour step."
        placement="bottom"
      />
      <TourStep
        target="#features"
        title="Features"
        content="Explore our features here."
        placement="right"
      />

      <main>
        <button onClick={() => start()}>Start Tour</button>
        <section id="hero">Hero Section</section>
        <section id="features">Features</section>
      </main>
    </Tour>
  );
}

Run your app

pnpm dev

Click "Start Tour" to see TourKit in action!

Next Steps

On this page