gilbarbara/react-joyride
React Joyride
react-joyride is a user onboarding library for React applications used to create interactive guided tours and walkthroughs. It provides a framework for defining sequences of tooltips and beacons that highlight specific user interface elements to introduce users to application features.
The library distinguishes itself through a programmatic controller that allows developers to manage tour state, navigation, and lifecycle events via external application logic. It supports a high degree of visual extensibility, allowing the replacement of default tooltips and beacons with custom components to match specific design systems.
The system covers broad capabilities including accessibility with focus traps and ARIA attributes, the ability to coordinate tours across different application routes, and the execution of asynchronous logic between steps. It also includes a positioning engine for anchoring elements, SVG-based spotlight masking, and portal-based rendering to prevent UI clipping.
Features
- Interactive Walkthroughs - Provides a framework for building interactive, multi-step guided walkthroughs using tooltips and beacons.
- Guided Tour Components - Provides interactive overlays and beacons to guide users through a web application's features.
- Product Tour Libraries - Provides a comprehensive library for building interactive, multi-step product walkthroughs for React applications.
- Onboarding and Walkthroughs - Ships a library for building multi-step interactive walkthroughs to onboard new users.
- Accessible Walkthroughs - Ensures guided tours are accessible via keyboard navigation and screen reader support.
- Lifecycle Event Hooks - Provides lifecycle hooks to execute asynchronous logic during transition points between tour steps.
- Element Positioning - Provides utilities to configure the placement and behavior of tooltips relative to anchor elements.
- Floating Element Positioning - Ships a positioning engine to calculate coordinate offsets for tooltips relative to target elements.
- Focus Traps - Implements focus traps to constrain keyboard navigation within active tour tooltips for accessibility.
- Positioning Engines - Ships a positioning engine that calculates precise screen coordinates to anchor tooltips relative to target UI elements.
- Navigation Controllers - Provides programmatic interfaces to start, stop, or jump between tour steps using external logic.
- Programmatic Triggers - Offers programmatic methods to start, stop, or transition between tour steps via external scripts and hooks.
- Tour Step Orchestrators - Ships an orchestrator to manage the sequential progression and flow of guided product tours.
- Tour Lifecycle Events - Listen for specific lifecycle events to trigger custom logic or synchronize external UI elements.
- Element Anchoring - Binds tour overlays to specific DOM elements using CSS selectors and dynamic targeting functions.
- Tour Step - Execute asynchronous tasks before or after steps to synchronize the walkthrough state with application logic.
- Customizable Onboarding Components - Allows developers to replace default tooltips and beacons with custom components to match a specific design system.
- Tour State Management - Tracks the current step index and rendering phase to react to real-time user walkthrough progress.
- Hidden Element Interactions - Provides capabilities to target and highlight UI components that are initially off-screen or hidden within scrolling containers.
- Accessibility Labeling Systems - Uses ARIA roles and semantic labels to ensure tour elements are correctly announced by screen readers.
- Accessibility Technologies - Integrates accessibility technologies including focus traps and keyboard navigation for screen reader users.
- Component Replacements - Enables swapping standard arrows, beacons, and tooltips with custom React components.
- Accessible Tour Components - Provides accessible guided tours with focus traps and ARIA attributes to ensure usability for screen reader users.
- State Management Patterns - Implements architectural patterns to synchronize tour progression between internal library state and external application props.
- Tour Component Extensions - Enables the replacement of default beacons and tooltips with custom React components to match a design system.
- Custom Onboarding Components - Allows replacing default tooltips and loaders with custom components rendered via portals.
- Multi-Element Highlighting - Highlights specific UI components using a spotlight mask to direct user attention.
- Modal Overlays - Uses modal overlays to block background user interaction while a specific tour step is active.
- Cross-Route Tour Persistence - Maintains progress and state while the user moves between different pages or application routes.
- Onboarding Progress Tracking - Monitors the current status and lifecycle phase to synchronize walkthrough progress with application state.
- Portal Rendering - Renders tooltips and overlays via portals to bypass parent container clipping and z-index constraints.
- Tour State Monitoring - Provides callbacks during target lookup and step completion to keep application behavior in sync with the tour.
- Conditional Step Execution - Triggers conditional UI changes and step execution based on the presence of target elements.
- Asynchronous Step Logic - Supports running asynchronous tasks before or after tour steps with integrated loading indicators.
- Cross-Route Tour Coordination - Synchronizes tour steps with application state to guide users through complex, multi-page workflows.
- Interaction Overlays - Prevent user input across the application using a full-screen overlay while a specific tour step is active.
- Multi-Page Tour Coordination - Synchronizes progress across multiple route changes to guide users through complex multi-page workflows.
- Tour Event Hooks - Executes custom logic when specific milestones occur, such as starting a tour or failing to find a target element.
- Spotlight Masking - Creates visual highlights using full-screen SVG paths with cutouts centered on target elements.
- Tour Style Customizers - Allows customization of tour styles and the replacement of default components to match application branding.
- User Interaction Patterns - Defines how the tour responds to user inputs such as clicking the overlay or pressing the escape key.
- Event Listeners - Provides mechanisms to listen for and respond to application-level tour lifecycle events.
- Miscellaneous Tools - Guided tour and walkthrough component.
