Feature: Make the mentions auto-complete menu scrollable #21196

Nikhil-Vats · 2023-06-21T12:15:44Z

Details

Make the mentions menu auto-scrollable and limit the maximum mentions to 20.

Fixed Issues

$ #20481
$ #20481 (comment)

Tests

Login using an account with more than 20 contacts.
Open a chat and type @.
Verify maximum mentions are 20 and maximum 5 suggestions are shown at once (maximum height of menu is 5 items, we need to scroll to see the rest).
Verify that mention menu is scrollable and scrollbar is visible.
Start typing further and mentions should be filtered further.
Now type :he in composer. Verify 20 emojis are shown and menu is scrollable.
Type further (eg - :heart_) and emojis should be filtered further.

Verify that no errors appear in the JS console

Offline tests

Same as above.

QA Steps

Same as above.

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 / Chrome
- iOS / native
- iOS / 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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 a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
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(themeColors.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 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.
I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

20481_chrome.mov

Mobile Web - Chrome

20481.web.chrome.mov

Mobile Web - Safari

safari.ios.MP4

Desktop

20481_desktop.mov

iOS

20481.ios.mov

Android

20481.android.mov

melvin-bot · 2023-06-21T12:15:49Z

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

abdulrahuman5196 · 2023-06-22T10:57:06Z

@Nikhil-Vats
In the mention suggestions, we are showing 20 members, but when i try to move through list on keyboard up or down arrow keys it is only moving through the first 5 mentions in the scrollview.

Screen.Recording.2023-06-22.at.4.24.05.PM.mp4

abdulrahuman5196 · 2023-06-22T11:31:11Z

@Nikhil-Vats as far as I tested other functions are working fine. Could you kindly fix the above issue and ping here so that i can review again,

Nikhil-Vats · 2023-06-22T12:00:37Z

@abdulrahuman5196 fixed! You can review it again.

abdulrahuman5196 · 2023-06-22T12:22:36Z

src/pages/home/report/ReportActionCompose.js

-    const emojiRowCount = isAutoSuggestionPickerLarge
-        ? Math.min(numRows, CONST.AUTO_COMPLETE_SUGGESTER.MAX_AMOUNT_OF_ITEMS)
-        : Math.min(numRows, CONST.AUTO_COMPLETE_SUGGESTER.MIN_AMOUNT_OF_ITEMS);
+const getMaxArrowIndex = (numRows, isAutoSuggestionPickerLarge, isMentionSuggestion = false) => {


Maybe instead of isMentionSuggestion param, can we use maxAmountOfItems = CONST.AUTO_COMPLETE_SUGGESTER.MAX_AMOUNT_OF_ITEMS param and for mentions we would pass CONST.AUTO_COMPLETE_SUGGESTER.MAX_AMOUNT_OF_MENTIONS.

Seems to be cleaner. Or other suggestions also welcome, but the current change doesn't seem clean.

@Nikhil-Vats

@abdulrahuman5196 I agree, fixed.

abdulrahuman5196 · 2023-06-22T15:10:38Z

@Nikhil-Vats App is crashing on the below steps,

choose a mention
starting deleting the characters with backspace
simultaneously hold the arrow key up to move
app is crashing

Screen.Recording.2023-06-22.at.8.37.22.PM.mp4

Nikhil-Vats · 2023-06-22T16:36:30Z

@abdulrahuman5196 fixed. Added getItemLayout function to handle offscreen indices and avoid failures.

abdulrahuman5196 · 2023-06-22T17:53:41Z

@Nikhil-Vats It seems the latest update from the thread is to have consistent number between emojis and suggestions. So we can show 20 emojis as well.

Nikhil-Vats · 2023-06-22T18:47:01Z

@abdulrahuman5196 done.

abdulrahuman5196 · 2023-06-23T08:44:41Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible 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 checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (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
- 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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 verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
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
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
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(themeColors.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 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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Screen.Recording.2023-06-23.at.12.43.03.PM.mp4

Mobile Web - Chrome

az_recorder_20230623_125053.mp4

Mobile Web - Safari

Untitled.mp4

Desktop

Screen.Recording.2023-06-23.at.1.54.31.PM.mp4

iOS

Screen.Recording.2023-06-23.at.1.09.17.PM.mp4

Android

az_recorder_20230623_140435.mp4

abdulrahuman5196 · 2023-06-23T08:51:42Z

NAB: Kindly mark the "Verify that no errors appear in the JS console" in QA steps as well

Nikhil-Vats · 2023-06-23T08:52:15Z

@abdulrahuman5196 done.

abdulrahuman5196

Changes looks good and works well. Reviewers checklist also complete.

All yours. @puneetlath

🎀👀🎀
C+ Reviewed

Apologies for code redos due to delay in emoji consistency decision. @Nikhil-Vats

puneetlath · 2023-06-23T14:47:51Z

Are steps 6 and 7 of the test steps still accurate?

abdulrahuman5196 · 2023-06-23T14:51:26Z

Yeah, it needs to be updated. @Nikhil-Vats Could you kindly update the emoji steps to reflect latest change of 20 suggestions?

puneetlath

Just a couple small comments.

puneetlath · 2023-06-23T14:51:11Z

src/CONST.js

@@ -847,7 +847,11 @@ const CONST = {
        ITEM_HEIGHT: 40,
        SMALL_CONTAINER_HEIGHT_FACTOR: 2.5,
        MIN_AMOUNT_OF_ITEMS: 3,
-        MAX_AMOUNT_OF_ITEMS: 5,
+        // max number of suggestions
+        MAX_AMOUNT_OF_ITEMS: 20,


I think a better name would take a way the need for the comment. Maybe like:

Suggested change

MAX_AMOUNT_OF_ITEMS: 20,

MAX_AMOUNT_OF_SUGGESTIONS: 20,

puneetlath · 2023-06-23T14:52:41Z

src/CONST.js

+        MAX_AMOUNT_OF_ITEMS: 20,
+        // used for limiting the height of suggestions container, we show a scrollable list
+        // with max height equal to MAX_AMOUNT_OF_VISIBLE_ITEMS_IN_WINDOW (5) * ITEM_HEIGHT.
+        MAX_AMOUNT_OF_VISIBLE_ITEMS_IN_WINDOW: 5,


Similarly, with a better constant name, I think we can obviate the need for the comment. How about:

Suggested change

MAX_AMOUNT_OF_VISIBLE_ITEMS_IN_WINDOW: 5,

MAX_AMOUNT_OF_VISIBLE_SUGGESTIONS_IN_CONTAINER: 5,

Nikhil-Vats · 2023-06-23T15:21:17Z

@abdulrahuman5196 @puneetlath changed test steps and constant names. You can review again.

abdulrahuman5196

Changes looks good and works well. Reviewers checklist also complete.

All yours @puneetlath . Good to merge.

🎀👀🎀
C+ Reviewed

OSBotify · 2023-06-23T16:21:45Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2023-06-23T22:16:43Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.3.32-1 🚀

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

OSBotify · 2023-06-26T20:47:20Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.3.32-5 🚀

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

Feature: Make the mentions auto-complete menu scrollable

9933d9f

Nikhil-Vats requested a review from a team as a code owner June 21, 2023 12:15

melvin-bot bot removed the request for review from a team June 21, 2023 12:15

melvin-bot bot requested a review from abdulrahuman5196 June 21, 2023 12:15

Nikhil-Vats mentioned this pull request Jun 21, 2023

[HOLD for payment 2023-07-03] [$1000] Feature Request: Make the mentions auto-complete menu scrollable #20481

Closed

fix arrow key behaviour

51fa88d

abdulrahuman5196 suggested changes Jun 22, 2023

View reviewed changes

Change getMaxIndex function definition

97d7f0c

puneetlath self-requested a review June 22, 2023 16:24

Nikhil-Vats added 2 commits June 22, 2023 22:04

Use getItemLayout to handle offscreen indices and avoid failures

a443cda

fix lint

e50a27b

Consistent emoji and mention suggestions

5000ec3

fix lint

010a66c

abdulrahuman5196 approved these changes Jun 23, 2023

View reviewed changes

puneetlath requested changes Jun 23, 2023

View reviewed changes

change constant names

bf5a593

Nikhil-Vats requested a review from puneetlath June 23, 2023 15:24

puneetlath approved these changes Jun 23, 2023

View reviewed changes

abdulrahuman5196 approved these changes Jun 23, 2023

View reviewed changes

melvin-bot bot requested a review from puneetlath June 23, 2023 15:57

puneetlath approved these changes Jun 23, 2023

View reviewed changes

puneetlath merged commit 37df9db into Expensify:main Jun 23, 2023

OSBotify mentioned this pull request Jun 24, 2023

Deploy Checklist: New Expensify 2023-06-24 #21477

Closed

45 tasks

0xmiros mentioned this pull request Jun 25, 2023

Migrate ReportActionCompose to function #18648

Merged

56 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature: Make the mentions auto-complete menu scrollable #21196

Feature: Make the mentions auto-complete menu scrollable #21196

Nikhil-Vats commented Jun 21, 2023 •

edited

Loading

melvin-bot bot commented Jun 21, 2023

abdulrahuman5196 commented Jun 22, 2023

abdulrahuman5196 commented Jun 22, 2023

Nikhil-Vats commented Jun 22, 2023

abdulrahuman5196 Jun 22, 2023

abdulrahuman5196 Jun 22, 2023

Nikhil-Vats Jun 22, 2023

abdulrahuman5196 commented Jun 22, 2023

Nikhil-Vats commented Jun 22, 2023

abdulrahuman5196 commented Jun 22, 2023

Nikhil-Vats commented Jun 22, 2023

abdulrahuman5196 commented Jun 23, 2023 •

edited

Loading

abdulrahuman5196 commented Jun 23, 2023

Nikhil-Vats commented Jun 23, 2023

abdulrahuman5196 left a comment

puneetlath commented Jun 23, 2023

abdulrahuman5196 commented Jun 23, 2023

puneetlath left a comment

puneetlath Jun 23, 2023

puneetlath Jun 23, 2023

Nikhil-Vats commented Jun 23, 2023

abdulrahuman5196 left a comment

OSBotify commented Jun 23, 2023

OSBotify commented Jun 23, 2023

OSBotify commented Jun 26, 2023

	MAX_AMOUNT_OF_VISIBLE_ITEMS_IN_WINDOW: 5,
	MAX_AMOUNT_OF_VISIBLE_SUGGESTIONS_IN_CONTAINER: 5,

Feature: Make the mentions auto-complete menu scrollable #21196

Feature: Make the mentions auto-complete menu scrollable #21196

Conversation

Nikhil-Vats commented Jun 21, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jun 21, 2023

abdulrahuman5196 commented Jun 22, 2023

abdulrahuman5196 commented Jun 22, 2023

Nikhil-Vats commented Jun 22, 2023

abdulrahuman5196 Jun 22, 2023

Choose a reason for hiding this comment

abdulrahuman5196 Jun 22, 2023

Choose a reason for hiding this comment

Nikhil-Vats Jun 22, 2023

Choose a reason for hiding this comment

abdulrahuman5196 commented Jun 22, 2023

Nikhil-Vats commented Jun 22, 2023

abdulrahuman5196 commented Jun 22, 2023

Nikhil-Vats commented Jun 22, 2023

abdulrahuman5196 commented Jun 23, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

abdulrahuman5196 commented Jun 23, 2023

Nikhil-Vats commented Jun 23, 2023

abdulrahuman5196 left a comment

Choose a reason for hiding this comment

puneetlath commented Jun 23, 2023

abdulrahuman5196 commented Jun 23, 2023

puneetlath left a comment

Choose a reason for hiding this comment

puneetlath Jun 23, 2023

Choose a reason for hiding this comment

puneetlath Jun 23, 2023

Choose a reason for hiding this comment

Nikhil-Vats commented Jun 23, 2023

abdulrahuman5196 left a comment

Choose a reason for hiding this comment

OSBotify commented Jun 23, 2023

OSBotify commented Jun 23, 2023

OSBotify commented Jun 26, 2023

Nikhil-Vats commented Jun 21, 2023 •

edited

Loading

abdulrahuman5196 commented Jun 23, 2023 •

edited

Loading