1.8.0
- Hints: pulsing beacons that open a popover on click; overlay optional, the page stays interactive.
driver.js/hints, ~5KB gzip. Guide. (#363) advanceOnClick(driver and step level) to advance the tour by clicking the highlighted element itself. (#606)waitForElement(driver and step level) to wait up to N ms for a step's element before treating it as missing. (#606)sideEffectsfield in package.json for better tree-shaking.
- Popover internals shared between tours and hints; tour behaviour verified unchanged against 1.7.0.
- Build migrated from vite to tsdown; artifact names, exports map and CDN globals unchanged, sizes within ±2%.
skipMissingElement: the last reachable step now shows Done and runsonDoneClick; step queries likeisLastStep()account for skips. (#616)
1.7.0
skipMissingElementoption to skip a step whose target element is missing (#489, #395)indexon the options passed to every hook (#490)--driver-popover-font-familyCSS variable to set the popover font (#607)
- The popover title and description now render in the default font stack. Set
--driver-popover-font-familyto use your own.
1.6.0
animationDurationconfig to control how long the highlight transition takes. (#104)allowScrollconfig to lock body scroll while a tour is active.onDoneClickhook, fired when the done button on the final step is clicked. (#500)dataproperty on a step for passing arbitrary data, accessible from hooks for custom per-step logic. (#539)
- Breaking - Custom popover footer buttons no longer get auto styled, style them using
.driver-popover-footer buttonselector (#555) - The popover exposes
driver-popover-side-*anddriver-popover-align-*classes as per the rendered side and alignment https://github.com/nilbuild/driver.js/issues/608 - Arrow positioning has been fixed https://github.com/nilbuild/driver.js/issues/558 https://github.com/nilbuild/driver.js/issues/429 https://github.com/nilbuild/driver.js/issues/406
- Document event listener leak in
onDriverClickthat 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)
removeChildDOMException 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, respectingallowCloseand any customonCloseClick. (#444)
1.5.0
- [x] Add done-btn class to next button (closes #610)
- [x] Pass final state to onDestroyed hook (closes #553)
- [x] Keep tour open on arrow-left at step 1 (closes #564)
- [x] Remove button text-shadow ghost text (closes #605)
- [x] Fire onNextClick on overlay nextStep (closes #576)
- [x] Add getNextStep to the driver API (closes #420)
- [x] Remove unicode characters from buttons
1.4.0
- [x]
overlayClickBehaviornow supports callbacks (Fixes https://github.com/kamranahmedse/driver.js/issues/476, https://github.com/kamranahmedse/driver.js/pull/600) - [x] Documents missing configuration option https://github.com/kamranahmedse/driver.js/pull/573
1.3.6
- [x] Fix - Buttons not clickable when they have nested elements https://github.com/kamranahmedse/driver.js/pull/560
- [x] Documents the missing options https://github.com/kamranahmedse/driver.js/pull/562
- [x] Fix - Module not found: Default condition should be last one https://github.com/kamranahmedse/driver.js/issues/545
- [x] Fix - Type definition for onPopoverRender https://github.com/kamranahmedse/driver.js/pull/548
- [x] Fix - CSS not importable in CSS files
Thank you @jarikmarwede @SliverYuki and @ervan23 for the contributions 🙏
1.3.4
- [x] Fix https://github.com/kamranahmedse/driver.js/issues/431 - Scroll to top for taller elements
- [x] Fixes issue where CSS is not importable in CSS file using
@import
1.3.2
- [x] Fixes alignment issue in some cases https://github.com/kamranahmedse/driver.js/issues/531
- [x] Improves documentation (Thanks @jarikmarwede https://github.com/kamranahmedse/driver.js/pull/544)
- [x] Exposes
driverinstance in hooks https://github.com/kamranahmedse/driver.js/issues/537 - [x] Allows element to be function type (Thanks @richie-south https://github.com/kamranahmedse/driver.js/pull/463)
- [x] Allows disabling interactions with active element (Thanks @tmsperera https://github.com/kamranahmedse/driver.js/pull/534)
- [x] Allows overlay click to navigate to next step (Thanks @CryUshio https://github.com/kamranahmedse/driver.js/pull/499)
1.3.1
- [x] Add programmatically destroy to api docs https://github.com/kamranahmedse/driver.js/pull/438
- [x] Add license to package.json https://github.com/kamranahmedse/driver.js/pull/432
- [x] Fix error in vite config https://github.com/kamranahmedse/driver.js/pull/416
1.3.0
- [x] Update vite configuration to support ES2019 https://github.com/kamranahmedse/driver.js/pull/422 https://github.com/kamranahmedse/driver.js/pull/416 (Closes https://github.com/kamranahmedse/driver.js/issues/409 and https://github.com/kamranahmedse/driver.js/issues/410)
- [x] Popover title to support HTML https://github.com/kamranahmedse/driver.js/pull/415 (Closes https://github.com/kamranahmedse/driver.js/issues/414)
- [x] Fixes wrong type definition for
onPopoverRenderconfiguration - [x] Add validation on class name https://github.com/kamranahmedse/driver.js/commit/288c7deafb5fa0f7e8a6d5d98648a047eb2b2b27
- [x] Upgrade all the dependencies to latest