@apollovisionlabs/guide-core 0.3.0 → 0.3.1
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/README.md +9 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,9 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
`guide` is a headless React library for building in-app product tours. `@apollovisionlabs/guide-core` owns the
|
|
4
4
|
state machine, target resolution, routing, persistence and accessibility concerns, and exposes
|
|
5
|
-
them as hooks with no rendering opinion.
|
|
6
|
-
[MUI](https://mui.com) components (a spotlight overlay and a
|
|
7
|
-
|
|
5
|
+
them as hooks with no rendering opinion. Two packages render on top of those hooks out of the box:
|
|
6
|
+
`@apollovisionlabs/guide-mui` with [MUI](https://mui.com) components (a spotlight overlay and a
|
|
7
|
+
popover), and `@apollovisionlabs/guide-unstyled` with the same parts as plain DOM elements and an
|
|
8
|
+
optional stylesheet. You can also render your own UI on top of `@apollovisionlabs/guide-core`
|
|
9
|
+
directly.
|
|
8
10
|
|
|
9
11
|
This repository includes a runnable demo. From the repo root, run `pnpm --filter demo dev` and
|
|
10
12
|
open `http://localhost:5173` to try a three-page tour end to end.
|
|
@@ -476,6 +478,7 @@ settle (`useHotspots().restored`) before drawing any marker.
|
|
|
476
478
|
| --- | --- |
|
|
477
479
|
| React | 19 |
|
|
478
480
|
| MUI (`@apollovisionlabs/guide-mui` only) | 7, 9 |
|
|
481
|
+
| `@apollovisionlabs/guide-unstyled` | no UI toolkit; peers on `react` and `react-dom` only |
|
|
479
482
|
| Rendering | ESM and CommonJS, with `"use client"` for Next's App Router |
|
|
480
483
|
|
|
481
484
|
## Prior art
|
|
@@ -483,8 +486,9 @@ settle (`useHotspots().restored`) before drawing any marker.
|
|
|
483
486
|
The spotlight-and-popover approach is inspired by [driver.js](https://driverjs.com) (MIT), as are
|
|
484
487
|
[react-joyride](https://github.com/gilbarbara/react-joyride) (MIT) and
|
|
485
488
|
[reactour](https://github.com/elrumordelaluz/reactour) (MIT). `guide` differs from all three mainly
|
|
486
|
-
in splitting the state machine (`@apollovisionlabs/guide-core`) from rendering
|
|
487
|
-
|
|
489
|
+
in splitting the state machine (`@apollovisionlabs/guide-core`) from rendering, which ships as two
|
|
490
|
+
packages, `@apollovisionlabs/guide-mui` and `@apollovisionlabs/guide-unstyled`, so the same logic
|
|
491
|
+
renders through a design system or through plain DOM. Contributors must also read the licence discipline in
|
|
488
492
|
`CONTRIBUTING.md` before looking at any other tour library.
|
|
489
493
|
|
|
490
494
|
## Documentation
|