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 the toggle button text style #40950

Merged
merged 10 commits into from
May 14, 2024
Merged

Conversation

hayata-suenaga
Copy link
Contributor

@hayata-suenaga hayata-suenaga commented Apr 25, 2024

Details

@shawnborton realized that the text style next to the toggle button is wrong on Categories and Tags settings screens. This PR fixes the style.

This PR also changes the word spend in the UI copy to expenses

Screenshot 2024-04-24 at 9 10 43 PM Screenshot 2024-04-24 at 9 12 14 PM Screenshot 2024-04-24 at 9 11 35 PM Screenshot 2024-04-24 at 9 11 45 PM Screenshot 2024-04-24 at 9 26 28 PM Screenshot 2024-04-24 at 9 26 34 PM Screenshot 2024-04-24 at 9 27 00 PM Screenshot 2024-04-24 at 9 26 57 PM

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/387834
PROPOSAL: N/A

Tests / QA Steps

  1. Go to the workspace settings page
  2. Go to Categories page and click Settings button
  3. Check the text next to the toggle button. Refer to the screenshots above.

1 Go to the workspace settings page
2 Go to Tags page and click Settings button
3 Verify that the text next to the toggle button is not muted.

Offline tests

N/A

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
    Tested on the Chrome browser. Please see the screenshots in the PR description
  • 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
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

@hayata-suenaga hayata-suenaga self-assigned this Apr 25, 2024
@hayata-suenaga hayata-suenaga requested a review from a team as a code owner April 25, 2024 01:24
@melvin-bot melvin-bot bot removed the request for review from a team April 25, 2024 01:24
Copy link

melvin-bot bot commented Apr 25, 2024

@rojiphil 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 rojiphil April 25, 2024 01:24
@hayata-suenaga hayata-suenaga changed the title Fix the toggle button text Fix the toggle button text style Apr 25, 2024
@rojiphil
Copy link
Contributor

rojiphil commented Apr 25, 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
40950-android-native.mp4
Android: mWeb Chrome
40950-mweb-chrome.mp4
iOS: Native
40950-ios-native.mp4
iOS: mWeb Safari
40950-mweb-safari.mp4
MacOS: Chrome / Safari
40950-web-safari.mp4
MacOS: Desktop
40950-desktop.mp4

Copy link
Contributor

@rojiphil rojiphil left a comment

Choose a reason for hiding this comment

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

@hayata-suenaga I think we missed fixing the muted text for Tags settings. Did we?

@hayata-suenaga
Copy link
Contributor Author

@hayata-suenaga I think we missed fixing the muted text for Tags settings. Did we?
forgot to push the last commit. now it's up to date 😓

Copy link
Contributor

@rojiphil rojiphil left a comment

Choose a reason for hiding this comment

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

@hayata-suenaga Few small updates in PR author checklist for your consideration:

  1. The linked issue does not seem to be correct.
  2. It would be good to add a test case for tags settings too. Something like this:
    Steps:
    1 Go to the workspace settings page
    2 Go to Tags page and click Settings button
    3 Verify that the text next to the toggle button is not muted.

Otherwise LGTM. And tests well too.

@melvin-bot melvin-bot bot requested a review from nkuoch April 25, 2024 17:12
Copy link

melvin-bot bot commented Apr 25, 2024

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

Copy link

melvin-bot bot commented Apr 25, 2024

🎯 @rojiphil, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #41004.

@hayata-suenaga
Copy link
Contributor Author

hayata-suenaga commented Apr 25, 2024

@rojiphil thank you for the review 🙇

The linked issue does not seem to be correct.

The linked issue is actually correct, I just didn't link the specific comment that is relevant to this PR 🙇

It would be good to add a test case for tags settings too. Something like this:
Steps:
1 Go to the workspace settings page
2 Go to Tags page and click Settings button
3 Verify that the text next to the toggle button is not muted.

good idea! I added these to the test steps 😄

nkuoch
nkuoch previously approved these changes Apr 26, 2024
@rojiphil
Copy link
Contributor

@hayata-suenaga There are conflicts in the branch

@hayata-suenaga
Copy link
Contributor Author

I think the issue was fixed on the main branch. @rojiphil could you check if the issues have been fixed? 🙇

@rojiphil
Copy link
Contributor

I think the issue was fixed on the main branch. @rojiphil could you check if the issues have been fixed? 🙇

@hayata-suenaga I think the issue is not fixed completely yet.

Two observations as seen in the attached test video

  1. The text still shows muted for Tags settings.
  2. The text is bold for Categories settings. Do you think this is intentional?
40950-inconsistency.mp4

@hayata-suenaga
Copy link
Contributor Author

The text is bold for Categories settings. Do you think this is intentional?

I don't believe that is intentional. @shawnborton for double confirmation.

@shawnborton, the text next to the button shouldn't be bold like the one below, right?

Screenshot 2024-04-29 at 8 24 36 PM

@shawnborton
Copy link
Contributor

Correct, that text should not be bold and should just be our regular weight font at 15px size (normal size).

@nkuoch
Copy link
Contributor

nkuoch commented Apr 30, 2024

🤔
image

@hayata-suenaga
Copy link
Contributor Author

🤔

There was a change that uses different component for toggle. So after merging made my changes obsolete.

so I'm working on achieving the same thing with the changed component

@hayata-suenaga
Copy link
Contributor Author

Does this look okay @shawnborton ?

Screenshot 2024-05-01 at 4 04 06 PM
Screenshot 2024-05-01 at 4 07 54 PM

@hayata-suenaga
Copy link
Contributor Author

hayata-suenaga commented May 1, 2024

@rojiphil we're also updating the UI text from spend -> expenses

confirming translation -> https://expensify.slack.com/archives/C21FRDWCV/p1714605765597709

@shawnborton
Copy link
Contributor

Looks pretty good! For this screenshot:
image

How far away is the hint text from the stuff above? Is that a global component we're using? In Figma, I think we have the hint text at 4px below the label + toggle:
CleanShot 2024-05-01 at 20 44 53@2x

CleanShot 2024-05-01 at 20 44 58@2x

Copy link
Contributor

@rojiphil rojiphil left a comment

Choose a reason for hiding this comment

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

@hayata-suenaga The changes look good on Categories settings.
But we missed bringing the earlier changes to Tags settings as the text is still muted.
Also, I think we should change spend to expenses in tags just like in categories.

40950-web-safari-001.mp4

@shawnborton
Copy link
Contributor

But we missed bringing the earlier changes to Tags settings as the text is still muted.

Good catch, let's fix that!

@rojiphil
Copy link
Contributor

rojiphil commented May 7, 2024

@hayata-suenaga Gentle bump on the fix here

@hayata-suenaga hayata-suenaga changed the title Fix the toggle button text style [HOLD until May 10th] Fix the toggle button text style May 8, 2024
@hayata-suenaga hayata-suenaga changed the title [HOLD until May 10th] Fix the toggle button text style Fix the toggle button text style May 10, 2024
@hayata-suenaga
Copy link
Contributor Author

hayata-suenaga commented May 11, 2024

@shawnborton, sorry for the late response for your question here

Screenshot 2024-05-10 at 7 43 08 PM

The distance between the Switch component and subtext is 16px in the current PR as shown in the above screenshot. This is because I'm using the same component and configuration as those used in the Advanced Connection configuration screen, as shown below.

Screenshot 2024-05-10 at 7 41 36 PM

The distance between the Switch and the subtexts on the Advanced Configuration screen is 2px? on Figma. But as seen in the above screenshot, it's actually 16px in the production app.

Which one should I use, 16px or 2px? Should we use the same distance or should we use different values for these different contexts?

Screenshot 2024-05-10 at 8 02 47 PM

If my explanation is unclear, please feel free to ask any questions. 🙇

@shawnborton
Copy link
Contributor

It should actually be 4px in Figma:
CleanShot 2024-05-12 at 22 25 26@2x

And ideally we can make it 4px in product too. I recently worked on this same thing with @teneeto over here: #40718

@hayata-suenaga
Copy link
Contributor Author

hayata-suenaga commented May 13, 2024

@shawnborton, thank you for your confirmation 😄 I adjusted my PR accordingly. Could you check the screenshots below when you have time? 🙇

Before (16px between the Switch and the subtext)

Screenshot 2024-05-13 at 7 49 55 AM

After (4px)

Screenshot 2024-05-13 at 7 49 31 AM

Screenshot 2024-05-13 at 8 16 48 AM

@shawnborton
Copy link
Contributor

Looks good to me, thanks!

@hayata-suenaga
Copy link
Contributor Author

@rojiphil, could you do the final check and approve the PR is everything looks good? 😄

Copy link
Contributor

@rojiphil rojiphil left a comment

Choose a reason for hiding this comment

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

Looks super good to merge. And tests well too. I have updated the checklist with the latest test videos. Thanks.

Copy link

melvin-bot bot commented May 14, 2024

@lakchote 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 lakchote May 14, 2024 04:14
@hayata-suenaga hayata-suenaga merged commit 229027a into main May 14, 2024
17 checks passed
@hayata-suenaga hayata-suenaga deleted the hayata-fix-toggle-text-style branch May 14, 2024 05:36
@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/hayata-suenaga in version: 1.4.74-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.4.74-6 🚀

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.

5 participants