react-custom-tours
v1.5.3
Published
A library with tips that you can attach to blocks on your sites so that users can more easily understand how to use your site
Downloads
296
Maintainers
Readme
React-custom-tours 👩🏫🆘🔖
🪲 We recommend installing version starting from 1.3.6 (previous versions have problems) 🎉 A library for creating step-by-step hints in your applications (Click to open in npm) 🧪 Tested on projects in production 🔧 Before each update, the library is checked by autotests ⭐ I would be grateful if you put a star on the GitHub repo
Preview GIF 📹:
Custom themes 🌗:
Custom colors 💅:
Installation 🔥:
npm install react-custom-tours
pnpm install react-custom-tours
yarn add react-custom-tours
Features 💫:
- Easy to install in any application (installation time up to 10 minutes);
- Full customization;
- Light/dark mode support out of the box;
- Adaptable to all screen sizes;
- Keyboard control support;
- Animations and smoothness out of the box;
- Can be connected to any components. Also, modal windows with closing on the mousedown event will work, since this event has a stopPropagation listener;
The gist 👩💻:
import React from 'react';
import { TipsProvider, useTips } from 'react-custom-tours/dist/app/main';
function App() {
const { setShow } = useTips(); // you should use this hook inside the provider
// you can start showing tooltips when rendering the component, or add playback conditions
// useEffect(() => {
// setShow(true);
// }, []);
return (
<div>
{/* click this button to start a tour */}
<button onClick={() => setShow(true)}>Show tips!</button>
<div id="tip-block">
<h3>First block with tip!</h3>
</div>
<p id="tip-text">Text with tip!</p>
</div>
);
}
function Main() {
<TipsProvider
tips={[
{
idx: 1, // decent number of tip playback
nodeId: 'tip-block', // block with tip id
title: 'First block tip title!', // tip title (optional key)
text: 'First block tip text!', // tip text
},
{
idx: 2,
nodeId: 'tip-text',
text: 'Text block tip text!',
},
]}
theme="dark" // light is default (optional)
primaryColor="#0dcaf0" // your app primary color (optional)
tooltipBorderColor="#ffc107" // any color of your choice to highlight the block outline (optional)
escapeToClose // adding closing tour using escape keydown (optional)
isHiddenClose={true} // hide the close tour button until the last step (optional, default = false) (added in v1.3.8)
>
<App />
</TipsProvider>;
}