Skip to content

1.12.0

Choose a tag to compare

@nilbuild nilbuild released this 11 Nov 23:31
· 12 commits to master since this release

Added

  • popover.instruction makes a step an action step: the user has to do what it says. Next looks disabled until they do.
  • advanceOn: { event, strict: true } lets only that gesture through on the highlighted element.
  • advanceDelay pauses on a completed step before moving on. Action steps show a done state meanwhile.
  • driverObj.advance() completes the current step from your code, like advanceOn does.
  • driverObj.nudge("message") shows a line of feedback in the popover and shakes it.
  • onElementMissing takes "stay", "previous" or "previousAction" as well as a function.
  • disableActiveInteraction: "clicks" blocks clicks on the highlighted element but keeps hover working.
  • onHighlightStarted gets the same signal as onHighlighted.
  • A console warning when disableActiveInteraction makes a step's advanceOn impossible.
  • A highlighted element inside an allowed element, like an item in an open menu, gets a ring instead of a hidden cutout.
  • CSS variables for the instruction row, the feedback line and that ring. See Theming.

Changed

  • Clicks on the padding around the highlighted element, or on an element with disableActiveInteraction, no longer reach your app's document and body listeners. Use onInteraction to see them.
  • disableActiveInteraction: true also blocks Enter and Space on the highlighted element.
  • A highlighted element that your framework re-renders is followed automatically.
  • overlayClickBehavior: "nextStep" does nothing while the popover waits for an element.
  • onDestroyStarted gets the step being entered when the tour is closed during its first animation, not undefined.
  • The State type no longer lists the internal __ keys added in 1.11.0.

Fixed

  • Steps inside a modal <dialog> now dim the dialog and cut out the highlighted element.
  • moveNext(), drive() and destroy() now work when called from onHighlightStarted, onHighlighted or onDeselected.
  • moveTo() starts the tour if it isn't running.
  • setSteps() on a running tour ends it cleanly. Call drive() to start the new steps.
  • A step's showProgress: false now wins over showProgress: true on the driver.
  • A fast double-click no longer skips a step that advances on click. advanceOnClick ignores clicks while a step animates in, as before 1.11.0.
  • The key that completes a step, like Enter, no longer presses a button in the next popover.
  • The highlight and popover stay on their element when it changes size, when a framework rewrites its className, and when the page resizes mid-step.
  • A highlighted element that is removed from the page no longer keeps driver.js classes and aria attributes.
  • drive() without steps no longer locks the page when onDestroyStarted is set.
  • Less layout work while scrolling with hints or a tour, and waitForElement checks the page at most once a frame.