@gfazioli/mantine-onboarding-tour 2.6.5 → 2.6.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CODE_OF_CONDUCT.md +1 -1
- package/README.md +31 -18
- package/package.json +1 -1
package/CODE_OF_CONDUCT.md
CHANGED
|
@@ -60,7 +60,7 @@ representative at an online or offline event.
|
|
|
60
60
|
|
|
61
61
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
62
62
|
reported to the community leaders responsible for enforcement at
|
|
63
|
-
|
|
63
|
+
giovambattista.fazioli@gmail.com.
|
|
64
64
|
All complaints will be reviewed and investigated promptly and fairly.
|
|
65
65
|
|
|
66
66
|
All community leaders are obligated to respect the privacy and security of the
|
package/README.md
CHANGED
|
@@ -9,30 +9,24 @@
|
|
|
9
9
|
[](https://www.npmjs.com/package/@gfazioli/mantine-onboarding-tour)
|
|
10
10
|
|
|
11
11
|
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
[<kbd> <br/> ❤️ If this component has been useful to you or your team, please consider becoming a sponsor <br/> </kbd>](https://github.com/sponsors/gfazioli?o=esc)
|
|
15
|
+
|
|
12
16
|
</div>
|
|
13
17
|
|
|
14
18
|
## Overview
|
|
15
19
|
|
|
16
20
|
This component is created on top of the [Mantine](https://mantine.dev/) library.
|
|
17
21
|
|
|
18
|
-
[
|
|
19
|
-
)](https://mantine.dev/)
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
It allows you to create a onboarding-tour effect with overlays, popovers, and onboarding tours, enhancing element visibility and interactivity.
|
|
22
|
+
[Mantine OnboardingTour](https://gfazioli.github.io/mantine-onboarding-tour/) 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.
|
|
23
23
|
|
|
24
24
|
|
|
25
|
-
[!
|
|
26
|
-
|
|
27
|
-
[
|
|
28
|
-
|
|
29
|
-
[
|
|
30
|
-
)](https://gfazioli.github.io/mantine-onboarding-tour/demo)
|
|
31
|
-
[](https://mantine-extensions.vercel.app/)
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
👉 You can find more components on the [Mantine Extensions Hub](https://mantine-extensions.vercel.app/) library.
|
|
25
|
+
> [!note]
|
|
26
|
+
>
|
|
27
|
+
> → [Demo and Documentation](https://gfazioli.github.io/mantine-onboarding-tour/) → [Youtube Video](https://www.youtube.com/playlist?list=PL85tTROKkZrWyqCcmNCdWajpx05-cTal4) → [More Mantine Components](https://mantine-extensions.vercel.app/)
|
|
28
|
+
>
|
|
29
|
+
> → [Full page Demo](https://gfazioli.github.io/mantine-onboarding-tour/demo)
|
|
36
30
|
|
|
37
31
|
## Installation
|
|
38
32
|
|
|
@@ -84,11 +78,30 @@ function Demo() {
|
|
|
84
78
|
);
|
|
85
79
|
}
|
|
86
80
|
```
|
|
81
|
+
## Sponsor
|
|
87
82
|
|
|
88
83
|
<div align="center">
|
|
89
|
-
|
|
90
|
-
[
|
|
84
|
+
|
|
85
|
+
[<kbd> <br/> ❤️ If this component has been useful to you or your team, please consider becoming a sponsor <br/> </kbd>](https://github.com/sponsors/gfazioli?o=esc)
|
|
91
86
|
|
|
92
87
|
</div>
|
|
93
88
|
|
|
89
|
+
Your support helps me:
|
|
90
|
+
|
|
91
|
+
- Keep the project actively maintained with timely bug fixes and security updates
|
|
92
|
+
- Add new features, improve performance, and refine the developer experience
|
|
93
|
+
- Expand test coverage and documentation for smoother adoption
|
|
94
|
+
- Ensure long‑term sustainability without relying on ad hoc free time
|
|
95
|
+
- Prioritize community requests and roadmap items that matter most
|
|
96
|
+
|
|
97
|
+
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.
|
|
98
|
+
|
|
99
|
+
Your help truly matters.
|
|
100
|
+
|
|
101
|
+
💚 [Become a sponsor](https://github.com/sponsors/gfazioli?o=esc) today and help me keep this project reliable, up‑to‑date, and growing for everyone.
|
|
102
|
+
---
|
|
94
103
|
https://github.com/user-attachments/assets/93d39052-90be-45d7-a470-67f8727bc096
|
|
104
|
+
|
|
105
|
+
---
|
|
106
|
+
[](https://www.star-history.com/#gfazioli/mantine-onboarding-tour&Timeline)
|
|
107
|
+
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gfazioli/mantine-onboarding-tour",
|
|
3
|
-
"version": "2.6.
|
|
3
|
+
"version": "2.6.6",
|
|
4
4
|
"description": "A Mantine component enables you to create a onboarding-tour effect using overlays, popovers, and onboarding tours, which enhances element visibility and interactivity.",
|
|
5
5
|
"homepage": "https://gfazioli.github.io/mantine-onboarding-tour/",
|
|
6
6
|
"packageManager": "yarn@4.0.1",
|