Support skip for dismissKeyAction + overlayClickAction

[MattIPv4]

👋 It'd be great if dismissKeyAction + overlayClickAction could support a skip value, like closeButtonAction, allowing a Joyride tour to be aborted if the user clicks on the background or uses the esc key.

[gilbarbara]

Hey Matt

Yeah, I considered it, but decided against it since it's a UX anti-pattern.
Skipping the whole thing with a simple click or keyboard press? I would hate that.

Anyway, let's keep it open to see if more people want this.

[MattIPv4]

Ah, interesting.

Yeh, I'd disagree with that -- if I press escape when I have a popup open, I'd expect it to close, not show another popup. Same deal if I click away from the popup, I'd expect it to close, not show another one.

I don't really see the harm in the library providing this option though, and keeping the default as it is today, based on your UX opinion?

[gilbarbara]

The onEvent callback already gives you everything you need for this. Since 3.0.2, all UI-triggered actions propagate their origin, so in the step:after event you can check whether the action came from keyboard (ESC key) or button_close, and call controls.skip() yourself:

onEvent={(data, controls) => {
  if (
    data.type === EVENTS.STEP_AFTER &&
    (data.origin === ORIGIN.KEYBOARD || data.origin === ORIGIN.BUTTON_CLOSE)
  ) {
    controls.skip();
  }
}}

This way, ESC and the close button skip the tour entirely, while overlay clicks and navigation buttons keep the default behavior. You can adjust the conditions however you like — e.g., only keyboard, or add overlay too.

No new props needed. The library already provides the primitives; it's just a matter of wiring them in onEvent.

[MattIPv4]

👍 Yes, that's what we were already doing in 3.0.0 as a workaround here. It seems odd, though, that we need to write our own event logic for this, but closeButtonAction just has a built-in option for it. Why not just add built-in options for dismissKeyAction + overlayClickAction as well, to match what closeButtonAction supports?