Reactour is a React component library designed to create guided tours and interactive walkthroughs within React applications. The project provides developers with tools to highlight specific parts of their application and guide users through features step-by-step, making it particularly useful for product onboarding, feature introductions, and user education scenarios.
The repository is organized as a monorepo containing multiple specialized packages. The core package, @reactour/tour, serves as the main entry point and orchestrates the tour functionality by leveraging the other packages to highlight application sections based on an array of defined steps. The @reactour/mask package provides a customizable component for highlighting specific elements or viewport areas during tours. The @reactour/popover package offers another customizable component that attaches to elements or viewport positions to display tour content and instructions. Supporting these core packages is @reactour/utils, which contains helper functions used across the other packages. The monorepo also includes an apps/web directory that serves as a live demonstration environment, accessible at reactour.dev, where users can see all functionality in action.
The project is written in TypeScript and maintains comprehensive documentation at docs.reactour.dev. The repository covers a broad range of use cases indicated by its topic tags, including getting-started guides, guided tours, product onboarding, step-by-step walkthroughs, and interactive presentations. The classification data shows the project is recognized as a user interface component library focused on guided tours, interactive guides, and user experience enhancement through navigation and tutorial features.
The most frequently used issue labels are enhancement with three occurrences, followed by Feature Request and help wanted, each appearing once. This activity pattern suggests the project is actively maintained with a focus on improvements and feature development.
The project is licensed under the MIT license and is maintained by Lionel Tzatzkin. The combination of specialized packages, comprehensive documentation, live demonstration environment, and active maintenance makes Reactour a complete solution for developers seeking to implement guided tour functionality in their React applications.
