Showcase your app to new users or explain the functionality of new features.
- 🎨 Easy to use: Just set the
stepsand 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
npm i react-joyride
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>
);
}
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>
);
}
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.
npx skills add gilbarbara/react-joyride
Check the migration guide for detailed instructions on upgrading from v2.
MIT
关于
Create guided tours in your apps
最后更新于 1 days ago
License
