Skip to content
awesome-tour

Type to search every page.

    OverviewContents

    Overview

    Copy-paste, Tailwind-styled tour components built on the awesome-tour primitives, distributed as a shadcn/ui registry.

    The primitives ship no CSS. When you’d rather start from something good-looking, the awesome-tour registry gives you styled components in the shadcn/ui style — Tailwind v4, CSS variables, cva variants. The code is copied into your project, so you own it: change any class, any markup, any default.

    Every demo in these docs is built with these exact files.

    Setup

    1. Set up shadcn/ui (Tailwind v4) if you haven’t.

    2. Register the @awesome-tour namespace in components.json:

      components.json
      {
      "$schema": "https://ui.shadcn.com/schema.json",
      "registries": {
      "@awesome-tour": "https://yorigcs.github.io/awesome-tour/r/{name}.json"
      }
      }
    3. Add components:

      Terminal window
      pnpm dlx shadcn@latest add @awesome-tour/tour
      Terminal window
      npx shadcn@latest add @awesome-tour/tour

      The CLI installs @awesome-tour/react, the shadcn components it builds on (button) and writes components/awesome-tour/tour.tsx.

    Components

    Theming

    The components use the standard shadcn tokens (--popover, --primary, --muted, …), so they pick up your theme automatically. The tour item also adds:

    Token Meaning
    --tour-overlay-color Fill of the overlay around the cutout (light and dark values).

    and a base rule putting the positioned card ([data-tour-content-wrapper]) above your app chrome.