Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Emoji Category Shortcuts Bar Tooltip #15513

Merged

Conversation

akshayasalvi
Copy link
Contributor

@akshayasalvi akshayasalvi commented Feb 27, 2023

Details

Fixed Issues

$ #15108
PROPOSAL: #15108 (comment)

Tests

For Desktop and Web

  1. Open the app
  2. Go to any chat
  3. Click on the Emoji Icon
  4. Hover over the category icons
  5. Ensure that you are able to see the Tooltip
  6. You can change the language and confirm that the tooltip shows up in the selected language.
  7. Click on the Emoji Category Icon, and confirm it scrolls to the correct category
  8. Attempt the steps 3-6 on a new account to see that Frequently Used category is not shown and still the steps work fine.

For mWeb and Mobile Apps

  1. Open the app
  2. Go to any chat
  3. Click on the Emoji Icon
  4. Click on the Emoji Category Icon, and confirm it scrolls to the correct category
  5. Attempt the steps 2-4 on a new account to see that Frequently Used category is not shown and still the steps work fine.
  • Verify that no errors appear in the JS console

Offline tests

NA

QA Steps

For Desktop and Web

  1. Open the app
  2. Go to any chat
  3. Click on the Emoji Icon
  4. Hover over the category icons
  5. Ensure that you are able to see the Tooltip
  6. You can change the language and confirm that the tooltip shows up in the selected language.
  7. Click on the Emoji Category Icon, and confirm it scrolls to the correct category
  8. Attempt the steps 3-6 on a new account to see that Frequently Used category is not shown and still the steps work fine.

For mWeb and Mobile Apps

  1. Open the app
  2. Go to any chat
  3. Click on the Emoji Icon
  4. Click on the Emoji Category Icon, and confirm it scrolls to the correct category
  5. Attempt the steps 2-4 on a new account to see that Frequently Used category is not shown and still the steps work fine.
  • 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 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 correct English and 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 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 Screenshot 2023-02-27 at 11 27 12 PM

v1
https://user-images.githubusercontent.com/57435789/221661937-ba95e97f-1c3b-48a5-a057-21796e0356f0.mp4

v2

screen-recording-2023-03-02-at-113250-am_tGYVn3nY.mp4

v3

Screenshot 2023-03-02 at 12 59 02 PM

v4 with 4px padding

Screenshot 2023-03-02 at 7 05 31 PM
Mobile Web - Chrome Screenshot 2023-02-28 at 12 26 11 AM
Mobile Web - Safari Screenshot 2023-02-28 at 12 44 14 AM
Desktop Screenshot 2023-02-27 at 11 29 44 PM

v1
https://user-images.githubusercontent.com/57435789/221662042-4ef1cfeb-6943-4df7-8764-2acfa55183b8.mp4

v2

screen-recording-2023-03-02-at-113955-am_l6VRduEh.mp4

v3
Screenshot 2023-03-02 at 12 59 02 PM

v4 with 4px padding

Screenshot 2023-03-02 at 7 05 54 PM
iOS Screenshot 2023-02-28 at 1 27 19 AM
Android Screenshot 2023-02-27 at 11 50 04 PM

@akshayasalvi akshayasalvi requested a review from a team as a code owner February 27, 2023 17:53
@melvin-bot melvin-bot bot requested review from aimane-chnaif and stitesExpensify and removed request for a team February 27, 2023 17:53
@MelvinBot
Copy link

@stitesExpensify @aimane-chnaif 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]

@akshayasalvi akshayasalvi changed the title [WIP]: Emoji Category Shortcuts Bar Tooltip Emoji Category Shortcuts Bar Tooltip Feb 27, 2023
@akshayasalvi
Copy link
Contributor Author

@aimane-chnaif @stitesExpensify PR is ready for review. I've had some issues with iOS pod setup. I treied working it out other branch and it worked fine, but here I had to reinstall the pods. Can you confirm if you face the same issue?

Copy link
Contributor

@aimane-chnaif aimane-chnaif left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

bug1.mov

When hover top and bottom part of icon, tooltip not showing though highlighted

src/components/EmojiPicker/EmojiPickerMenu/index.js Outdated Show resolved Hide resolved
src/libs/EmojiUtils.js Outdated Show resolved Hide resolved
@akshayasalvi
Copy link
Contributor Author

When hover top and bottom part of icon, tooltip not showing though highlighted

@aimane-chnaif That's what I wanted to highlight in this comment. Because Tooltip is attached to the View it only and hence it doesn't show up for Pressable. If we want to put on Pressable, then we'll have to wrap it around the View, pass the styles and update accordingly. Let me know if you that needs to be done.

cc - @stitesExpensify

@aimane-chnaif
Copy link
Contributor

@akshayasalvi I think that needs to be fixed for sure

@aimane-chnaif
Copy link
Contributor

@akshayasalvi update?

@akshayasalvi
Copy link
Contributor Author

I will be online in a few hours and I will update PR later today.

@akshayasalvi akshayasalvi requested review from aimane-chnaif and removed request for stitesExpensify March 1, 2023 19:03
@akshayasalvi
Copy link
Contributor Author

I requested a review again from @aimane-chnaif and it accidentally removed @stitesExpensify. PR is ready with the updates and comments addressed.

@aimane-chnaif
Copy link
Contributor

@akshayasalvi press background should cover entire icon

bug2.mov

@aimane-chnaif
Copy link
Contributor

aimane-chnaif commented Mar 2, 2023

@akshayasalvi you should figure out why tooltip points to center if not using shiftVertical={-8}.
It seems you're not able to fix soon.
Please update code like this:

            <Pressable
                onPress={this.props.onPress}
                onHoverIn={() => this.setState({isHighlighted: true})}
                onHoverOut={() => this.setState({isHighlighted: false})}
                style={({pressed}) => ([
                    StyleUtils.getButtonBackgroundColorStyle(getButtonState(false, pressed)),
                    styles.categoryShortcutButton,
                    this.state.isHighlighted && styles.emojiItemHighlighted,
                ])}
            >
-               <View style={styles.alignSelfCenter}>
+               <Tooltip
+                   containerStyles={[styles.flex1, styles.alignSelfStretch, styles.alignItemsCenter, styles.justifyContentCenter]}
+                   text={this.props.translate(`emojiPicker.headers.${this.props.code}`)}
+               >
                    <Icon
                        fill={themeColors.icon}
                        src={this.props.icon}
                        height={variables.iconSizeNormal}
                        width={variables.iconSizeNormal}
                    />
-               </View>
+               </Tooltip>
            </Pressable>
    categoryShortcutButton: {
        flex: 1,
        borderRadius: 8,
-       paddingTop: 2,
-       paddingBottom: 2,
        height: CONST.EMOJI_PICKER_ITEM_HEIGHT,
+       alignItems: 'center',
        justifyContent: 'center',
    },

(this code diff is against main)

@akshayasalvi
Copy link
Contributor Author

@aimane-chnaif thanks for the diff, I've updated as per your requirement. But I checked the other tooltip if you closely observe there's always some spacing between the element and their tooltip, that's what I was trying to achieve.

With the current implementation
Screenshot 2023-03-02 at 11 34 08 AM

Other tooltips
Screenshot 2023-03-02 at 11 34 16 AM
Screenshot 2023-03-02 at 11 34 28 AM

@aimane-chnaif
Copy link
Contributor

@akshayasalvi your screenshot didn't apply last style change. can you update screenshot after this apply?

    categoryShortcutButton: {
        flex: 1,
        borderRadius: 8,
-       paddingTop: 2,
-       paddingBottom: 2,
        height: CONST.EMOJI_PICKER_ITEM_HEIGHT,
+       alignItems: 'center',
        justifyContent: 'center',
    },

@akshayasalvi
Copy link
Contributor Author

@aimane-chnaif The video that I uploaded again in the GH PR body consists of the style change as well. I uploaded v1 and v2 for Web and Desktop. Attaching the image also here for your reference.

image

@aimane-chnaif
Copy link
Contributor

aimane-chnaif commented Mar 2, 2023

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 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 correct English and 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 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
web.mov
web4
Mobile Web - Chrome
mchrome.mov
Mobile Web - Safari

msafari

Desktop
desktop.mov
desktop4
iOS

ios

Android
android.mov

aimane-chnaif
aimane-chnaif previously approved these changes Mar 2, 2023
@akshayasalvi
Copy link
Contributor Author

@aimane-chnaif Based on @shawnborton's comment I've updated the spacing to 4px.

@shawnborton
Copy link
Contributor

Thank you!

@akshayasalvi
Copy link
Contributor Author

@stitesExpensify @aimane-chnaif bump on the change and tagging because @stitesExpensify was removed from the reviewer list.

@stitesExpensify stitesExpensify self-requested a review March 2, 2023 17:19
@akshayasalvi
Copy link
Contributor Author

@stitesExpensify were you able to check this PR? Any action items for me?

@stitesExpensify
Copy link
Contributor

Hi, I was OOO sick for most of last week. Reviewing now

Copy link
Contributor

@stitesExpensify stitesExpensify left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code LGTM! Testing now

@stitesExpensify stitesExpensify merged commit 95cdfdb into Expensify:main Mar 6, 2023
@OSBotify
Copy link
Contributor

OSBotify commented Mar 6, 2023

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

@akshayasalvi
Copy link
Contributor Author

Thanks for the approval @stitesExpensify. Hope you're feeling better now.

@OSBotify
Copy link
Contributor

OSBotify commented Mar 7, 2023

🚀 Deployed to staging by https://github.com/stitesExpensify in version: 1.2.80-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Mar 9, 2023

🚀 Deployed to production by https://github.com/roryabraham in version: 1.2.80-2 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants