Installation
Install awesome-tour and the optional adapters.
pnpm add @awesome-tour/reactnpm install @awesome-tour/reactyarn add @awesome-tour/reactbun add @awesome-tour/react@awesome-tour/react re-exports everything from @awesome-tour/core, so most apps need a single
import. Requires React 18 or 19.
Optional packages
| Install | When | Peer dependencies |
|---|---|---|
@awesome-tour/motion motion |
Spring-animated overlay and content | motion |
@awesome-tour/router |
Multi-page tours with React Router, Next.js, TanStack | your router |
@awesome-tour/three |
Targets inside a react-three-fiber scene | @react-three/fiber, three |
-D @awesome-tour/devtools |
Inspect and drive tours while developing | — |
@awesome-tour/core |
Using the engine without React | — |
Framework notes
- Next.js App Router / React Server Components: every package is marked
'use client'. Create tours in a client module and renderTour.Rootfrom a client component. - SSR: nothing touches
windowduring render; tours only start in the browser. - No CSS to import. Style the parts yourself — see Styling.
TypeScript
Types ship with every package. Step ids are inferred from your step definitions, so
tour.goTo('typo') is a type error:
const tour = createTour({ id: 'onboarding', steps: [{ id: 'welcome' }, { id: 'nav', target: '#nav' }],});
tour.goTo('nav'); // ✓tour.goTo('nope'); // ✗ Argument of type '"nope"' is not assignable…