Repository navigation
Releases
@awesome-tour/three@1.0.0
Major Changes
-
#6
7457d44Thanks @yorigcs! - 1.0: the API is stable and every package follows semver from here on. Breaking changes only in a major, with a codemod or a migration note.Since 0.1: a hardened transition pipeline (rollback,
enterTimeout, no double hooks), targets that survive re-renders, shadow DOM, iframes and dialogs, StrictMode- and SSR-safe React bindings, resilient locators, goals, experiments, frequency caps, deep links, previews, behavior triggers, ordered checklists, per-locale step text, health checks in CI, a devtools funnel and recorder, dev diagnostics (AT001–AT008), and@awesome-tour/elementsfor apps without React. Display rules now tell completed tours from dismissed ones (once: true | 'completed' | 'seen').
Patch Changes
- #6
853ad32Thanks @yorigcs! - -createTourManager({ clock }): the manager's "now" for schedules, cooldowns, snoozes and recorded show times (preview a campaign, test rules).- Logical sides:
side: 'start' | 'end'follow the reading direction (PhysicalSideis exported for the placed side). Tour.Portalalso treats Radix/vaul dialogs (role="dialog"withoutaria-modal) as hosts, so a tour pointing into one stays clickable.- Real READMEs for every package; the docs, playground and examples now run on Loopwork, a beat-maker example app, with new live demos (multi-page, multiple tours, 3D, accessibility, stress lab).
- Logical sides:
- Updated dependencies [
c1c3e3a,c1c3e3a,e31dd87,853ad32,729cdd7,c1c3e3a,7457d44]:- @awesome-tour/core@1.0.0
- @awesome-tour/react@1.0.0
@awesome-tour/testing@1.0.0
Major Changes
-
#6
7457d44Thanks @yorigcs! - 1.0: the API is stable and every package follows semver from here on. Breaking changes only in a major, with a codemod or a migration note.Since 0.1: a hardened transition pipeline (rollback,
enterTimeout, no double hooks), targets that survive re-renders, shadow DOM, iframes and dialogs, StrictMode- and SSR-safe React bindings, resilient locators, goals, experiments, frequency caps, deep links, previews, behavior triggers, ordered checklists, per-locale step text, health checks in CI, a devtools funnel and recorder, dev diagnostics (AT001–AT008), and@awesome-tour/elementsfor apps without React. Display rules now tell completed tours from dismissed ones (once: true | 'completed' | 'seen').
Minor Changes
- #6
729cdd7Thanks @yorigcs! - - Checklists:after(dependencies: locked until done),optionalitems,sections; state gainslocked,nextandsections;Checklist.Itemexposesdata-locked/data-next.- Step text per locale:
title: { en, 'pt-BR' }(also descriptions, content, announcements, surveys and JSON), picked by thelocaleofTourProvider/Tour.Rootor<html lang>;localize,useLocalize. - Previews:
TourProvider preview={{ load }}/previewFromUrlrun a draft from?tour-preview=idwithout saving, tracking or rules (tour.preview,data-preview). - Behavior triggers:
dwell,idle,rageClickandrepeat. - Tour health checks:
auditTours,npx awesome-tour-check <url>,expectToursHealthy(page). - Devtools: a Funnel tab (reach and drop-off per step) and a Recorder (pick elements, play, copy as JSON or code).
- New package
@awesome-tour/elements:mountTour()and an<awesome-tour>custom element, no React needed. - New dev warning AT008 (checklist item after an unknown item).
- Step text per locale:
Patch Changes
@awesome-tour/router@1.0.0
Major Changes
-
#6
7457d44Thanks @yorigcs! - 1.0: the API is stable and every package follows semver from here on. Breaking changes only in a major, with a codemod or a migration note.Since 0.1: a hardened transition pipeline (rollback,
enterTimeout, no double hooks), targets that survive re-renders, shadow DOM, iframes and dialogs, StrictMode- and SSR-safe React bindings, resilient locators, goals, experiments, frequency caps, deep links, previews, behavior triggers, ordered checklists, per-locale step text, health checks in CI, a devtools funnel and recorder, dev diagnostics (AT001–AT008), and@awesome-tour/elementsfor apps without React. Display rules now tell completed tours from dismissed ones (once: true | 'completed' | 'seen').
Patch Changes
- #6
853ad32Thanks @yorigcs! - -createTourManager({ clock }): the manager's "now" for schedules, cooldowns, snoozes and recorded show times (preview a campaign, test rules).- Logical sides:
side: 'start' | 'end'follow the reading direction (PhysicalSideis exported for the placed side). Tour.Portalalso treats Radix/vaul dialogs (role="dialog"withoutaria-modal) as hosts, so a tour pointing into one stays clickable.- Real READMEs for every package; the docs, playground and examples now run on Loopwork, a beat-maker example app, with new live demos (multi-page, multiple tours, 3D, accessibility, stress lab).
- Logical sides:
- Updated dependencies [
c1c3e3a,c1c3e3a,e31dd87,853ad32,729cdd7,c1c3e3a,7457d44]:- @awesome-tour/react@1.0.0
@awesome-tour/react@1.0.0
Major Changes
-
#6
7457d44Thanks @yorigcs! - 1.0: the API is stable and every package follows semver from here on. Breaking changes only in a major, with a codemod or a migration note.Since 0.1: a hardened transition pipeline (rollback,
enterTimeout, no double hooks), targets that survive re-renders, shadow DOM, iframes and dialogs, StrictMode- and SSR-safe React bindings, resilient locators, goals, experiments, frequency caps, deep links, previews, behavior triggers, ordered checklists, per-locale step text, health checks in CI, a devtools funnel and recorder, dev diagnostics (AT001–AT008), and@awesome-tour/elementsfor apps without React. Display rules now tell completed tours from dismissed ones (once: true | 'completed' | 'seen').
Minor Changes
-
#6
c1c3e3aThanks @yorigcs! - New, all opt-in:- Resilient targets:
byTour('name'),byRole('button', { name: 'Export' }),byText('…')andfirstOf(a, b, c)fallback chains (plusaccessibleName,roleOf). Devtools' element picker now suggestsbyTour/byRolewhen an element has a hook or a role and name. - Goals:
createTour({ goal: { signal | event | route | when, within } })emitsgoalonce per run, even after the tour ended; analytics sendstour_goal_reachedwith the time to conversion. - Experiments:
createExperiment({ variants, weights, userId | assign, onExposure })with stable hashing, control groups andexperimentId/varianton analytics events. - Manager-wide frequency cap (
createTourManager({ cap: { perSession, cooldownMs } }), reported as thecaprule) andfrequency.perVersionto show a tour again when its version changes. - Deep links:
deepLink(manager)/<TourProvider deepLink>start the tour named in?tour=id&step=x. createFeed+useFeed: a "what's new" feed with read state, and ahelp-centerregistry item that combines it with the checklist, tours and links.Tour.Content layout="sheet" | "auto": docked to the bottom on small screens (the registry card defaults toauto).
- Resilient targets:
-
#6
c1c3e3aThanks @yorigcs! - Developer experience:- Development warnings with stable codes (AT001–AT007: duplicate step ids, unknown
next/advanceOn.to, invalid selectors, errors nobody listens to, routes without a router, two tours with one id), each explained on the new "Warnings & errors" page. Silent in production builds. createTournow rejects a stringnextthat isn't one of the tour's step ids at compile time.- Tours as JSON: locator objects (
{ tour },{ role, name },{ text },{ firstOf }),goal,onTargetLost,enterTimeout,beforeLeave, scroll options, logical sides and the new frequency options;validateTourJSONchecks enum values and locators. The JSON Schema is updated. - Codemod: joyride's
disableScrollingbecomesscroll, andspotlightPaddingpoints to the overlay'spadding.
- Development warnings with stable codes (AT001–AT007: duplicate step ids, unknown
-
#6
853ad32Thanks @yorigcs! - -createTourManager({ clock }): the manager's "now" for schedules, cooldowns, snoozes and recorded show times (preview a campaign, test rules).- Logical sides:
side: 'start' | 'end'follow the reading direction (PhysicalSideis exported for the placed side). Tour.Portalalso treats Radix/vaul dialogs (role="dialog"withoutaria-modal) as hosts, so a tour pointing into one stays clickable.- Real READMEs for every package; the docs, playground and examples now run on Loopwork, a beat-maker example app, with new live demos (multi-page, multiple tours, 3D, accessibility, stress lab).
- Logical sides:
-
#6
729cdd7Thanks @yorigcs! - - Checklists:after(dependencies: locked until done),optionalitems,sections; state gainslocked,nextandsections;Checklist.Itemexposesdata-locked/data-next.- Step text per locale:
title: { en, 'pt-BR' }(also descriptions, content, announcements, surveys and JSON), picked by thelocaleofTourProvider/Tour.Rootor<html lang>;localize,useLocalize. - Previews:
TourProvider preview={{ load }}/previewFromUrlrun a draft from?tour-preview=idwithout saving, tracking or rules (tour.preview,data-preview). - Behavior triggers:
dwell,idle,rageClickandrepeat. - Tour health checks:
auditTours,npx awesome-tour-check <url>,expectToursHealthy(page). - Devtools: a Funnel tab (reach and drop-off per step) and a Recorder (pick elements, play, copy as JSON or code).
- New package
@awesome-tour/elements:mountTour()and an<awesome-tour>custom element, no React needed. - New dev warning AT008 (checklist item after an unknown item).
- Step text per locale:
-
#6
c1c3e3aThanks @yorigcs! - Engine robustness:- Transitions:
onTargetMissing: 'skip'runs the previous step's leave hooks once; a failing or timed-outbeforeEnter(newenterTimeout) restores the previous step with its listeners; doublenext()/prev()calls are ignored while one resolves;prev()re-checkswhen; plugins'beforeStepreceives an abortsignal;setSteps()removing the current step moves on;destroy()leaves the step and detaches plugins. - Targets removed while their step is shown are detected (
targetLostevent,onTargetLost: 'reresolve' | 'center' | 'close'). One sharedMutationObserverserves every watcher (subscribeDomActivity,getObserverStats). Shadow DOM: matches from every open root,inertOthersand the focus trap pierce roots. iframes: frame targets scroll into view andadvanceOnevents inside the frame are heard.scroll.offsetkeeps targets clear of sticky bars. - New
tour.use(plugin)andmanager.connect();TourProviderand inlineTour.Roottours no longer have side effects during render (StrictMode safe) and inline tours are destroyed on unmount.<Tour.Step>pushes every prop change to the tour. - Persistence:
persistvalidates saved values, reports failures throughonError, never overwrites progress saved by a newer tour version, and pauses the tour in other tabs when it starts in one.httpAdapterchecks responses, retries writes with backoff, flushes withkeepaliveonpagehide(flush()), can poll for changes (pollInterval) and throw on read errors (readErrors). - Rules: impressions record the
outcome;frequency.onceaccepts'completed'and'seen', plusdismissCooldownMs. Queued tours are re-checked when they leave the queue.matchRouteignores query strings and hashes. - React: arrow keys inside sliders, menus, grids and other composite widgets (or
data-tour-keys="ignore") are left alone; only the most recently opened tour handles keys;dirdefaults to the document's;Tour.Portal(strategy: 'auto') renders inside an open modal dialog that holds the target (native<dialog>, Radix, vaul).
- Transitions:
Patch Changes
- #6
e31dd87Thanks @yorigcs! - - Goals survive reloads:persist()saves when a run's goal was armed and reached, and resumes watching it on the next visit (counted once). Newtour.trackGoal(since)to do it yourself.manager.getImpression(id); launcher items and badges fall back to remembered impressions, so a tour finished in an earlier session isn't shown as "new" again.
- Updated dependencies [
c1c3e3a,c1c3e3a,e31dd87,853ad32,729cdd7,c1c3e3a,7457d44]:- @awesome-tour/core@1.0.0
@awesome-tour/motion@1.0.0
Major Changes
-
#6
7457d44Thanks @yorigcs! - 1.0: the API is stable and every package follows semver from here on. Breaking changes only in a major, with a codemod or a migration note.Since 0.1: a hardened transition pipeline (rollback,
enterTimeout, no double hooks), targets that survive re-renders, shadow DOM, iframes and dialogs, StrictMode- and SSR-safe React bindings, resilient locators, goals, experiments, frequency caps, deep links, previews, behavior triggers, ordered checklists, per-locale step text, health checks in CI, a devtools funnel and recorder, dev diagnostics (AT001–AT008), and@awesome-tour/elementsfor apps without React. Display rules now tell completed tours from dismissed ones (once: true | 'completed' | 'seen').
Patch Changes
- #6
853ad32Thanks @yorigcs! - -createTourManager({ clock }): the manager's "now" for schedules, cooldowns, snoozes and recorded show times (preview a campaign, test rules).- Logical sides:
side: 'start' | 'end'follow the reading direction (PhysicalSideis exported for the placed side). Tour.Portalalso treats Radix/vaul dialogs (role="dialog"withoutaria-modal) as hosts, so a tour pointing into one stays clickable.- Real READMEs for every package; the docs, playground and examples now run on Loopwork, a beat-maker example app, with new live demos (multi-page, multiple tours, 3D, accessibility, stress lab).
- Logical sides:
- Updated dependencies [
c1c3e3a,c1c3e3a,e31dd87,853ad32,729cdd7,c1c3e3a,7457d44]:- @awesome-tour/core@1.0.0
- @awesome-tour/react@1.0.0
@awesome-tour/elements@1.0.0
Major Changes
-
#6
7457d44Thanks @yorigcs! - 1.0: the API is stable and every package follows semver from here on. Breaking changes only in a major, with a codemod or a migration note.Since 0.1: a hardened transition pipeline (rollback,
enterTimeout, no double hooks), targets that survive re-renders, shadow DOM, iframes and dialogs, StrictMode- and SSR-safe React bindings, resilient locators, goals, experiments, frequency caps, deep links, previews, behavior triggers, ordered checklists, per-locale step text, health checks in CI, a devtools funnel and recorder, dev diagnostics (AT001–AT008), and@awesome-tour/elementsfor apps without React. Display rules now tell completed tours from dismissed ones (once: true | 'completed' | 'seen').
Minor Changes
- #6
729cdd7Thanks @yorigcs! - - Checklists:after(dependencies: locked until done),optionalitems,sections; state gainslocked,nextandsections;Checklist.Itemexposesdata-locked/data-next.- Step text per locale:
title: { en, 'pt-BR' }(also descriptions, content, announcements, surveys and JSON), picked by thelocaleofTourProvider/Tour.Rootor<html lang>;localize,useLocalize. - Previews:
TourProvider preview={{ load }}/previewFromUrlrun a draft from?tour-preview=idwithout saving, tracking or rules (tour.preview,data-preview). - Behavior triggers:
dwell,idle,rageClickandrepeat. - Tour health checks:
auditTours,npx awesome-tour-check <url>,expectToursHealthy(page). - Devtools: a Funnel tab (reach and drop-off per step) and a Recorder (pick elements, play, copy as JSON or code).
- New package
@awesome-tour/elements:mountTour()and an<awesome-tour>custom element, no React needed. - New dev warning AT008 (checklist item after an unknown item).
- Step text per locale:
Patch Changes
@awesome-tour/devtools@1.0.0
Major Changes
-
#6
7457d44Thanks @yorigcs! - 1.0: the API is stable and every package follows semver from here on. Breaking changes only in a major, with a codemod or a migration note.Since 0.1: a hardened transition pipeline (rollback,
enterTimeout, no double hooks), targets that survive re-renders, shadow DOM, iframes and dialogs, StrictMode- and SSR-safe React bindings, resilient locators, goals, experiments, frequency caps, deep links, previews, behavior triggers, ordered checklists, per-locale step text, health checks in CI, a devtools funnel and recorder, dev diagnostics (AT001–AT008), and@awesome-tour/elementsfor apps without React. Display rules now tell completed tours from dismissed ones (once: true | 'completed' | 'seen').
Minor Changes
-
#6
c1c3e3aThanks @yorigcs! - New, all opt-in:- Resilient targets:
byTour('name'),byRole('button', { name: 'Export' }),byText('…')andfirstOf(a, b, c)fallback chains (plusaccessibleName,roleOf). Devtools' element picker now suggestsbyTour/byRolewhen an element has a hook or a role and name. - Goals:
createTour({ goal: { signal | event | route | when, within } })emitsgoalonce per run, even after the tour ended; analytics sendstour_goal_reachedwith the time to conversion. - Experiments:
createExperiment({ variants, weights, userId | assign, onExposure })with stable hashing, control groups andexperimentId/varianton analytics events. - Manager-wide frequency cap (
createTourManager({ cap: { perSession, cooldownMs } }), reported as thecaprule) andfrequency.perVersionto show a tour again when its version changes. - Deep links:
deepLink(manager)/<TourProvider deepLink>start the tour named in?tour=id&step=x. createFeed+useFeed: a "what's new" feed with read state, and ahelp-centerregistry item that combines it with the checklist, tours and links.Tour.Content layout="sheet" | "auto": docked to the bottom on small screens (the registry card defaults toauto).
- Resilient targets:
-
#6
729cdd7Thanks @yorigcs! - - Checklists:after(dependencies: locked until done),optionalitems,sections; state gainslocked,nextandsections;Checklist.Itemexposesdata-locked/data-next.- Step text per locale:
title: { en, 'pt-BR' }(also descriptions, content, announcements, surveys and JSON), picked by thelocaleofTourProvider/Tour.Rootor<html lang>;localize,useLocalize. - Previews:
TourProvider preview={{ load }}/previewFromUrlrun a draft from?tour-preview=idwithout saving, tracking or rules (tour.preview,data-preview). - Behavior triggers:
dwell,idle,rageClickandrepeat. - Tour health checks:
auditTours,npx awesome-tour-check <url>,expectToursHealthy(page). - Devtools: a Funnel tab (reach and drop-off per step) and a Recorder (pick elements, play, copy as JSON or code).
- New package
@awesome-tour/elements:mountTour()and an<awesome-tour>custom element, no React needed. - New dev warning AT008 (checklist item after an unknown item).
- Step text per locale:
Patch Changes
- #6
853ad32Thanks @yorigcs! - -createTourManager({ clock }): the manager's "now" for schedules, cooldowns, snoozes and recorded show times (preview a campaign, test rules).- Logical sides:
side: 'start' | 'end'follow the reading direction (PhysicalSideis exported for the placed side). Tour.Portalalso treats Radix/vaul dialogs (role="dialog"withoutaria-modal) as hosts, so a tour pointing into one stays clickable.- Real READMEs for every package; the docs, playground and examples now run on Loopwork, a beat-maker example app, with new live demos (multi-page, multiple tours, 3D, accessibility, stress lab).
- Logical sides:
- Updated dependencies [
c1c3e3a,c1c3e3a,e31dd87,853ad32,729cdd7,c1c3e3a,7457d44]:- @awesome-tour/react@1.0.0
@awesome-tour/core@1.0.0
Major Changes
-
#6
7457d44Thanks @yorigcs! - 1.0: the API is stable and every package follows semver from here on. Breaking changes only in a major, with a codemod or a migration note.Since 0.1: a hardened transition pipeline (rollback,
enterTimeout, no double hooks), targets that survive re-renders, shadow DOM, iframes and dialogs, StrictMode- and SSR-safe React bindings, resilient locators, goals, experiments, frequency caps, deep links, previews, behavior triggers, ordered checklists, per-locale step text, health checks in CI, a devtools funnel and recorder, dev diagnostics (AT001–AT008), and@awesome-tour/elementsfor apps without React. Display rules now tell completed tours from dismissed ones (once: true | 'completed' | 'seen').
Minor Changes
-
#6
c1c3e3aThanks @yorigcs! - New, all opt-in:- Resilient targets:
byTour('name'),byRole('button', { name: 'Export' }),byText('…')andfirstOf(a, b, c)fallback chains (plusaccessibleName,roleOf). Devtools' element picker now suggestsbyTour/byRolewhen an element has a hook or a role and name. - Goals:
createTour({ goal: { signal | event | route | when, within } })emitsgoalonce per run, even after the tour ended; analytics sendstour_goal_reachedwith the time to conversion. - Experiments:
createExperiment({ variants, weights, userId | assign, onExposure })with stable hashing, control groups andexperimentId/varianton analytics events. - Manager-wide frequency cap (
createTourManager({ cap: { perSession, cooldownMs } }), reported as thecaprule) andfrequency.perVersionto show a tour again when its version changes. - Deep links:
deepLink(manager)/<TourProvider deepLink>start the tour named in?tour=id&step=x. createFeed+useFeed: a "what's new" feed with read state, and ahelp-centerregistry item that combines it with the checklist, tours and links.Tour.Content layout="sheet" | "auto": docked to the bottom on small screens (the registry card defaults toauto).
- Resilient targets:
-
#6
c1c3e3aThanks @yorigcs! - Developer experience:- Development warnings with stable codes (AT001–AT007: duplicate step ids, unknown
next/advanceOn.to, invalid selectors, errors nobody listens to, routes without a router, two tours with one id), each explained on the new "Warnings & errors" page. Silent in production builds. createTournow rejects a stringnextthat isn't one of the tour's step ids at compile time.- Tours as JSON: locator objects (
{ tour },{ role, name },{ text },{ firstOf }),goal,onTargetLost,enterTimeout,beforeLeave, scroll options, logical sides and the new frequency options;validateTourJSONchecks enum values and locators. The JSON Schema is updated. - Codemod: joyride's
disableScrollingbecomesscroll, andspotlightPaddingpoints to the overlay'spadding.
- Development warnings with stable codes (AT001–AT007: duplicate step ids, unknown
-
#6
e31dd87Thanks @yorigcs! - - Goals survive reloads:persist()saves when a run's goal was armed and reached, and resumes watching it on the next visit (counted once). Newtour.trackGoal(since)to do it yourself.manager.getImpression(id); launcher items and badges fall back to remembered impressions, so a tour finished in an earlier session isn't shown as "new" again.
-
#6
853ad32Thanks @yorigcs! - -createTourManager({ clock }): the manager's "now" for schedules, cooldowns, snoozes and recorded show times (preview a campaign, test rules).- Logical sides:
side: 'start' | 'end'follow the reading direction (PhysicalSideis exported for the placed side). Tour.Portalalso treats Radix/vaul dialogs (role="dialog"withoutaria-modal) as hosts, so a tour pointing into one stays clickable.- Real READMEs for every package; the docs, playground and examples now run on Loopwork, a beat-maker example app, with new live demos (multi-page, multiple tours, 3D, accessibility, stress lab).
- Logical sides:
-
#6
729cdd7Thanks @yorigcs! - - Checklists:after(dependencies: locked until done),optionalitems,sections; state gainslocked,nextandsections;Checklist.Itemexposesdata-locked/data-next.- Step text per locale:
title: { en, 'pt-BR' }(also descriptions, content, announcements, surveys and JSON), picked by thelocaleofTourProvider/Tour.Rootor<html lang>;localize,useLocalize. - Previews:
TourProvider preview={{ load }}/previewFromUrlrun a draft from?tour-preview=idwithout saving, tracking or rules (tour.preview,data-preview). - Behavior triggers:
dwell,idle,rageClickandrepeat. - Tour health checks:
auditTours,npx awesome-tour-check <url>,expectToursHealthy(page). - Devtools: a Funnel tab (reach and drop-off per step) and a Recorder (pick elements, play, copy as JSON or code).
- New package
@awesome-tour/elements:mountTour()and an<awesome-tour>custom element, no React needed. - New dev warning AT008 (checklist item after an unknown item).
- Step text per locale:
-
#6
c1c3e3aThanks @yorigcs! - Engine robustness:- Transitions:
onTargetMissing: 'skip'runs the previous step's leave hooks once; a failing or timed-outbeforeEnter(newenterTimeout) restores the previous step with its listeners; doublenext()/prev()calls are ignored while one resolves;prev()re-checkswhen; plugins'beforeStepreceives an abortsignal;setSteps()removing the current step moves on;destroy()leaves the step and detaches plugins. - Targets removed while their step is shown are detected (
targetLostevent,onTargetLost: 'reresolve' | 'center' | 'close'). One sharedMutationObserverserves every watcher (subscribeDomActivity,getObserverStats). Shadow DOM: matches from every open root,inertOthersand the focus trap pierce roots. iframes: frame targets scroll into view andadvanceOnevents inside the frame are heard.scroll.offsetkeeps targets clear of sticky bars. - New
tour.use(plugin)andmanager.connect();TourProviderand inlineTour.Roottours no longer have side effects during render (StrictMode safe) and inline tours are destroyed on unmount.<Tour.Step>pushes every prop change to the tour. - Persistence:
persistvalidates saved values, reports failures throughonError, never overwrites progress saved by a newer tour version, and pauses the tour in other tabs when it starts in one.httpAdapterchecks responses, retries writes with backoff, flushes withkeepaliveonpagehide(flush()), can poll for changes (pollInterval) and throw on read errors (readErrors). - Rules: impressions record the
outcome;frequency.onceaccepts'completed'and'seen', plusdismissCooldownMs. Queued tours are re-checked when they leave the queue.matchRouteignores query strings and hashes. - React: arrow keys inside sliders, menus, grids and other composite widgets (or
data-tour-keys="ignore") are left alone; only the most recently opened tour handles keys;dirdefaults to the document's;Tour.Portal(strategy: 'auto') renders inside an open modal dialog that holds the target (native<dialog>, Radix, vaul).
- Transitions:
@awesome-tour/codemod@1.0.0
Major Changes
-
#6
7457d44Thanks @yorigcs! - 1.0: the API is stable and every package follows semver from here on. Breaking changes only in a major, with a codemod or a migration note.Since 0.1: a hardened transition pipeline (rollback,
enterTimeout, no double hooks), targets that survive re-renders, shadow DOM, iframes and dialogs, StrictMode- and SSR-safe React bindings, resilient locators, goals, experiments, frequency caps, deep links, previews, behavior triggers, ordered checklists, per-locale step text, health checks in CI, a devtools funnel and recorder, dev diagnostics (AT001–AT008), and@awesome-tour/elementsfor apps without React. Display rules now tell completed tours from dismissed ones (once: true | 'completed' | 'seen').
Patch Changes
-
#6
c1c3e3aThanks @yorigcs! - Developer experience:- Development warnings with stable codes (AT001–AT007: duplicate step ids, unknown
next/advanceOn.to, invalid selectors, errors nobody listens to, routes without a router, two tours with one id), each explained on the new "Warnings & errors" page. Silent in production builds. createTournow rejects a stringnextthat isn't one of the tour's step ids at compile time.- Tours as JSON: locator objects (
{ tour },{ role, name },{ text },{ firstOf }),goal,onTargetLost,enterTimeout,beforeLeave, scroll options, logical sides and the new frequency options;validateTourJSONchecks enum values and locators. The JSON Schema is updated. - Codemod: joyride's
disableScrollingbecomesscroll, andspotlightPaddingpoints to the overlay'spadding.
- Development warnings with stable codes (AT001–AT007: duplicate step ids, unknown
@awesome-tour/three@0.1.1
Patch Changes
- #4
fdb446fThanks @yorigcs! - Published from GitHub Actions through npm trusted publishing, so every package now ships with a
provenance attestation linking it to the commit and workflow that built it. No code changes. - Updated dependencies [
fdb446f]:- @awesome-tour/core@0.1.1
- @awesome-tour/react@0.1.1