TourKit
@tour-kit/core

@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.

@tour-kit/core

The core package contains all the headless logic for TourKit.

Installation

pnpm add @tour-kit/core

Overview

This package provides:

  • Providers - TourProvider, TourKitProvider
  • Hooks - useTour, useStep, useSpotlight, etc.
  • Utilities - createTour, createStep, scroll helpers
  • Types - Full TypeScript definitions

TypeScript

Configure TypeScript strict mode, use inferred step types, and leverage generic tour configurations in User Tour Kit

TourProvider

TourProvider: context provider that manages state, steps, and lifecycle for an individual product tour instance

On this page

@tour-kit/coreInstallationOverview