Skip to content

How to use TutorialKit API

TutorialKit’s API can be used in custom components to provide highly custom experience in the tutorials. Below are listed few examples to solve real-world use cases. See TutorialKit API for API documentation.

Access tutorial state

In this example we’ll read contents of index.js using Tutorial Store APIs.

When user clicks Help button, we check the contents of index.js and provide them hints about next steps.

Open in StackBlitz
src/components/HelpButton.tsx
import tutorialStore from "tutorialkit:store";
import { Dialog } from "@tutorialkit/react";
import { useState } from "react";