@tour-kit/core
Framework-agnostic hooks and utilities for building product tours — state management, positioning, and accessibility
LLM Context File
Working with an AI assistant? Download the context file for @tour-kit/core and paste it into your conversation for accurate code generation.
Why userTourKit for product tours →
The core package contains all the headless logic for userTourKit. The reasoning behind a logic-first, UI-later split — and why it matters for shadcn/ui, Radix, and Base UI integration — is covered in our headless onboarding architecture guide.
Installation
pnpm add @tour-kit/coreOverview
This package provides:
- Providers - TourProvider, TourKitProvider
- Hooks - useTour, useStep, useSpotlight, and more in hooks index
- Utilities - createTour, createStep, scroll helpers, and more in utilities index
- Types - Full TypeScript definitions in types index
Related
@tour-kit/coreAPI reference — full export surface in one page.@tour-kit/react— pre-styled components built on these primitives.- Diagnostic engine — opt-in eligibility report for tours.
- Schemas reference — validate JSON-authored tours.
- Quick start — see these primitives in a working app.
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.