Mantine Onboarding Tour Component
Made with glancecard · refreshed daily
Overview
This component is created on top of the Mantine library. It requires Mantine 9.x and React 19.
Mantine OnboardingTour is a flexible onboarding system for React apps built on Mantine. You declare an array of steps (OnboardingTourStep) where header, title, content, and footer can be strings, React nodes, or functions that receive the tour controller for dynamic rendering. Each step can customize focus and reveal behavior via FocusReveal props, including overlay, scroll-into-view, transitions, and popover configuration. Targets can be matched with data-onboarding-tour-id or wrapped using OnboardingTour.Target when elements live outside the tour’s children. A controller exposes current step state and actions (start, next, prev, end), while advanced hooks let you swap popover content, implement custom steppers, and tailor overlays or scroll containers for complex layouts, making product tours both accessible and highly customizable.
The tour can be driven from the keyboard (arrow keys to move between steps, Escape to leave), each step popover is a dialog named by its title that receives the focus, the focus returns where it was when the tour ends, and a step whose id matches no element is shown as a centered welcome or closing dialog.
[!note]
→ Demo and Documentation → Youtube Video → More Mantine Components
Installation
npm install @gfazioli/mantine-onboarding-tour
or
yarn add @gfazioli/mantine-onboarding-tour
After installation import package styles at the root of your application:
import '@gfazioli/mantine-onboarding-tour/styles.css';
Usage
import { OnboardingTour, type OnboardingTourStep } from '@gfazioli/mantine-onboarding-tour';
function Demo() {
const onboardingSteps: OnboardingTourStep[] = [
{
id: 'welcome',
title: 'Welcome to the Onboarding Tour Component',
content:
'This is a demo of the Onboarding Tour component, which allows to create onboarding experiences for your users.',
},
{
id: 'my-button',
title: 'Features',
content: 'You can select any component by using the `data-onboarding-tour-id` attribute',
},
];
return (
<OnboardingTour tour={onboardingSteps} started={started}>
<Title data-onboarding-tour-id="welcome" order={4}>
A simple example of the Onboarding Tour component
</Title>
<Button data-onboarding-tour-id="my-button">See all testimonials</Button>
</OnboardingTour>
);
}
Sponsor
Your support helps me:
- Keep the project actively maintained with timely bug fixes and security updates
- Add new features, improve performance, and refine the developer experience
- Expand test coverage and documentation for smoother adoption
- Ensure long‑term sustainability without relying on ad hoc free time
- Prioritize community requests and roadmap items that matter most
Open source thrives when those who benefit can give back—even a small monthly contribution makes a real difference. Sponsorships help cover maintenance time, infrastructure, and the countless invisible tasks that keep a project healthy.
Your help truly matters.
💚 Become a sponsor today and help me keep this project reliable, up‑to‑date, and growing for everyone.
https://github.com/user-attachments/assets/93d39052-90be-45d7-a470-67f8727bc096