README.md

React Tutorial Overlay

A headless library that makes it easy to put tutorials on top of the screen.

(This is an open source library that is still under development.)

Features

• ✨ step-by-step tutorial overlay
• 🎨 easily customizable
• 🤝 Pomise API (Coming Soon)
• 🚀 Lightweight (Coming Soon)
• 👻 Headless (Coming Soon)

Get Started

install with npm

npm install react-tutorial-overlay

install with yarn

yarn add react-tutorial-overlay

import { TutorialOverlay, tutorial } from "../src";

const App = () => {
  const handleClick = () => {
    tutorial.open([
      {
        targetIds: ["target1"],
        title: "title",
        content: "content",
      },
    ]);
  };

  return (
    <div>
      <button onClick={handleClick}>open</button>
      <TutorialOverlay />
    </div>
  );
};

Documentation

• Document

Contributing

@sjsjsj1246