TourKit 0.7.1 / MIT licensed, always

A clear next step.
Right in your product.

Add product tours and helpful hints to the interface you already have. A small JavaScript library, with no runtime dependencies.

Build your first tour →
npm install sitetourkit

TypeScript · ESM · CommonJS · Browser

01 / In the interfaceA real spotlight. Your existing elements.
Your product / Getting startedInteractive example

Your workspace

Make yourself at home.

A few useful things to get you moving.

First tour3 stepsOne short introduction.
Built around your UI

Keep your layout.
Add a little guidance.

A small path forward
  1. 1Choose an elementA button, a chart, a form.
  2. 2Explain the next stepIn your own words.
  3. 3Let the user tryMove on when they do.
Small by design.0 runtime dependencies5 package entry pointsMIT licensedRead the source ↗
02 / The details matter

Focus on one thing.
Keep everything in place.

TourKit handles positioning, focus and the step lifecycle. You decide what deserves attention.

The element stays yours

A spotlight without
the layout surprises.

An SVG cutout draws attention around your target. Your element stays in its original place, including inside transformed containers.

Try the stacking-context example →
01

Room to move

Tooltips flip and shift to fit. Late-loading targets can be awaited before the next step.

02

Keyboard included

Focus management, real buttons, screen reader announcements and reduced motion support.

03

Your stack, your styles

Use it with plain JavaScript or your framework. Adjust the look with CSS custom properties.

04

Steps that respond

Advance on a field change, wait for a successful action, or save progress for the next visit.

04 / A small API

A target.
A few words.
A first tour.

Install sitetourkit, import the styles and describe your steps. Typed options and events help you connect the tour to your application.

Read the API documentation ↗
Already using Intro.js?

The optional migration adapter understands familiar options and data attributes.

import { createTour } from "sitetourkit";
import "sitetourkit/styles.css";

const tour = createTour({
  progress: true,
  steps: [
    {
      title: "Welcome",
      content: "Let's take a quick look around.",
    },
    {
      target: "#preview-metric",
      title: "Your first tour",
      content: "Start with a short introduction.",
      placement: "bottom-start",
    },
  ],
});

await tour.start();
Typed · SSR-safe · Tree-shakeable
05 / Try the edges

A little more
hands-on?

The playground covers hints, async targets, stacked layouts and tours that continue on another page.

Open the playground
Ready when you are

Make the next step clear.

Build your first tour

Open source. MIT licensed. Yours to adapt.