Update styling in mentions auto-suggestion component #18951

szebniok · 2023-05-15T13:13:50Z

Details

I took a guess with the margins between the avatar, display name and email, as they were not specified exactly in the issue.
@puneetlath Is the highlighted part of the email name readable enough? It wasn't shown on any of the mocks inside the design doc.

Fixed Issues

$ #18795

Tests

Verify that no errors appear in the JS console

Offline tests

QA Steps

Type in @ into the text input
Verify that the styles of suggestions match the mocks from [HOLD for payment 2023-06-15] Update styling in mentions auto-suggestion component #18795

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

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

melvin-bot · 2023-05-15T13:13:55Z

@puneetlath @sobitneupane One of you needs to 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]

sobitneupane

@szebniok Looks like there is a padding on the top (and probably at the bottom) of the suggestion list in the mock.

Mock	PR

puneetlath · 2023-05-15T14:14:58Z

@szebniok Looks like there is a padding on the top (and probably at the bottom) of the suggestion list in the mock.

Hm, yeah I agree that is there on the mock, but it looks like we don't do it for emojis today. What do you think @shawnborton?

I took a guess with the margins between the avatar, display name and email, as they were not specified exactly in the issue.
@puneetlath Is the highlighted part of the email name readable enough?

@shawnborton curious for your thoughts. How do the padding/margins look? And I think Konrad makes a fair point that it's a bit hard to read the alt text when it's highlighted.

szebniok · 2023-05-15T14:27:17Z

Hm, yeah I agree that is there on the mock, but it looks like we don't do it for emojis today.

Yes, currently the height of the emoji and mention suggestions is exactly the same.

sobitneupane

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

shawnborton · 2023-05-15T16:59:04Z

Looks like there is a padding on the top (and probably at the bottom) of the suggestion list in the mock.

I like adding the padding to the top/bottom to be consistent.

And I think Konrad makes a fair point that it's a bit hard to read the alt text when it's highlighted.

Can we change the color.textSupporting to be just color.text when the supporting alt text is highlighted?

shawnborton · 2023-05-15T17:00:06Z

Is this the most recent screenshot?

It looks like we aren't using the correct spacing/etc so that things line up better. I do think we can probably share these styles with the emoji suggestion menu.

puneetlath · 2023-05-22T16:23:15Z

@szebniok would you be able to pick this back up and take it to the finish line this week?

szebniok · 2023-05-25T12:43:41Z

@puneetlath I've updated the padding and the color of the higlighted text. I've updated the screenshots in the first comment.

puneetlath · 2023-05-25T21:05:15Z

Ok nice. I notice in your screenshots that it seems to look different on Android though.

sobitneupane

Screenshots/Videos

Web

Screen.Recording.2023-05-26.at.15.49.45.mov

Mobile Web - Chrome

Screen.Recording.2023-05-26.at.15.59.41.mov

Mobile Web - Safari

Screen.Recording.2023-05-26.at.15.54.24.mov

Desktop

Screen.Recording.2023-05-26.at.15.50.48.mov

iOS

Screen.Recording.2023-05-26.at.15.52.53.mov

Android

Screen.Recording.2023-05-26.at.15.57.35.mov

sobitneupane · 2023-05-26T10:20:58Z

Ok nice. I notice in your screenshots that it seems to look different on Android though.

+1

szebniok · 2023-05-26T11:38:58Z

Fixed the font weight on native Android, I believe that now it is consistent.

iOS	Android

sobitneupane

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.

shawnborton · 2023-05-29T14:17:40Z

Hmm this feels like the styling is still quite a bit off.

Each row should be 40px tall:

The icons that are not avatars should be green. They should be at 16x16. They should also be centered inside of a 24x24 box, this way the box matches the same size as the avatars:

And there should be 8px padding on the left/right side of the rows, and then 8px margin in between avatar + name + subname.

szebniok · 2023-05-31T10:06:26Z

@shawnborton Thank you for providing the exact pixel values. I didn't have access to the Figma. I've updated the PR and posted new screenshots in the first comment

shawnborton · 2023-05-31T12:18:44Z

Nice, I think this feels good to me. @puneetlath let me know what you think as well.

sobitneupane · 2023-05-31T12:29:54Z

@szebniok Looks like you have not pushed the commit yet. I cannot find the commit.

szebniok · 2023-05-31T13:49:01Z

@sobitneupane 😅 pushed it just now.

puneetlath · 2023-05-31T14:41:29Z

Looks good to me too!

sobitneupane

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

puneetlath · 2023-06-01T16:27:12Z

@sobitneupane just to confirm - you've tested the updated PR on all devices?

puneetlath · 2023-06-01T16:32:20Z

src/components/MentionSuggestions.js

@@ -63,25 +63,42 @@ const MentionSuggestions = (props) => {
     * @returns {JSX.Element}
     */
    const renderSuggestionMenuItem = (item) => {
-        const displayedText = _.uniq([item.text, item.alternateText]).join(' - ');
-        const styledTextArray = getStyledTextArray(displayedText, props.prefix);
+        const isIcon = item.text === CONST.AUTO_COMPLETE_SUGGESTER.HERE_TEXT;


NAB: this seems clearer to me.

Suggested change

const isIcon = item.text === CONST.AUTO_COMPLETE_SUGGESTER.HERE_TEXT;

const avatarSize = item.text === CONST.AUTO_COMPLETE_SUGGESTER.HERE_TEXT ? CONST.AVATAR_SIZE.MENTION_ICON : CONST.AVATAR_SIZE.SMALLER;

@szebniok thoughts? Last outstanding thing before I merge.

puneetlath

Looks good to me!

@szebniok @sobitneupane I had one small suggestion, but I don't feel strongly, so if you disagree I'm happy to merge.

sobitneupane · 2023-06-01T16:32:57Z

@puneetlath Yes, I have. Should I add screenshots?

puneetlath · 2023-06-01T16:34:09Z

@sobitneupane yes if you could update the screenshots that would be great. Just because we saw issues with android styling before, so I want to be confident.

sobitneupane · 2023-06-01T16:37:22Z

@puneetlath Updated the screenshots.

puneetlath · 2023-06-01T16:40:04Z

Awesome, thanks!

melvin-bot · 2023-06-06T22:02:04Z

Congrats, that’s your 5th PR merged! 🎉 Do you know about the ContributorPlus role? It’s an opportunity to earn more in the Expensify Open Source community. Keep up the great work - thanks!

OSBotify · 2023-06-06T22:08:15Z

✋ 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-06T22:46:15Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.3.25-2 🚀

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

OSBotify · 2023-06-08T17:39:08Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.25-8 🚀

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

narefyev91 · 2023-07-13T16:44:41Z

src/components/MentionSuggestions.js

-        const styledTextArray = getStyledTextArray(displayedText, props.prefix);
+        const isIcon = item.text === CONST.AUTO_COMPLETE_SUGGESTER.HERE_TEXT;
+        const styledDisplayName = getStyledTextArray(item.text, props.prefix);
+        const styledHandle = getStyledTextArray(item.alternateText, props.prefix);


https://github.com/Expensify/App/pull/21779/files - bug two same emails display for user without display name

cubuspl42 · 2023-10-10T08:56:13Z

src/styles/StyleUtils.js

@@ -1028,13 +1029,15 @@ function getAutoCompleteSuggestionItemStyle(highlightedEmojiIndex, rowHeight, ho
 function getAutoCompleteSuggestionContainerStyle(itemsHeight, shouldIncludeReportRecipientLocalTimeHeight) {
    const optionalPadding = shouldIncludeReportRecipientLocalTimeHeight ? CONST.RECIPIENT_LOCAL_TIME_HEIGHT : 0;
    const padding = CONST.AUTO_COMPLETE_SUGGESTER.SUGGESTER_PADDING - optionalPadding;
+    const borderWidth = 2;
+    const height = itemsHeight + 2 * CONST.AUTO_COMPLETE_SUGGESTER.SUGGESTER_INNER_PADDING + borderWidth;


Coming from #27140

When changing this logic, we didn't preserve the fix introduced in #18112

Fix mention suggestions styles

71c4d68

szebniok requested a review from a team as a code owner May 15, 2023 13:13

melvin-bot bot requested review from puneetlath and sobitneupane and removed request for a team May 15, 2023 13:13

sobitneupane reviewed May 15, 2023

View reviewed changes

puneetlath requested a review from shawnborton May 15, 2023 14:10

sobitneupane reviewed May 15, 2023

View reviewed changes

szebniok added 3 commits May 24, 2023 13:01

Merge branch 'main' into fix-mention-suggestions-styles

14e73eb

Add padding to the AutoCompleteSuggestions component

5805140

Fix prettier

6fd734f

sobitneupane reviewed May 26, 2023

View reviewed changes

Merge branch 'main' into fix-mention-suggestions-styles

edb21a2

Fix fontFamily on mention display name

21d82de

sobitneupane previously approved these changes May 27, 2023

View reviewed changes

szebniok added 3 commits May 31, 2023 09:59

Merge branch 'main' into fix-mention-suggestions-styles

c5bba91

Implement feedback

a2c69fd

Fix lint & prettier

84d3082

szebniok dismissed sobitneupane’s stale review via 84d3082 May 31, 2023 13:48

sobitneupane reviewed Jun 1, 2023

View reviewed changes

sobitneupane approved these changes Jun 1, 2023

View reviewed changes

puneetlath reviewed Jun 1, 2023

View reviewed changes

puneetlath approved these changes Jun 1, 2023

View reviewed changes

puneetlath merged commit e8b4aed into Expensify:main Jun 6, 2023

OSBotify mentioned this pull request Jun 6, 2023

Deploy Checklist: New Expensify 2023-06-06 #20312

Closed

31 tasks

melvin-bot bot mentioned this pull request Jun 8, 2023

[HOLD for payment 2023-06-15] Update styling in mentions auto-suggestion component #18795

Closed

narefyev91 reviewed Jul 13, 2023

View reviewed changes

narefyev91 mentioned this pull request Jul 13, 2023

[HOLD for payment 2023-07-12] [$1000] User without display name shows two same emails on mention #21245

Closed

6 tasks

getusha mentioned this pull request Sep 22, 2023

[HOLD for payment 2023-10-16] [$1000] Android - Inconsistency bug: App allows user to scroll behind mention results #27140

Closed

6 tasks

cubuspl42 reviewed Oct 10, 2023

View reviewed changes

0xmiros mentioned this pull request Oct 13, 2023

[$500] Chat - The user is able to scroll through the suggestion list #27866

Closed

6 tasks

	const isIcon = item.text === CONST.AUTO_COMPLETE_SUGGESTER.HERE_TEXT;
	const avatarSize = item.text === CONST.AUTO_COMPLETE_SUGGESTER.HERE_TEXT ? CONST.AVATAR_SIZE.MENTION_ICON : CONST.AVATAR_SIZE.SMALLER;

Update styling in mentions auto-suggestion component #18951

Update styling in mentions auto-suggestion component #18951

Conversation

szebniok commented May 15, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 15, 2023

sobitneupane left a comment • edited Loading

Choose a reason for hiding this comment

puneetlath commented May 15, 2023 • edited Loading

szebniok commented May 15, 2023

sobitneupane left a comment

Choose a reason for hiding this comment

Screenshots/Videos

shawnborton commented May 15, 2023

shawnborton commented May 15, 2023

puneetlath commented May 22, 2023

szebniok commented May 25, 2023

puneetlath commented May 25, 2023

sobitneupane left a comment • edited Loading

Choose a reason for hiding this comment

Screenshots/Videos

sobitneupane commented May 26, 2023

szebniok commented May 26, 2023

sobitneupane left a comment

Choose a reason for hiding this comment

Reviewer Checklist

shawnborton commented May 29, 2023

szebniok commented May 31, 2023

shawnborton commented May 31, 2023

sobitneupane commented May 31, 2023

szebniok commented May 31, 2023

puneetlath commented May 31, 2023

sobitneupane left a comment • edited Loading

Choose a reason for hiding this comment

Screenshots/Videos

puneetlath commented Jun 1, 2023

puneetlath Jun 1, 2023

Choose a reason for hiding this comment

puneetlath Jun 2, 2023

Choose a reason for hiding this comment

puneetlath left a comment

Choose a reason for hiding this comment

sobitneupane commented Jun 1, 2023

puneetlath commented Jun 1, 2023

sobitneupane commented Jun 1, 2023

puneetlath commented Jun 1, 2023

melvin-bot bot commented Jun 6, 2023

OSBotify commented Jun 6, 2023

OSBotify commented Jun 6, 2023

OSBotify commented Jun 8, 2023

narefyev91 Jul 13, 2023

Choose a reason for hiding this comment

cubuspl42 Oct 10, 2023

Choose a reason for hiding this comment

szebniok commented May 15, 2023 •

edited

Loading

sobitneupane left a comment •

edited

Loading

puneetlath commented May 15, 2023 •

edited

Loading

sobitneupane left a comment •

edited

Loading

sobitneupane left a comment •

edited

Loading