Quick Start

Installation

npm

npm install revelio-feature

pnpm

pnpm install revelio-feature

bun

bun add revelio-feature

yarn

yarn add revelio-feature

Usage

Create a new instance of Revelio Feature and pass in your journey configuration.

import { Revelio } from 'revelio-feature';

const revelioTour = new Revelio({
  options: {
    // ... custom global options
  },
  journey: [
    {
      title: 'Welcome to my Amazing App!', // title of the step
      content: 'Click "Next" to get started discovering my app features.', // description of the step
      element: '#welcome-element', // CSS query selector
      options: {
        // ... custom options for this step
      },
    },
    // ... more steps
  ],
});