Back to search
react-joyride
SkillGitHub
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
Markdown
[](/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)
- # React Joyride
- [](https://www.npmjs.com/package/react-joyride) [](https://github.com/gilbarbara/react-joyride/actions/workflows/ci.yml) [](https://sonarcloud.io/summary/new_code?id=gilbarbara_react-joyride) [](https://sonarcloud.io/summary/new_code?id=gilbarbara_react-joyride)
- #### Create awesome tours for your app!
- Showcase your app to new users or explain the functionality of new features.
- [](https://react-joyride.com/)
- ### Highlights
- - 🎨 **Easy to use:** Just set the `steps` and you're good to go
- - 🔧 **Customizable:** Use your own components and styles
- - ♿ **Accessible:** Focus trapping, keyboard navigation, and ARIA support
- - 📦 **Lightweight:** ~30% smaller bundle than v2
- - 🔄 **Broad compatibility:** React 16.8+ through React 19
- - 🖥️ **SSR-safe:** Works with Next.js, Remix, and other server-rendering frameworks
- ### Resources
- - [Documentation](https://react-joyride.com/docs/getting-started)
- - [Demos](https://react-joyride.com/demos)
- - [What's new in v3](https://react-joyride.com/docs/new-in-v3)
- - [StackBlitz Playground](https://stackblitz.com/edit/react-joyride)
- ## Setup
- ```bash
- npm i react-joyride
- ```
- ## Quick Start
- ### Component API
- ```tsx
- import { Joyride } from 'react-joyride';
- const steps = [
- { target: '.my-first-step', content: 'This is my awesome feature!' },
- { target: '.my-other-step', content: 'This is another awesome feature!' },
- ];
- export function App() {
- return (
- <div>
- <Joyride run steps={steps} />
- {/* your app */}
- </div>
- );
- }
- ```
- ### Hook API
- ```tsx
- import { useJoyride } from 'react-joyride';
- const steps = [
- { target: '.my-first-step', content: 'This is my awesome feature!' },
- { target: '.my-other-step', content: 'This is another awesome feature!' },
- ];
- export function App() {
- const { controls, state, Tour } = useJoyride({ steps });
- return (
- <div>
- <button onClick={() => controls.start()}>Start Tour</button>
- {Tour}
- {/* your app */}
- </div>
- );
- }
- ```
- ## Agent Skill
- Enable AI assistants to implement guided tours with React Joyride.
- The skill gives your AI assistant comprehensive knowledge of the API, step configuration, events, custom components, and common patterns.
- ```bash
- npx skills add gilbarbara/react-joyride
- ```
- ## Migration from v2
- Check the [migration guide](https://react-joyride.com/docs/migration) for detailed instructions on upgrading from v2.
- ## License
- MIT
Ratings and comments
Sign in to rate this skill.
Sign inFree to use. If it’s helped, pass it on.