react-interactive-tutorial v1.0.14

react-interactive-tutorial

This is a React library to use a very customizable Interactive Tutorial Tool

Installation:

npm install react-interactive-tutorial

or

yarn add react-interactive-tutorial

Usage :

import {
  Highlighted,
  Tutorial,
  TutorialProvider,
  TutorialStep,
  useTutorial
} from 'react-interactive-tutorial';

function App() {
  const steps: TutorialStep[] = [
    {
      id: "_welcome", // "_" indicates no floating element related
      render({ next }) {
        return (
          <>
            <Tutorial
              onClick={next}
              position={{
                left: "50%", // centering element
                top: "50%",
              }}
              style={{
                transform: "translate(-50%, -50%)", // centering element
              }}
            >
              <button onClick={next}>Start!!!</button>
            </Tutorial>
          </>
        );
      },
    },
    {
      id: '#first', // "#" indicates id
      render({ next, finish }) {
        return (
          <>
            <Tutorial position={'left'} onClick={next}>
              <button onClick={next}>Next</button>
              <button onClick={finish}>Finish</button>
            </Tutorial>
            <Highlighted style={{ marginLeft: '0.5em', marginTop: '0.5em' }} />
          </>
        );
      }
    },
    {
      id: '#second',
      render({ next, back }) {
        return (
          <>
            <Tutorial position={'right'} onClick={next}>
              <button onClick={next}>Next</button>
              <button onClick={back}>Back</button>
            </Tutorial>
            <Highlighted />
          </>
        );
      }
    },
    {
      id: '#third',
      render({ next, goTo }) {
        return (
          <>
            <Tutorial position={'right'} onClick={next}>
              <button onClick={next}>Next</button>
              <button onClick={goTo('#first')}>Go to first</button>
            </Tutorial>
            <Highlighted />
          </>
        );
      }
    }
  ];

  return (
    <TutorialProvider steps={steps}>
      <Main />
    </TutorialProvider>
  );
}

function Main() {
  const { start } = useTutorial();
  return (
    <>
      <h1 id='first'>Title</h1>
      <h2 id='second'>Subtitle</h2>
      <section id='third'>Content</section>
      <button onClick={start}>Start tutorial</button>
    </>
  );
}