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

fix hightlight button when hovering #27627

Merged

Conversation

suneox
Copy link
Contributor

@suneox suneox commented Sep 18, 2023

Details

Fixed Issues

$ #25687
PROPOSAL: #25687 (comment)

Tests

Note: The hover feature is only supported on web and desktop app.

Case1:

  1. Login with any account.
  2. Click FAB and select Manual request.
  3. Fill any value and select any member.
  4. Verify "Show more" button has a different background color when hovering.

Case2:

  1. Login with any account.
  2. Click FAB and select Distance request.
  3. Verify "Add stop" button has a different background color when hovering.

Case3:

  1. Login with any account.
  2. Go to any chat channel, send an attachment has password and multiple images
  3. Click the pdf message to open the Attachment modal
  4. Click enter the password
  5. Verify Confirm / Previous / Next buttons have a different background color when hovering.

Case4:

  1. Login with any account.
  2. Go to Profile setting.
  3. Click Avatar and then upload a photo.
  4. Verify "Rotate" button on the Edit photo page has a different background color when hovering.

Case5:

  1. Login with any account and open any chat.
  2. Create a request money message.
  3. Right-click on this message and select Delete message.
  4. Verify the Cancel button on the Confirm modal has a different background color when hovering.

Offline tests

QA Steps

The same with Tests step

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
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • 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 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 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
Case 1
show-more.mp4
Case 2
add-stop.mp4
Case 3
pdf.mp4
Case 4
rotate.mp4
Case 5
cancel.mp4
Mobile Web - Chrome
Mobile Web - Safari
Desktop
iOS
Android

@suneox suneox marked this pull request as ready for review September 19, 2023 00:15
@suneox suneox requested a review from a team as a code owner September 19, 2023 00:15
@melvin-bot melvin-bot bot requested review from ntdiary and removed request for a team September 19, 2023 00:16
@melvin-bot
Copy link

melvin-bot bot commented Sep 19, 2023

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

@suneox
Copy link
Contributor Author

suneox commented Sep 20, 2023

Hi @ntdiary have you got any feedback for this PR?

@ntdiary
Copy link
Contributor

ntdiary commented Sep 20, 2023

@suneox, yeah, it seems there are more things than expected, I'm still gathering the usage data for the Button component. 😅

@suneox
Copy link
Contributor Author

suneox commented Sep 20, 2023

I'm still gathering the usage data for the Button component. 😅

Here is a pdf file has password I have tested (PW: 123456)
pdf-password.pdf

@ntdiary
Copy link
Contributor

ntdiary commented Sep 20, 2023

  1. Show more button

    image: image
  2. Add stop button

    image: image
  3. Rotate button

    image: image
  4. Attachment modal Previous / Next / Confirm / Reveal message button

    image: image image
  5. Error page Sign out button

    image: image
  6. Add to group button

    image: image
  7. Split button

    image: image
  8. Hide / Reveal message / OOO remove button

    image: image image
  9. Wallet Make default / ✅ Edit button

    image: image
  10. Cancel button in Confirm modal/popover

    image: image
  11. Number button (only available for mobile, so ignoring it)

    image: image

The "Default" buttons above are what I've found so far, there's no need to rush to make changes, we can decide how to proceed after some discussion. : )

@suneox
Copy link
Contributor Author

suneox commented Sep 20, 2023

Should we apply the alternative solution set shouldUseDefaultHover true in the button and replace all current components using button shouldUseDefaultHover=false exclude this list of above we have found to avoid missing this prop in the next feature

@ntdiary
Copy link
Contributor

ntdiary commented Sep 20, 2023

Hi @shawnborton, these are all the default buttons I could find, you can expand the image word to view them, currently only two places are using the default hover style in production (I marked them with ✅), I think it's fine to apply the default hover style to all of them by changing shouldUseDefaultHover to true, please feel free to let me know if you have any other concerns.

Additionally, since the success and danger styles have higher priority, we don't need to worry about the default hover style overriding them.

@shawnborton
Copy link
Contributor

That sounds good to me, thanks for laying this out so clearly!

@ntdiary
Copy link
Contributor

ntdiary commented Sep 21, 2023

@suneox, so let's first try changing the default value of shouldUseDefaultHover to true, so that it applies to all Button component. Later if we encounter cases where we need to disable shouldUseDefaultHover, we can selectively add it.

@suneox
Copy link
Contributor Author

suneox commented Sep 21, 2023

Hi @ntdiary I have changed shouldUseDefaultHover to true and reverted the change before

@ntdiary
Copy link
Contributor

ntdiary commented Sep 21, 2023

image

@suneox, let's clean them up. : )

@ntdiary
Copy link
Contributor

ntdiary commented Sep 21, 2023

image

@suneox, we need to merge main into this branch to resolve the conflicts, and then push it.

@suneox
Copy link
Contributor Author

suneox commented Sep 21, 2023

@ntdiary I have cleanup redundant props and merged the main into the current branch, next time I'll be careful before pushing :)

@ntdiary
Copy link
Contributor

ntdiary commented Sep 22, 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 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 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 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
27627-web.mp4
Mobile Web - Chrome
27627-mobile-chrome.mp4
Mobile Web - Safari
27627-mobile-safari.mp4
Desktop
27627-desktop.mp4
iOS
27627-mobile-ios.mp4
Android
27627-mobile-android.mp4

@ntdiary
Copy link
Contributor

ntdiary commented Sep 22, 2023

This is a tiny UI PR that just enables the hover background-color for "Default" buttons, and it does not affect mobile platforms or any of the success or danger buttons, which has already been verified on the production Cancel button, so I think it's fine for the author to only upload web screenshots. However, I've also uploaded all platforms to ensure there won't be anything unexpected. : )

@ntdiary
Copy link
Contributor

ntdiary commented Sep 22, 2023

By the way, @suneox, I recommend you split the test steps into several cases:

Note: The hover feature is only supported on web and desktop app.
case1:

  1. Login with any account.
  2. Click FAB and select Manual request.
  3. Lill any value and select any member.
  4. Verify "Show more" button has a different background color when hovering.

case2:

  1. Login with any account.
  2. Click FAB and select Distance request.
  3. Verify "Add stop" button has a different background color when hovering.

case3:

  1. Login with any account.
  2. Go to any chat channel, send an attachment has password and multiple images
  3. Click the pdf message to open the Attachment modal
  4. Click enter the password
  5. Verify Confirm / Previous / Next buttons have a different background color when hovering.

case4:

  1. Login with any account.
  2. Go to Profile setting.
  3. Click Avatar and then upload a photo.
  4. Verify "Rotate" button on the Edit photo page has a different background color when hovering.

case5:

  1. Login with any account and open any chat.
  2. Create a request money message.
  3. Right click on this message and select Delete message.
  4. Verify the Cancel button on the Confirm modal has a different background color when hovering.

@melvin-bot melvin-bot bot requested a review from joelbettner September 22, 2023 04:21
@suneox
Copy link
Contributor Author

suneox commented Sep 22, 2023

@ntdiary thank you so much for detail feedback I'll update QA steps clearly and capture on other platforms today

@suneox
Copy link
Contributor Author

suneox commented Sep 22, 2023

I have updated the details based on the feedback above

@joelbettner joelbettner merged commit d0d16fb into Expensify:main Sep 25, 2023
14 checks passed
@OSBotify
Copy link
Contributor

✋ 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
Copy link
Contributor

🚀 Deployed to staging by https://github.com/joelbettner in version: 1.3.74-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.74-3 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 failure ❌
🕸 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.

5 participants