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: Center button has no hover and press effect #43452

Conversation

truph01
Copy link
Contributor

@truph01 truph01 commented Jun 11, 2024

Details

Fixed Issues

$ #43058
PROPOSAL: #43058 (comment)

Tests

  1. Open app
  2. Go to FAB > Submit expense > Distance
  3. Hover over "Center" button
  4. Click on the "Center" button
  5. There should be hover and press effect on the button when hovering over and pressing on the button
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native
Screen.Recording.2024-06-13.at.10.41.53.mov
Android: mWeb Chrome
Screen.Recording.2024-06-13.at.10.40.55.mov
iOS: Native
Screen.Recording.2024-06-13.at.10.38.32.mov
iOS: mWeb Safari
Screen.Recording.2024-06-13.at.10.35.52.mov
MacOS: Chrome / Safari - Dark mode:
Screen.Recording.2024-06-13.at.10.26.04.mov
  • Light mode:
Screen.Recording.2024-06-13.at.10.27.19.mov
MacOS: Desktop
Screen.Recording.2024-06-13.at.10.37.15.mov

@truph01 truph01 requested a review from a team as a code owner June 11, 2024 03:08
@melvin-bot melvin-bot bot removed the request for review from a team June 11, 2024 03:08
Copy link

melvin-bot bot commented Jun 11, 2024

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

@melvin-bot melvin-bot bot requested a review from jjcoffee June 11, 2024 03:08
@truph01
Copy link
Contributor Author

truph01 commented Jun 11, 2024

@jjcoffee I asked to confirm the hover and press value in #43058 (comment). Then I will complete the PR author checklist.

@jjcoffee
Copy link
Contributor

jjcoffee commented Jun 12, 2024

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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I 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(theme.componentBG)
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native
android-app-2024-06-13_11.32.28.mp4
Android: mWeb Chrome
android-chrome-2024-06-13_11.28.04.mp4
iOS: Native
ios-app-2024-06-13_11.08.45.mp4
iOS: mWeb Safari
ios-safari-2024-06-13_11.10.00.mp4
MacOS: Chrome / Safari
desktop-chrome-2024-06-13_10.54.53.mp4
MacOS: Desktop
desktop-app-2024-06-13_10.56.33.mp4

@jjcoffee
Copy link
Contributor

@truph01 Could you add the dimming values that you've used to post the video on the issue to the PR for now, so I can start testing?

@truph01
Copy link
Contributor Author

truph01 commented Jun 12, 2024

@jjcoffee You mean this video #43058 (comment), right? This video uses the hoverDimValue: 1 and is the same as the PR.

@jjcoffee
Copy link
Contributor

@truph01 See this comment for the values to apply.

@truph01
Copy link
Contributor Author

truph01 commented Jun 13, 2024

@jjcoffee I addressed this comment #43452 (comment)

@jjcoffee
Copy link
Contributor

I'm not sure if we want the button to actually be semi-transparent on press. cc @Expensify/design for your thoughts.

image

@shawnborton
Copy link
Contributor

I think the idea here is to just make this button match the same :hover and :press styles of all of our other buttons. There shouldn't really be anything special about this button.

Do all of our buttons have that kind of reduced opacity on press? I have a feeling that could be an artifact of the Pressable component we use. FWIW though, we do have a button-press color var we use in Figma. (Though @Expensify/design looks like our button component does not ship with a "Pressed" state 😱 )

@dannymcclain
Copy link
Contributor

@shawnborton Oh boy. I agree that the states for these icon buttons should match the states of our default buttons. Here's an updated spec sheet for these:
image

(Though @Expensify/design looks like our button component does not ship with a "Pressed" state 😱 )

😬 we can get this updated in Figma easily, though I think the bigger issue is making sure these states are reflected in code. It looks like the pressed state for buttons currently does not reflect that in the product.

So the question is, do we update this button to be correct, or do we leave it using defaults and globally update all our buttons to use the proper pressed state?

@shawnborton
Copy link
Contributor

I say we make this button just match our current global styles, and then we update our global styles to be correct per our Figma guidelines.

@truph01
Copy link
Contributor Author

truph01 commented Jun 13, 2024

@shawnborton What is the global style you mentioned above, is it something like the below (the "Share code" icon and "Emoji" icon):
image

@dannymcclain
Copy link
Contributor

For some reason those buttons don't seem to have any states... I think it would be more like these buttons (which are our standard default buttons):

CleanShot 2024-06-13 at 09 14 54@2x

CleanShot.2024-06-13.at.09.14.30.mp4

@shawnborton
Copy link
Contributor

Yup, agree with Danny's observation there. But oh boy, how many button components do we have in the code 🤣

@truph01
Copy link
Contributor Author

truph01 commented Jun 14, 2024

@shawnborton I updated the PR which uses this suggestion #43452 (comment). Here is the result:

output.mp4

@shawnborton
Copy link
Contributor

Great! Can you confirm what size the icon is displayed at in the button? I think we have a difference between buttons with labels and buttons that are only icons. Buttons that are icon-only use a slightly larger icon size:
image

Whereas buttons with labels are slightly different:
image

(Also huge thanks to Danny for putting those guides together, super helpful!)

@truph01
Copy link
Contributor Author

truph01 commented Jun 14, 2024

@shawnborton Here is the current button size:

image

@shawnborton
Copy link
Contributor

How big is the icon inside of it though?

@truph01
Copy link
Contributor Author

truph01 commented Jun 14, 2024

@shawnborton The icon have size 20*20
image

@shawnborton
Copy link
Contributor

Sweet, I think we're all good then!

@jjcoffee
Copy link
Contributor

I updated the PR which uses this suggestion [#43452 (comment)]

@truph01 Sorry, could you explain what the benefit of switching to the Button component is? I'm a bit concerned that we're starting to use one of the other proposals.

Do all of our buttons have that kind of reduced opacity on press?

@shawnborton I think so yes, but it's usually obscured by the fact that the button sits on top of a flat background element. Do you think it's an issue here?

</PressableWithoutFeedback>
iconFill={theme.icon}
medium
icon={Expensicons.Crosshair}
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we'd want to keep the accessibilityLabel if going down this route.

Copy link
Contributor

Choose a reason for hiding this comment

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

@truph01 Bump on this 🙏

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jjcoffee I updated it

@shawnborton
Copy link
Contributor

Do you think it's an issue here?

I think there is no issue with making this PR use our standard buttons, but our standard buttons ideally would use a different color on press instead of reduced opacity. We can sort that out in a separate issue though.

Sorry, could you explain what the benefit of switching to the Button component is?

This is correct because this is essentially a button. It's just a button with no label and only an icon. And this way we automatically get all of our default button styles.

@truph01
Copy link
Contributor Author

truph01 commented Jun 14, 2024

@jjcoffee

Sorry, could you explain what the benefit of switching to the Button component is? I'm a bit concerned that we're starting to use one of the #43058 (comment) proposals.

Essentially, the Button component is built on PressableWithFeedback. After numerous design changes to the button (this, this and this), I'm choosing to use the Button component because it already includes all the hover and press styles, ensuring consistency with this final decision. With our previous suggested design like this, we cannot use the Button component because it has the fixed hoverDimmingValue.

Copy link
Contributor

@jjcoffee jjcoffee left a comment

Choose a reason for hiding this comment

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

LGTM!

@melvin-bot melvin-bot bot requested a review from marcochavezf June 18, 2024 09:08
Copy link
Contributor

@marcochavezf marcochavezf left a comment

Choose a reason for hiding this comment

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

Thanks guys, the code LGTM!

@marcochavezf marcochavezf merged commit ee436ca into Expensify:main Jun 18, 2024
17 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/marcochavezf in version: 1.4.86-0 🚀

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

1 similar comment
@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/marcochavezf in version: 1.4.86-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/marcochavezf in version: 1.4.86-0 🚀

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

@mountiny
Copy link
Contributor

I think this PR caused this regression deploy blocker #44074

@truph01 can you provide a fix for it?

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/AndrewGable in version: 9.0.0-9 🚀

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.

7 participants