Hide suggestion box

[perunt]

Details

Currently, when using the suggestion box, there are only two ways to close it: by picking something from the suggestions or by pressing on another touchable area. Additionally, the suggestion box remains in the same position when scrolling down.

In this PR, I added the ability to close the suggestion box by tapping on any area outside the box. Also, scrolling is now disabled while the suggestion box is open to avoid misclicks.

Fixed Issues

$
PROPOSAL: #44720 (comment)

Tests

• Verify that no errors appear in the JS console

Offline tests

QA Steps

1. Send multiple messages in a report.
2. Edit a message in the middle
3. Type an emoji/mention trigger, starting with :sm (or @ for mention) followed by at least two more characters (e.g., :smile).
4. Scroll over the chat with the suggestion box opened
5. Verify that scrolling is disabled when the suggestion box is opened
6. Click on the area outside the box and verify that the suggestion box is closed
7. Verify that scrolling over the chat is enabled now

• Verify that no errors appear in the JS console

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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
  • 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 verified the translation was requested/reviewed 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.js 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.
• 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

Android: mWeb Chrome

iOS: Native

RPReplay_Final1720604012.MP4

iOS: mWeb Safari

MacOS: Chrome / Safari

Untitled.mov

MacOS: Desktop

Desct.mov

[melvin-bot]

@lakchote 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]

[lakchote]

Left a few comments.

[lakchote]

When a PR depends on another one to be merged, @perunt please add HOLD #{prNumber} to the PR's title. I've added it.

Thanks!

[perunt]

Thanks, @lakchote, for the review and renaming PR!
I just merged the upstream PR, so now it is good to check

[shawnborton]

This decision was made after extensive testing and was revealed only in that message. If you'd like, I can start a thread to explain everything in more detail.

Cool, yeah thank you for explaining everything in such detail! I think it would be great if you brought this into Slack, just for posterity's sake - I think we'll arrive at the same place, but I just want to make sure the decision has more visibility than the few people who will see this PR. Thanks!

[perunt]

Sure, I raised it here https://expensify.slack.com/archives/C01GTK53T8Q/p1721047319091279

[perunt]

@rayane-djouah, we have discussed this and concluded that this is the approach we want to use. Could you please continue reviewing this PR?

[lakchote]

@rayane-djouah, we have discussed this and concluded that this is the approach we want to use. Could you please continue reviewing this PR?

friendly bump @rayane-djouah in case you've missed this.

[rayane-djouah]

@perunt - Could you please include test steps in the author checklist? I suggest these steps:

1. Send multiple messages in a report.
2. Edit a message in the middle
3. Type an emoji/mention trigger, starting with :sm (or @ for mention) followed by at least two more characters (e.g., :smile).
4. Scroll over the chat with the suggestion box opened
5. Verify that scrolling is disabled when the suggestion box is opened
6. Click on the area outside the box and verify that the suggestion box is closed
7. Verify that scrolling over the chat is enabled now

[rayane-djouah]

Slack	New Dot (This PR)
a default cursor in the area outside the box	a hand cursor in the area outside the box
Screen.Recording.2024-07-17.at.3.22.42.PM.mov	Screen.Recording.2024-07-17.at.3.23.11.PM.mov

@Expensify/design What's the expected cursor type in the area outside the box?

[puneetlath]

Good testing. I think the Slack approach is ideal. Where the hand cursor is inside the suggestion box, but default cursor outside it.

[dannymcclain]

100% agree with Puneet!

[rayane-djouah]

BUG: TAB key does not select the emoji/mention in the edit mode composer like in the main composer:

Screen.Recording.2024-07-17.at.5.08.09.PM.mov

[perunt]

fixed hotkey handling, added cursor styles
@rayane-djouah

[rayane-djouah]

Thank you!
Changes look good to me and test well. The reviewer checklist is also complete.
🎀👀🎀 C+ reviewed

[melvin-bot]

🎯 @rayane-djouah, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #45676.

[rayane-djouah]

@lakchote all yours

[lakchote]

Thank you @rayane-djouah

LGTM

[OSBotify]

🚀 Deployed to staging by https://github.com/lakchote in version: 9.0.9-1 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

[OSBotify]

🚀 Cherry-picked to staging by https://github.com/mountiny in version: 9.0.9-2 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

[OSBotify]

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.9-5 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

[OSBotify]

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.10-7 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅