/reactour

Tourist Guide into your React Components

Primary LanguageTypeScriptMIT LicenseMIT

reactour

Tourist Guide and a set of Assistants to travel into your React Components

Packages

This documentation is for the latest release, which uses npm scoped package @reactour. The original reactour is now on branch v1 and its documentation can be found here.

The main package, which uses the other ones to highlight parts of your application from an array of steps.

A customizable Component to highlight certain element or area of the viewport.

A customizable Component to attach to an element or position of the viewport to show content.

A set of helper functions used by the other packages.

The place where all the stuff is visible working, live here.


Sponsored by

Frigade

Reactour is proud to be sponsored by Frigade, a developer tool for building better product onboarding: guided tours, getting started checklists, announcements, and more.


License

MIT © Lionel Tzatzkin