Skip to content
Back to search

react-joyride

Create guided tours in your apps

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/gilbarbara--react-joyride/badge.svg)](/listings/gilbarbara--react-joyride)

HTML

<a href="/listings/gilbarbara--react-joyride"><img src="/api/listings/gilbarbara--react-joyride/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

npm i react-joyride

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 93 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # React Joyride
  2. [![](https://badge.fury.io/js/react-joyride.svg)](https://www.npmjs.com/package/react-joyride) [![CI](https://github.com/gilbarbara/react-joyride/actions/workflows/ci.yml/badge.svg)](https://github.com/gilbarbara/react-joyride/actions/workflows/ci.yml) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=gilbarbara_react-joyride&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=gilbarbara_react-joyride) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=gilbarbara_react-joyride&metric=coverage)](https://sonarcloud.io/summary/new_code?id=gilbarbara_react-joyride)
  3. #### Create awesome tours for your app!
  4. Showcase your app to new users or explain the functionality of new features.
  5. [![Joyride example image](https://react-joyride.com/images/react-joyride-v3.gif)](https://react-joyride.com/)
  6. ### Highlights
  7. - 🎨 **Easy to use:** Just set the `steps` and you're good to go
  8. - 🔧 **Customizable:** Use your own components and styles
  9. - ♿ **Accessible:** Focus trapping, keyboard navigation, and ARIA support
  10. - 📦 **Lightweight:** ~30% smaller bundle than v2
  11. - 🔄 **Broad compatibility:** React 16.8+ through React 19
  12. - 🖥️ **SSR-safe:** Works with Next.js, Remix, and other server-rendering frameworks
  13. ### Resources
  14. - [Documentation](https://react-joyride.com/docs/getting-started)
  15. - [Demos](https://react-joyride.com/demos)
  16. - [What's new in v3](https://react-joyride.com/docs/new-in-v3)
  17. - [StackBlitz Playground](https://stackblitz.com/edit/react-joyride)
  18. ## Setup
  19. ```bash
  20. npm i react-joyride
  21. ```
  22. ## Quick Start
  23. ### Component API
  24. ```tsx
  25. import { Joyride } from 'react-joyride';
  26. const steps = [
  27. { target: '.my-first-step', content: 'This is my awesome feature!' },
  28. { target: '.my-other-step', content: 'This is another awesome feature!' },
  29. ];
  30. export function App() {
  31. return (
  32. <div>
  33. <Joyride run steps={steps} />
  34. {/* your app */}
  35. </div>
  36. );
  37. }
  38. ```
  39. ### Hook API
  40. ```tsx
  41. import { useJoyride } from 'react-joyride';
  42. const steps = [
  43. { target: '.my-first-step', content: 'This is my awesome feature!' },
  44. { target: '.my-other-step', content: 'This is another awesome feature!' },
  45. ];
  46. export function App() {
  47. const { controls, state, Tour } = useJoyride({ steps });
  48. return (
  49. <div>
  50. <button onClick={() => controls.start()}>Start Tour</button>
  51. {Tour}
  52. {/* your app */}
  53. </div>
  54. );
  55. }
  56. ```
  57. ## Agent Skill
  58. Enable AI assistants to implement guided tours with React Joyride.
  59. The skill gives your AI assistant comprehensive knowledge of the API, step configuration, events, custom components, and common patterns.
  60. ```bash
  61. npx skills add gilbarbara/react-joyride
  62. ```
  63. ## Migration from v2
  64. Check the [migration guide](https://react-joyride.com/docs/migration) for detailed instructions on upgrading from v2.
  65. ## License
  66. MIT

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.