sitetourkit 0.0.0-stage → 0.7.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/CHANGELOG.md +436 -0
- package/LICENSE +21 -0
- package/README.md +323 -2
- package/dist/compat-introjs.cjs +7 -0
- package/dist/compat-introjs.d.cts +118 -0
- package/dist/compat-introjs.d.ts +118 -0
- package/dist/compat-introjs.global.js +7 -0
- package/dist/compat-introjs.js +7 -0
- package/dist/hints.cjs +7 -0
- package/dist/hints.d.cts +131 -0
- package/dist/hints.d.ts +131 -0
- package/dist/hints.global.js +7 -0
- package/dist/hints.js +7 -0
- package/dist/index.cjs +7 -0
- package/dist/index.d.cts +613 -0
- package/dist/index.d.ts +613 -0
- package/dist/index.global.js +7 -0
- package/dist/index.js +7 -0
- package/dist/inject-styles.cjs +680 -0
- package/dist/inject-styles.d.cts +20 -0
- package/dist/inject-styles.d.ts +20 -0
- package/dist/inject-styles.js +680 -0
- package/dist/locales.cjs +7 -0
- package/dist/locales.d.cts +28 -0
- package/dist/locales.d.ts +28 -0
- package/dist/locales.global.js +7 -0
- package/dist/locales.js +7 -0
- package/dist/styles.css +673 -0
- package/dist/types-M-1II5wP.d.cts +257 -0
- package/dist/types-M-1II5wP.d.ts +257 -0
- package/package.json +195 -4
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,436 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
## 0.7.1 — 2026-11-16
|
|
4
|
+
|
|
5
|
+
The npm package is now distributed as **sitetourkit**. Install it with
|
|
6
|
+
`npm install sitetourkit` and use `sitetourkit` in imports, including optional
|
|
7
|
+
entries such as `sitetourkit/hints` and `sitetourkit/styles.css`.
|
|
8
|
+
|
|
9
|
+
- Updated installation examples, npm/CDN links and packed-consumer checks.
|
|
10
|
+
- Synchronized package and lockfile versions for the first npm publication.
|
|
11
|
+
- TourKit APIs, browser globals and the GitHub repository remain unchanged.
|
|
12
|
+
|
|
13
|
+
## 0.7.0 — 2026-07-25
|
|
14
|
+
|
|
15
|
+
This release improves integration with ASP.NET Core applications and SPAs
|
|
16
|
+
that render frequently and manage their own modals, toasts and effect layers.
|
|
17
|
+
|
|
18
|
+
### New
|
|
19
|
+
|
|
20
|
+
- **Body flags for the host** — `tk-tour-active`, `tk-highlight-active` and
|
|
21
|
+
`tk-hints-open` are set on `<body>` while a tour, a standalone `highlight()`
|
|
22
|
+
or a hint popover is on screen, so a page can move its own chrome out of the
|
|
23
|
+
way with plain CSS (`body.tk-tour-active .toasts { z-index: 40 }`). They are
|
|
24
|
+
reference-counted, so overlapping instances do not strip each other's flag.
|
|
25
|
+
Opt out with `hostClasses: false`.
|
|
26
|
+
- **`dataAttribute`** — renames the whole declarative family
|
|
27
|
+
(`createTour({ dataAttribute: "data-tk-step" })`, also honoured by
|
|
28
|
+
`bindTriggers`, whose trigger becomes `[data-tk-step-trigger]`, and by
|
|
29
|
+
`fromDataAttributes(root, { attribute })`). Pages that already use
|
|
30
|
+
`data-tour` for their own anchors no longer have to rename their markup.
|
|
31
|
+
- **`start({ replace: true })`** — waits for any other running tour to tear
|
|
32
|
+
down before mounting, replacing the `await previous.exit(true)` boilerplate
|
|
33
|
+
every consumer was writing to switch tours from a menu.
|
|
34
|
+
- **`getPersistedProgress(key, storage?)`** — reports the step index saved by
|
|
35
|
+
`persistProgress` without reading the storage format by hand, so "continue
|
|
36
|
+
where you left off" can be offered before the tour is built.
|
|
37
|
+
- **`labels` for hints** — `createHints({ labels: ru })` mirrors tours; the new
|
|
38
|
+
optional `Labels.hintDismiss` is translated in all 11 bundled locales, so the
|
|
39
|
+
popover button is no longer an untranslated "Got it".
|
|
40
|
+
- **Scrolling on `open()`** — `hints.open(i, { scroll: true })` (or an
|
|
41
|
+
instance-wide `createHints({ scroll })`) brings an off-screen marker into
|
|
42
|
+
view first. Without it a programmatic open could place the popover entirely
|
|
43
|
+
outside the viewport.
|
|
44
|
+
- **`highlight().move(target, { scroll: false })`** — re-point the spotlight at
|
|
45
|
+
a re-rendered node without moving the viewport.
|
|
46
|
+
|
|
47
|
+
### Fixed
|
|
48
|
+
|
|
49
|
+
- **Esc that the host already handled is ignored** by the tour, `highlight()`
|
|
50
|
+
and hint popovers (`event.defaultPrevented`). A dialog opened on top of an
|
|
51
|
+
interactive step now closes on Esc without also ending the tour. Navigation
|
|
52
|
+
keys are deliberately exempt: apps routinely `preventDefault()` arrows to
|
|
53
|
+
stop the page from scrolling, and treating that as "handled" would break
|
|
54
|
+
tour navigation.
|
|
55
|
+
|
|
56
|
+
### Changed
|
|
57
|
+
|
|
58
|
+
- **No hashed chunk in `dist`.** The ESM entries are self-contained, like the
|
|
59
|
+
CJS and IIFE ones, so vendoring consumers can copy individual files whose
|
|
60
|
+
names are stable across releases. `hints.js` (4.5 KB brotli) and
|
|
61
|
+
`compat-introjs.js` (14.0 KB) actually got smaller; the cost is a few KB of
|
|
62
|
+
duplicated internals when one page loads two entries.
|
|
63
|
+
- Bundle budgets raised for the new options: core 10.5 → 11 KB brotli (actual
|
|
64
|
+
10.66), `index.global.js` 11 → 11.5 KB (10.87).
|
|
65
|
+
|
|
66
|
+
### Documentation
|
|
67
|
+
|
|
68
|
+
- New **Theming** guide: every `--tk-*` variable with its type and default, a
|
|
69
|
+
copy-paste template, and an explicit warning that `--tk-overlay-color` is a
|
|
70
|
+
colour string paired with `--tk-overlay-opacity`, not an RGB triplet. A unit
|
|
71
|
+
test fails if the stylesheet and the table drift apart.
|
|
72
|
+
- New **Vendoring** section (which `dist` files to copy and what each carries)
|
|
73
|
+
and a **layering recipe** for apps with their own modals: keep `--tk-z`
|
|
74
|
+
below them, do not enable `modal: true`, and lower toasts via the body flag.
|
|
75
|
+
- `Highlight.refresh()` now documents what matters in an SPA — it re-resolves
|
|
76
|
+
the selector, so a replaced node is picked up, and it never scrolls.
|
|
77
|
+
|
|
78
|
+
## 0.6.0 — 2026-07-25
|
|
79
|
+
|
|
80
|
+
Release of the v0.5 audit (`docs/tourkit-v0.6-audit.md`): ten defects fixed,
|
|
81
|
+
the remaining roadmap gaps closed, and the test suite taken from 211 to 299
|
|
82
|
+
unit tests (coverage 97.7% statements / 91.4% branches).
|
|
83
|
+
|
|
84
|
+
### Fixed
|
|
85
|
+
|
|
86
|
+
- **The tooltip can no longer leave the viewport.** A floating step taller
|
|
87
|
+
than the screen used to get a negative `y`, putting its title and close
|
|
88
|
+
button out of reach. The centered placement is now clamped on both axes, the
|
|
89
|
+
tooltip has a `max-height` and its content area scrolls.
|
|
90
|
+
- **`bindTriggers` no longer leaks a tour.** The returned unbind function only
|
|
91
|
+
detached the click delegate; the tour it had started kept its keyboard
|
|
92
|
+
listeners, auto-updater and — while a target was missing — a
|
|
93
|
+
`MutationObserver` on `document.body`. Unbinding now tears that tour down.
|
|
94
|
+
- **`requestAnimationFrame` is called through a guarded wrapper.** Observer
|
|
95
|
+
callbacks could fire in environments without rAF (a non-visual jsdom, a
|
|
96
|
+
document being torn down) and throw an uncaught `ReferenceError`.
|
|
97
|
+
- **Hints keep consistent state.** `destroy()` now clears the hint list (the
|
|
98
|
+
`hints` getter used to report phantom entries afterwards), and `add()`
|
|
99
|
+
generates an id that cannot collide with a hint shifted by an earlier
|
|
100
|
+
`remove()` — the collision made dismiss persistence hide the wrong marker.
|
|
101
|
+
- **`injectStyles()` no longer ships a stale version banner.** The embedded
|
|
102
|
+
stylesheet carried `v0.4.0`; the version is now stamped into
|
|
103
|
+
`dist/styles.css` at build time only, so the committed CSS module cannot
|
|
104
|
+
drift.
|
|
105
|
+
- **A throwing callback cannot strand the tour.** Event handlers,
|
|
106
|
+
`onBeforeShow`, `onShown`, `renderStep` and its cleanup are isolated: a
|
|
107
|
+
failure is reported through `console.error` instead of rejecting the
|
|
108
|
+
transition promise and leaving the tour half-rendered.
|
|
109
|
+
- **`bindTriggers()` and `fromDataAttributes()` are SSR-safe**, matching
|
|
110
|
+
`start()` and `highlight()`: they warn and return instead of dereferencing
|
|
111
|
+
`document`.
|
|
112
|
+
- **Only the topmost focus trap steers Tab.** A hint popover opened during a
|
|
113
|
+
tour used to fight the tooltip for focus, since both listened on the
|
|
114
|
+
document.
|
|
115
|
+
- The exit fade (200 ms) matched the CSS transition (180 ms); a duplicate
|
|
116
|
+
`data-tour-step` slot silently overwrote the earlier element; an awaited
|
|
117
|
+
target appearing mid-step was not announced to screen readers.
|
|
118
|
+
|
|
119
|
+
### Changed
|
|
120
|
+
|
|
121
|
+
- `bindTriggers(root)` scans `[data-tour]` **inside `root`** instead of the
|
|
122
|
+
whole document, and its unbind function also destroys the tour it started.
|
|
123
|
+
- `showOnce` stores `{"v":1,"t":<epoch ms>}` instead of `"1"`. Existing `"1"`
|
|
124
|
+
markers are still honoured as permanent opt-outs.
|
|
125
|
+
- Starting a second tour while one is running logs a warning (the behaviour is
|
|
126
|
+
unchanged — two overlays and two focus traps are almost always a bug).
|
|
127
|
+
- An unknown `data-tour-placement` or `data-hint-position` value is reported
|
|
128
|
+
instead of silently falling back.
|
|
129
|
+
- Bundle budgets raised for the new features: core 10 → 10.5 KB brotli
|
|
130
|
+
(actual 10.17), `compat-introjs` 13.5 → 15 KB (14.47).
|
|
131
|
+
|
|
132
|
+
### New
|
|
133
|
+
|
|
134
|
+
- **`root`** — shadow DOM support: string selectors, the `[data-tour]` and
|
|
135
|
+
`[data-hint]` scanners and the focus trap all work inside a given
|
|
136
|
+
`ShadowRoot` or subtree. `createHints` and `highlight` accept it too.
|
|
137
|
+
- **`lockScroll`** — freezes page scrolling for the tour or a single step,
|
|
138
|
+
compensating for the scrollbar so the layout does not jump. The tour's own
|
|
139
|
+
scrolling to targets keeps working.
|
|
140
|
+
- **`showOnce.ttlMs`** — "remind me in 30 days": the opt-out expires and the
|
|
141
|
+
tour runs again.
|
|
142
|
+
- **`sanitize`** — a hook applied to HTML content when `allowHTML` is on
|
|
143
|
+
(`sanitize: (html) => DOMPurify.sanitize(html)`), also available through the
|
|
144
|
+
intro.js adapter, which enables HTML by default.
|
|
145
|
+
- **Headless API** — `TourEngine`, `EngineDelegate`, `resolveTarget`,
|
|
146
|
+
`Emitter` and `isPlacement` are public: drive the state machine with your
|
|
147
|
+
own UI.
|
|
148
|
+
- **Declarative parity** — `data-tour-advance-on`, `data-tour-wait`,
|
|
149
|
+
`data-tour-highlight` and `data-tour-lock-scroll` join the scanner.
|
|
150
|
+
- **Global builds for every entry** — `TourKitHints` and `TourKitIntroJs` join
|
|
151
|
+
`TourKit` and `TourKitLocales`, so a `<script>` page can use hints and the
|
|
152
|
+
migration adapter.
|
|
153
|
+
- **Six more locales**: `it`, `ja`, `pl`, `ptBR`, `tr`, `zhCN`.
|
|
154
|
+
|
|
155
|
+
### Infrastructure
|
|
156
|
+
|
|
157
|
+
- 299 unit tests (34 files); thresholds raised to 95% statements / 88%
|
|
158
|
+
branches / 92% functions. New suites cover the focus trap (including
|
|
159
|
+
Shift+Tab, which had no coverage at all), `Home`/`End`, the
|
|
160
|
+
`ResizeObserver` path, SSR entry points and the whole `introJs.hint()`
|
|
161
|
+
facade.
|
|
162
|
+
- Test isolation: instances created through the shared helpers are destroyed
|
|
163
|
+
after every test, and an uncaught error now fails the test that produced it.
|
|
164
|
+
- Pure-logic suites run in the `node` environment, and the worker pool is
|
|
165
|
+
bounded — the run went from ~234 s to ~86 s and no longer flakes with
|
|
166
|
+
"Timeout calling fetch".
|
|
167
|
+
- `npm publish --provenance` is explicit in the release workflow; `pack-smoke`
|
|
168
|
+
verifies every global build and the stylesheet version banner.
|
|
169
|
+
- Community infrastructure: issue and PR templates, code of conduct,
|
|
170
|
+
Dependabot, CodeQL.
|
|
171
|
+
- The demo is in English and covers the new modal + locked-scroll scenario.
|
|
172
|
+
|
|
173
|
+
## 0.5.0 — 2026-07-22
|
|
174
|
+
|
|
175
|
+
First release aimed at the public npm registry. Entries from this version on
|
|
176
|
+
are written in English.
|
|
177
|
+
|
|
178
|
+
### New
|
|
179
|
+
|
|
180
|
+
- **`waitForTarget`** — first-class support for asynchronously mounted
|
|
181
|
+
targets (SPA views, lazy widgets). A step whose target is missing or still
|
|
182
|
+
hidden floats in the center while the DOM is watched (scoped
|
|
183
|
+
`MutationObserver`, coalesced to one resync per frame); once the target
|
|
184
|
+
appears, the page scrolls to it and the spotlight flows from the center to
|
|
185
|
+
the element. Configurable per tour and per step:
|
|
186
|
+
`waitForTarget: { timeoutMs = 10000, onTimeout: "float" | "skip" } | false`.
|
|
187
|
+
Exiting or changing the step stops the watcher; the transition queue is
|
|
188
|
+
never blocked while waiting.
|
|
189
|
+
- **`advanceOn`** — interactive steps ("click here to continue"):
|
|
190
|
+
`step.advanceOn: true | { event }` advances the tour when the target
|
|
191
|
+
receives the event (default `click`, capture phase). The listener is
|
|
192
|
+
one-shot per render, moves with a re-resolved/awaited target and is warned
|
|
193
|
+
about (and skipped) when `disableInteraction`/`modal` blocks the target.
|
|
194
|
+
- **`highlight(target, options?)`** — standalone spotlight without a tour:
|
|
195
|
+
dims the page, cuts a hole around the target, follows it on
|
|
196
|
+
scroll/resize, dismisses on Esc (`exitOnEsc: false` to keep) and backdrop
|
|
197
|
+
click (`overlay.clickToExit`). Returns `{ move, refresh, destroy,
|
|
198
|
+
isActive }`. No tooltip, no focus management.
|
|
199
|
+
- **`tour.complete()`** — programmatic completion with
|
|
200
|
+
`reason: "finished"` from any step: fires `beforeExit` (cancellable) →
|
|
201
|
+
`complete` → `exit` and marks `showOnce` as seen.
|
|
202
|
+
- **`modal: true`** (opt-in) — the tooltip gets `aria-modal="true"` and every
|
|
203
|
+
sibling of the tour root becomes `inert` while the tour runs (previous
|
|
204
|
+
`inert` attributes are remembered and restored). This is the one deliberate
|
|
205
|
+
exception, besides the temporary scroll-margin, to the "never mutate the
|
|
206
|
+
host DOM" rule. Implies the target is not interactive: it leaves the Tab
|
|
207
|
+
cycle, and `advanceOn` does not fire. Toggleable live via `setOptions`.
|
|
208
|
+
- **`hints.add(input)` / `hints.remove(indexOrId)`** — dynamic hints at
|
|
209
|
+
runtime: `add` renders a marker immediately (respecting a persisted
|
|
210
|
+
dismissal for the same id; auto-renders the instance when needed) and
|
|
211
|
+
returns the new index; `remove` closes the hint's open popover, unmounts
|
|
212
|
+
the marker and re-stamps `data-hint-index`.
|
|
213
|
+
- **`tourkit/inject-styles`** — new entry for CSP and shadow-DOM setups
|
|
214
|
+
(closes the last unimplemented spec item, §7): `injectStyles({ nonce?,
|
|
215
|
+
target? })` uses constructable stylesheets when available (bypasses
|
|
216
|
+
style-src) with a `<style nonce>` fallback, is idempotent per target and
|
|
217
|
+
returns a cleanup. Also exports the raw `css` string. The stylesheet is
|
|
218
|
+
embedded at build time (`scripts/gen-css-module.mjs` →
|
|
219
|
+
`src/styles/css.generated.ts`, verified in CI).
|
|
220
|
+
|
|
221
|
+
### Infrastructure
|
|
222
|
+
|
|
223
|
+
- Size budgets: `index` ≤ 10 KB brotli (actual 8.97 — now includes
|
|
224
|
+
`highlight`), `compat-introjs` ≤ 13.5 KB (shared chunk grew with the
|
|
225
|
+
renderer features), new `inject-styles` ≤ 4.5 KB.
|
|
226
|
+
- Demo: new scenarios — async target with `advanceOn`, standalone spotlight;
|
|
227
|
+
e2e coverage for both (68 Playwright tests across three engines).
|
|
228
|
+
|
|
229
|
+
## 0.4.1 — 2026-07-22
|
|
230
|
+
|
|
231
|
+
Patch following the v0.4.0 audit.
|
|
232
|
+
|
|
233
|
+
### Fixed
|
|
234
|
+
|
|
235
|
+
- Repeated or rapid trigger clicks force the previous triggered tour to exit
|
|
236
|
+
before starting another. A module-wide active reference prevents overlapping
|
|
237
|
+
overlays and focus traps even when different trigger buttons are used.
|
|
238
|
+
- Fixed-position targets are reachable through the focus trap. Visibility uses
|
|
239
|
+
`checkVisibility()`, with an `offsetParent` fallback that accounts for fixed elements.
|
|
240
|
+
- A target hidden after start is treated as missing, producing a centered step
|
|
241
|
+
rather than a cutout at the origin. Zero-sized guards are skipped and hidden
|
|
242
|
+
hint targets no longer leave a marker at (0, 0).
|
|
243
|
+
- Escape belongs to host editable controls when focus is outside the tour.
|
|
244
|
+
Inside the tour, Escape preserves dialog exit behavior.
|
|
245
|
+
- Tour, hint and compatibility scanners skip `visibility: hidden` elements
|
|
246
|
+
through the shared visibility helper, including hidden ancestors.
|
|
247
|
+
- The exported version is injected from `package.json` during builds and tests;
|
|
248
|
+
unbundled development uses `"0.0.0-dev"`. A test detects version drift.
|
|
249
|
+
|
|
250
|
+
### Accessibility
|
|
251
|
+
|
|
252
|
+
- Windows High Contrast support uses a forced-colors media query: translucent
|
|
253
|
+
dimming, a Highlight-colored spotlight ring, tooltip/popover borders,
|
|
254
|
+
system-colored bullets/progress/hints with explicit borders, and a hidden
|
|
255
|
+
tooltip arrow when its shadow cannot communicate the intended shape.
|
|
256
|
+
|
|
257
|
+
## 0.4.0 — 2026-07-13
|
|
258
|
+
|
|
259
|
+
### Breaking and behavioral changes
|
|
260
|
+
|
|
261
|
+
- Completion now runs `beforeExit` before `complete`: the order is
|
|
262
|
+
`beforeExit` -> `complete` -> `exit`. Cancelling exit leaves the tour active,
|
|
263
|
+
without completion analytics or a `showOnce` marker.
|
|
264
|
+
- `TourEvents` and `HintsEvents` are type aliases without an index signature.
|
|
265
|
+
Misspelled or nonexistent event names now fail type checking.
|
|
266
|
+
- The Intro.js compatibility entry is explicitly a migration adapter:
|
|
267
|
+
HTML is enabled by default there; boundary hiding matches `hidePrev` and
|
|
268
|
+
`hideNext`; closing an intermediate step invokes skip/exit without complete;
|
|
269
|
+
completion distinguishes `done`, `end` and final-step `skip`; repeated start
|
|
270
|
+
replaces the previous tour; `goToStepNumber` finds explicit step numbers.
|
|
271
|
+
- Source maps are excluded from the npm tarball, reducing its historical size
|
|
272
|
+
from about 255 KB to 76 KB. Separate import/require export conditions use
|
|
273
|
+
`.d.ts`/`.d.cts`, resolving package-type validation failures.
|
|
274
|
+
|
|
275
|
+
### Added
|
|
276
|
+
|
|
277
|
+
- `buttons.hideBackOnFirst` and `buttons.hideNextOnLast` hide boundary controls.
|
|
278
|
+
- Active-tour `setOptions()` reapplies theme, z-index, classes, overlay,
|
|
279
|
+
keyboard listeners and normalized steps, then renders the current step.
|
|
280
|
+
- Selector/function targets are resolved again when widgets replace DOM nodes.
|
|
281
|
+
- `disableInteraction` guards all cutouts, including `step.highlight`.
|
|
282
|
+
- Interactive target descendants participate in the tooltip's Tab cycle.
|
|
283
|
+
- Compatibility getters, cloning, opt-out, hint removal and hint callbacks.
|
|
284
|
+
- `dist/locales.global.js` exposes locale dictionaries as `TourKitLocales`.
|
|
285
|
+
|
|
286
|
+
### Fixed
|
|
287
|
+
|
|
288
|
+
- Updated configured steps take priority over previous declarative scans.
|
|
289
|
+
An empty list scans again; a tour with no steps after update/refresh exits
|
|
290
|
+
instead of leaving an empty shell.
|
|
291
|
+
- Storage reads use memory fallback after failed web-storage writes, clear
|
|
292
|
+
stale fallback on successful writes, and isolate local/session/memory maps.
|
|
293
|
+
- Focus context updates when a target is replaced.
|
|
294
|
+
- Highlight-only steps also guard additional cutouts.
|
|
295
|
+
- Showing a dismissed hint restores interactivity and updates persistence.
|
|
296
|
+
Dismissed IDs are merged when several pages share a storage key.
|
|
297
|
+
- `autoUpdate` documentation describes its limits: transform-only or
|
|
298
|
+
unobserved layout changes require explicit `tour.refresh()`.
|
|
299
|
+
|
|
300
|
+
### Infrastructure and documentation
|
|
301
|
+
|
|
302
|
+
- CI covers lint, formatting, types, coverage, build, budgets, package validation,
|
|
303
|
+
packed-consumer smoke tests and Playwright.
|
|
304
|
+
- Browser projects include Chromium, Firefox and WebKit; visual baselines use Chromium.
|
|
305
|
+
- Size checks account for the shared chunk used at this release checkpoint.
|
|
306
|
+
- Build-time CSS banners match the package version and light default theme.
|
|
307
|
+
- Package metadata, community files and provenance wording were added.
|
|
308
|
+
- The MVC guide documents the locale global, IIFE terminology and default
|
|
309
|
+
z-index, which is already above typical Kendo layers.
|
|
310
|
+
|
|
311
|
+
## 0.3.3 — 2026-07-13
|
|
312
|
+
|
|
313
|
+
### Performance
|
|
314
|
+
|
|
315
|
+
- Geometry checks skip unchanged spotlight paths, tooltip styles/classes and
|
|
316
|
+
interaction guards. Unrelated container scrolling no longer forces layout;
|
|
317
|
+
window-scroll layouts fell from 239 to approximately 122 over 120 frames.
|
|
318
|
+
- Direction is read once per rendered step instead of every geometry update.
|
|
319
|
+
- `_sync` batches rectangle, tooltip-size and viewport reads before writes.
|
|
320
|
+
- Scroll/resize/ResizeObserver listeners are installed once per tour;
|
|
321
|
+
step changes update observed targets. Public `autoUpdate` is preserved.
|
|
322
|
+
- Redundant refresh no longer interrupts spotlight movement toward the same geometry.
|
|
323
|
+
|
|
324
|
+
### Benchmark
|
|
325
|
+
|
|
326
|
+
- Added `bench/`, a Playwright/CDP stand for layout/style/script/task metrics,
|
|
327
|
+
start/navigation timing, scrolling, nested tracking and memory.
|
|
328
|
+
- External comparison with Intro.js 8.3.2 recorded approximately half the core
|
|
329
|
+
JavaScript size, one fifth of navigation script time, aligned nested-scroll
|
|
330
|
+
tracking and DOM cleanup near baseline. See
|
|
331
|
+
`docs/tourkit-vs-introjs-benchmark.md` and `docs/tourkit-v0.3.3-perf.md`.
|
|
332
|
+
|
|
333
|
+
## 0.3.2 — 2026-07-13
|
|
334
|
+
|
|
335
|
+
### Changed
|
|
336
|
+
|
|
337
|
+
- The dark theme adds a glowing teal spotlight ring and increases dimming to
|
|
338
|
+
0.68. Variables `--tk-spotlight-ring`, `--tk-spotlight-ring-width`,
|
|
339
|
+
`--tk-spotlight-glow` and `--tk-overlay-opacity` control the effect. The ring
|
|
340
|
+
follows extra cutouts, passes clicks through and disappears on floating steps.
|
|
341
|
+
The light-theme ring remains transparent.
|
|
342
|
+
|
|
343
|
+
## 0.3.1 — 2026-07-12
|
|
344
|
+
|
|
345
|
+
### Changed
|
|
346
|
+
|
|
347
|
+
- Light became the default theme; `theme: "dark"` selects graphite, and
|
|
348
|
+
`theme: "auto"` follows the system. Light-theme muted text `#5d6673` and
|
|
349
|
+
accent `#0f766e` meet the tested 4.5:1 contrast threshold on their backgrounds.
|
|
350
|
+
|
|
351
|
+
### Mobile layout
|
|
352
|
+
|
|
353
|
+
- Tooltip width and minimum width clamp inside the viewport with 8 px margins.
|
|
354
|
+
- The footer wraps rather than squeezing step controls and action buttons.
|
|
355
|
+
- Coarse-pointer controls use larger buttons, a 36 px close target, 22 px hint
|
|
356
|
+
markers, approximately 38 px marker hit areas and extended breadcrumb hit areas.
|
|
357
|
+
- Added touch browser checks at 375 x 667 and 320 x 568.
|
|
358
|
+
- Demo pages use a wrapping sticky header, compact narrow-screen spacing,
|
|
359
|
+
44 px action heights and `touch-action: manipulation`.
|
|
360
|
+
- Demo styling adopts teal accents, a blurred header, SVG card icons,
|
|
361
|
+
stacking-context examples, coordinated themes and reduced-motion handling.
|
|
362
|
+
|
|
363
|
+
## 0.3.0 — 2026-07-12
|
|
364
|
+
|
|
365
|
+
### Added
|
|
366
|
+
|
|
367
|
+
- `renderStep` supplies live custom DOM with cleanup on step change or exit;
|
|
368
|
+
content may be empty when a custom renderer is provided.
|
|
369
|
+
- `step.highlight` adds cutouts alongside the main target. Only the primary
|
|
370
|
+
cutout flows between steps; all targets participate in geometry updates.
|
|
371
|
+
- `persistProgress` stores the index on step change and resumes it on start.
|
|
372
|
+
Completion and explicit exit clear the key; navigation preserves it.
|
|
373
|
+
- `bindTriggers` delegates declarative group launch from `data-tour-trigger`.
|
|
374
|
+
- Optional locale sets: `ru`, `de`, `es`, `fr` and `ar`.
|
|
375
|
+
- `theme: "auto"` follows the system color scheme.
|
|
376
|
+
|
|
377
|
+
### Accessibility
|
|
378
|
+
|
|
379
|
+
- Hint popovers trap focus, focus the action, restore marker focus, and use
|
|
380
|
+
`aria-haspopup`/`aria-controls` while open.
|
|
381
|
+
- Tooltips use `aria-labelledby` when titled and an announcement label
|
|
382
|
+
otherwise. Progress has an accessible label; tested serious axe violations were zero.
|
|
383
|
+
|
|
384
|
+
### Quality and infrastructure
|
|
385
|
+
|
|
386
|
+
- Expanded end-to-end coverage to multiple cutouts, triggers, multi-page
|
|
387
|
+
navigation, tooltip/popover accessibility and five visual snapshots.
|
|
388
|
+
- Added brotli size budgets for core, hints, adapter and locales.
|
|
389
|
+
- Added `prepublishOnly`, packaged changelog and the MVC integration guide.
|
|
390
|
+
|
|
391
|
+
## 0.2.0 — 2026-07-12
|
|
392
|
+
|
|
393
|
+
### Added
|
|
394
|
+
|
|
395
|
+
- `tourkit/hints`: pulsing markers, popovers, a Got it action, nine logical
|
|
396
|
+
anchor positions, declarative attributes, open/dismiss events and stored dismissal.
|
|
397
|
+
- `showOnce`: completion marks a tour seen; an optional opt-out checkbox writes
|
|
398
|
+
immediately. Escape does not mark completion. Storage supports local,
|
|
399
|
+
session and custom adapters with memory fallback.
|
|
400
|
+
- `tourkit/compat-introjs`: legacy factories, option/placement/callback mapping,
|
|
401
|
+
one-based navigation and declarative Intro.js attribute discovery.
|
|
402
|
+
- Logical start/end placement and hint anchors mirror in RTL contexts.
|
|
403
|
+
- Playwright coverage for complete tours, exits, keyboard, scrolling,
|
|
404
|
+
stacking contexts, hint persistence, opt-out and compatibility tours.
|
|
405
|
+
|
|
406
|
+
### Changed
|
|
407
|
+
|
|
408
|
+
- Added hints and compatibility subpath exports in ESM, CJS and declarations.
|
|
409
|
+
- Added `labels.dontShowAgain` and the tooltip opt-out checkbox.
|
|
410
|
+
- Added hint and compatibility examples to the demo.
|
|
411
|
+
|
|
412
|
+
## 0.1.0 — 2026-07-12
|
|
413
|
+
|
|
414
|
+
Initial MVP based on `docs/mit-design.md`.
|
|
415
|
+
|
|
416
|
+
### Features
|
|
417
|
+
|
|
418
|
+
- Queued tour engine with cancellable step/exit guards and completion reasons.
|
|
419
|
+
- SVG spotlight with animated cutouts and no target z-index manipulation.
|
|
420
|
+
- Viewport flip/shift/arrow positioning, cutout anchoring, centered fallback,
|
|
421
|
+
scroll/resize observation and automatic scrolling.
|
|
422
|
+
- Programmatic and declarative steps, ordered slots, groups and rescanning.
|
|
423
|
+
- Keyboard navigation, Tab trapping, focus restoration and live announcements.
|
|
424
|
+
- Plain-text content by default with `allowHTML: false`.
|
|
425
|
+
- Initial dark graphite theme, light alternative and CSS custom properties.
|
|
426
|
+
- Numbered active breadcrumbs and animated segmented progress.
|
|
427
|
+
- ESM/CJS/browser-global builds, declarations, SSR-safe imports and no runtime dependencies.
|
|
428
|
+
|
|
429
|
+
### Stabilization
|
|
430
|
+
|
|
431
|
+
- Removed SVG `viewBox` scaling that displaced cutouts near scrollbars; geometry
|
|
432
|
+
uses layout-viewport pixels. See `docs/tourkit-v0.1.md`, section 7.1.
|
|
433
|
+
- Anchored tooltip placement to the inflated cutout instead of the target box.
|
|
434
|
+
- Applied overlay color/opacity overrides through CSS variables so stylesheet
|
|
435
|
+
rules do not override SVG presentation attributes.
|
|
436
|
+
- Avoided recentering already-visible targets on every step.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 TourKit contributors
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|