Changelog

The Unreleased section lists changes that are merged and will ship in the next release. Once a release is published, these entries move under a versioned heading.

Unreleased

Fixed

• Popover no longer jumps when its content has images that load after render.

1.6.0

Added

• animationDuration config to control how long the highlight transition takes. (#104)
• allowScroll config to lock body scroll while a tour is active.
• onDoneClick hook, fired when the done button on the final step is clicked. (#500)
• data property on a step for passing arbitrary data, accessible from hooks for custom per-step logic. (#539)

Changed

• Breaking Popover footer buttons are now styled through the driver-popover-footer-btn class instead of the .driver-popover-footer button selector. Buttons you add through onPopoverRender no longer inherit the default styling automatically. Add the driver-popover-footer-btn class to opt in, or leave it off to apply your own styles. The built-in next/previous buttons carry the class out of the box. (#555)
• Custom buttons added through onPopoverRender now receive their own click events. Only the built-in next, previous, and close buttons have their default action intercepted by the library.
• The popover exposes driver-popover-side-* and driver-popover-align-* classes so you can target its position from CSS, and the arrow positioning was rewritten for more accurate placement.

Fixed

• Document event listener leak in onDriverClick that left handlers attached after the tour was destroyed. (#452)
• Dropped the CSS :has() selector for broader browser compatibility. (#586)
• Positioned highlighted elements and their children (e.g. dropdown menus) no longer get clipped. (#454, #563)
• removeChild DOMException when re-rendering a popover whose wrapper was already detached from the DOM. (#572)
• Close button on a single-element highlight() popover did nothing when clicked. It now closes the popover by default, respecting allowClose and any custom onCloseClick. (#444)

1.5.0

Added

• getNextStep method on the driver API. (#420)
• driver-popover-done-btn class on the next button when it acts as the done button on the final step. (#610)

Changed

• The onDestroyed hook now receives the final tour state. (#553)
• Removed the unicode characters from the default button labels.

Fixed

• The tour no longer closes when pressing the left arrow on the first step. (#564)
• Removed the button text-shadow that left ghost text behind. (#605)
• onNextClick now fires when advancing the tour through an overlay click. (#576)

For the release notes of other versions, see the GitHub releases page.

Migrating from 0.x to 1.x

Driver.js 1.x is a major release with a new API and architecture. See the Migrate to 1.x guide for a step-by-step walkthrough of the import, configuration, and API changes.