@gfazioli/mantine-onboarding-tour

中文文档
4.1.7发布于 2026/11/09MITTypeScriptESM + CJS零依赖近 30 天下载 2.2万

A Mantine 9 onboarding tour component with focus-reveal overlays, cutout highlights, step-by-step popover navigation, and compound components for guided user experiences.

原始使用文档
文档目录4 节
  1. Overview
  2. Installation
  3. Usage
  4. Sponsor

Mantine Onboarding Tour Component

Mantine Onboarding Tour

mantine-onboarding-tour at a glance, refreshed daily: commits, releases, stars, issues and pull requests, a year of commit activity, the weekly rhythm, languages, latest commits and releases, contributors
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

→ Full page Demo

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

版本与发布记录

@gfazioli/mantine-onboarding-tour 共发布 63 个版本,首次发布于 2025/02/28;过去 12 个月发布了 35 个版本。

版本发布日期距今
4.1.7latest2026/11/096 天前
4.1.62026/11/069 天前
4.1.52026/11/069 天前
4.1.42026/10/2621 天前
4.1.32026/10/2224 天前
4.1.22026/10/131 个月前

关于 @gfazioli/mantine-onboarding-tour 的常见问题

@gfazioli/mantine-onboarding-tour 是什么?

A Mantine 9 onboarding tour component with focus-reveal overlays, cutout highlights, step-by-step popover navigation, and compound components for guided user experiences.

如何安装 @gfazioli/mantine-onboarding-tour?

在项目目录运行 npm install @gfazioli/mantine-onboarding-tour,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^18.x || ^19.x)、react-dom(^18.x || ^19.x)、@mantine/core(>=9.0.0)、@mantine/hooks(>=9.0.0)、@tabler/icons-react(^3.30.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@gfazioli/mantine-onboarding-tour 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@gfazioli/mantine-onboarding-tour 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@gfazioli/mantine-onboarding-tour 可以商用吗?

@gfazioli/mantine-onboarding-tour 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@gfazioli/mantine-onboarding-tour 的下载量有多少?

根据 npm 官方下载统计,@gfazioli/mantine-onboarding-tour 在 2026/10/17 – 2026/11/15 这 30 天内被下载 22,476 次,日均约 749 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@gfazioli/mantine-onboarding-tour 还在维护吗?

最新版本 4.1.7 发布于 2026/11/09(6 天前);至今共发布 63 个版本,其中过去 12 个月发布了 35 个;首次发布于 2025/02/28。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。