Fix Help RHP does not close when clicking outside RHP or with ESC key

[blazejkustra]

Explanation of Change

Previously, help pane wasn't handling ESC button at all, also clicking on overlay now closes the side pane instead of RHP beneath help pane.

Fixed Issues

$ #57798
PROPOSAL: N/A

Tests

Overlay click:

• Go to workspace settings > Categories
• Open any category
• Click Help icon
• Click outside RHP
• Help pane should close

Escape button:

• Open any category
• Press ESC key
• Help pane should close

Offline tests

N/A

QA Steps

Same as tests

PR Author Checklist

• I linked the correct issue in the ### Fixed Issues section above
• I wrote clear testing steps that cover the changes made in this PR
  • I added steps for local testing in the Tests section
  • I added steps for the expected offline behavior in the Offline steps section
  • I added steps for Staging and/or Production testing in the QA steps section
  • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
  • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
  • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
• I included screenshots or videos for tests on all platforms
• I ran the tests on all platforms & verified they passed on:
  • Android: Native
  • Android: mWeb Chrome
  • iOS: Native
  • iOS: mWeb Safari
  • MacOS: Chrome / Safari
  • MacOS: Desktop
• I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
• I followed proper code patterns (see Reviewing the code)
  • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
  • I verified that comments were added to code that is not self explanatory
  • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
  • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • If any non-english text was added/modified, I used JaimeGPT to get English > Spanish translation. I then posted it in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
  • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
  • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
  • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
  • I verified the JSDocs style guidelines (in STYLE.md) were followed
• If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
• I followed the guidelines as stated in the Review Guidelines
• I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
• I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
• I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
• I verified that if a function's arguments changed that all usages have also been updated correctly
• If any new file was added I verified that:
  • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
• If a new CSS style is added I verified that:
  • A similar style doesn't already exist
  • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
• If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
• If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
• If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
• If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
• If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
  • I verified that all the inputs inside a form are aligned with each other.
  • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
• If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
• I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
• If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native

and.webm

Android: mWeb Chrome

android.webm

MacOS: Chrome / Safari

Screen.Recording.2025-03-06.at.11.35.55.mov

[SzymczakJ]

LGTM

[melvin-bot]

@ZhenjaHorbach Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

[ZhenjaHorbach]

@blazejkustra
We have jest issues

[blazejkustra]

This is a regression from one of my PR @ZhenjaHorbach and @brunovjk should review this one, sorry!

[ZhenjaHorbach]

This is a regression from one of my PR @ZhenjaHorbach and @brunovjk should review this one, sorry!

No problem !

[brunovjk]

Great! Reviewing in a moment

[shawnborton]

Videos seem good to me 👍

[brunovjk]

@blazejkustra When the screen is reduced (on web browser and desktop), and the Help Panel is overlapping the content, pressing esc closes it successfully:

MacOS: Desktop

desktop_fine.mov

MacOS: Chrome / Safari

web_fine.mov

However, on a larger screen, when the panel is on the right side of the content, pressing esc "returns" to the workspace page, instead of closing the panel, at the workspace screen, esc does nothing. Is this supposed to be intentional?

MacOS: Desktop - bug

desktop_bug.mov

MacOS: Chrome / Safari - bug

web_bug.mov

On iOS native also works fine:

iOS: Native

ios_fine.mov

Thank you very much :D

[blazejkustra]

Is this supposed to be intentional?

Yes, it is intentional 😄

[brunovjk]

Great!!!! I will fill out the checklist later :D

[blazejkustra]

Closing this PR, as I moved the code to Stage 2 PR for side pane project.

[brunovjk]

@blazejkustra ESC is not working as it should in android (both native and mWeb), it is returning navigation within the Pane itself instead of closing it:

Android: Native

57925_android_native_bug.mov

Android: mWeb Chrome

57925_android_web_bug.mov

[brunovjk]

Closing this PR, as I moved the code to Stage 2 PR for side pane project.

oop, we posted almost at the same time hehhe