search

jupyterlab-contrib / jupyterlab-tour

A JupyterLab UI tour built on jupyterlab-tutorial and react-joyride.
BSD 3-Clause "New" or "Revised" License
62 stars 9 forks source link

ESC key and click outside modal do not stop exit tour. #58

Open girdevstack opened 2 years ago

girdevstack commented 2 years ago

Description

When attempting to exit any tour using the esc key or clicking outside the modal, the tour continues on to the next step.

Reproduce

  1. Go to help menu
  2. Click on any tour
  3. Start tour
  4. Attempt to click outside of tour
  5. Attempt to exit tour using `esc key
  6. Attempt to close clicking "X" on window
    • Tour continues -

Expected behavior

When a user presses the esc key or clicks outside the tour, the tour should be exited and they should regain control of their notebook session instead of continuing the tour.

Context

Python 3.9.7 jupyter-client 7.1.1 jupyter-core 4.9.1 jupyterlab 3.2.8 jupyterlab-tour 3.1.4

fcollonval commented 2 years ago

Thanks for the suggestion.

I can provide some pointers if you wish to submit a PR.

fcollonval commented 2 years ago

Testing it right now, it happens only on the first step. When pressing ESC on others steps (or clicking on the overlay), the tour is paused as expected. It may be a bug in react-joyride library.