Skip to main content
userTourKit
@tour-kit/announcements

Changelog

Release history for the @tour-kit/announcements package — version-by-version log of breaking changes, new features, and bug fixes. Autogenerated from Changesets.

domidex01Published

Looking for the <ChangelogPage> component (the React primitive you embed in your own product to show your product's changelog to your users)? See ChangelogPage Component.

Release history for the @tour-kit/announcements package. Every entry below is auto-generated by Changesets from a PR-attached changeset file — the same source of truth that drives semver bumps and npm publishes. The authoritative copy lives at packages/announcements/CHANGELOG.md in the repository.

How to read this changelog

  • Major (e.g. 4.0.05.0.0) — breaking changes. Read the migration note in the release entry before upgrading.
  • Minor (e.g. 4.0.04.1.0) — new features, backward compatible.
  • Patch (e.g. 4.1.04.1.1) — bug fixes and internal cleanup, no API changes.
  • Updated dependencies lines mean the version bump was triggered by a dependency (usually @tour-kit/core) — the announcement package itself hasn't shipped behavior changes in that release.

Where to find the entries

Latest highlights

The most recent intentional behavior changes worth knowing about:

4.1.0 — Priority queue comparator fix

Custom priorityWeights and priorityOrder: 'fifo' | 'lifo' from QueueConfig now actually drive auto-show ordering. Before 4.1.0 an inline comparator hardcoded { critical: 0, high: 1, normal: 2, low: 3 } and silently ignored both options. This is a behavior fix — if you had configured these options before 4.1.0 and the order looked wrong, this release is why.

New helpers exposed: createAnnouncementComparator(order, weights, sequenceById) and AnnouncementScheduler.queueConfig getter.

4.0.0 — AnnouncementSpotlight visual breaking + Sonner adapter

  • <AnnouncementSpotlight> cutout switched from soft radial gradient to a 2px inset stroke + directional arrow. Passes WCAG 2.1 AA contrast on white, off-white, and light-gray backgrounds. Opt back into the legacy look with variant="legacy-spotlight" (kept until v5).
  • New @tour-kit/announcements/adapters/sonner peer-optional adapter for variant="toast". Pass toastAdapter={sonnerAdapter} to the provider. No Sonner bytes ship in the main bundle.

3.0.0 — Dashboard QA pass

  • New TourEventName analytics events: announcement_shown, announcement_dismissed, announcement_completed.
  • <AnnouncementModal> now forwards aria-describedby and renders with asDialogContent so Radix's title/description requirements are satisfied — eliminates the DialogTitle is required console warning.
  • Install graph: @tour-kit/analytics moved from optional peer to direct dependency. No more manual install for analytics events.

Migration guides

When a release introduces a breaking change, the changeset entry itself contains the migration steps. For larger structural changes, see the dedicated guides:

Need an older release's entry?

The full file is at packages/announcements/CHANGELOG.md. Anything older than ~6 months is mirrored to GitHub Releases only and not re-rendered here.

Free & open source

Ship onboarding, not config.

npm i @tour-kit/core is MIT and free. The Pro packages work unlicensed too — a one-time $99 license removes the production watermark when you ship.

MIT-licensed — no signup, no credit card. Pay once, only when you ship.