Skip to content

Fix For Spacing Around Toggle Buttons - #39031

Merged
tylerkaraszewski merged 10 commits into
Expensify:mainfrom
brandonhenry:38370-fix-spacing-issues-for-switch-toggles
Apr 8, 2024
Merged

tylerkaraszewski merged 10 commits into
Expensify:mainfrom
brandonhenry:38370-fix-spacing-issues-for-switch-toggles

Conversation

@brandonhenry

@brandonhenry brandonhenry commented Mar 27, 2024 •

Copy link
Copy Markdown
Contributor

Details

Fixed Issues

$ #38370
PROPOSAL: #38370 (comment)

Tests

  1. Open app and switch the language to spanish
  2. Go to any "collect" workspace
  3. Click categories >settings
  • Verify that no errors appear in the JS console

Offline tests

  1. Open the Expensify app and switch the language to Spanish.
  2. Navigate to any "collect" workspace.
  3. Click on the categories option and then select settings.
  4. Disable the internet connection on the device.
  5. Repeat steps 1-6 for all supported platforms:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • Verify that no errors appear in the JS console
  • Verify that the app displays the appropriate offline message or placeholder UI.
  • Verify that the UI elements are properly aligned and the design meets the requirements.

QA Steps

  1. Open the Expensify app and switch the language to Spanish.
  2. Navigate to any "collect" workspace.
  3. Click on the categories option and then select settings.
  4. Repeat steps 1-3 for all supported platforms:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • Verify that no errors appear in the JS console
  • Verify that the UI elements are properly aligned and the design meets the requirements.

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 image
Android: mWeb Chrome image
iOS: Native image
iOS: mWeb Safari image
MacOS: Chrome / Safari image
MacOS: Desktop image

Video

Screen.Recording.2024-03-29.at.9.29.48.AM.mov
Screen.Recording.2024-03-29.at.9.27.13.AM.mov

@brandonhenry

Copy link
Copy Markdown
Contributor Author

might be an easier change than I thought, testing @parasharrajat

Comment thread src/components/Switch.tsx Resolved

@parasharrajat parasharrajat left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

If all this sounds like a lot of change. I will suggest we go back to basics and make only the necessary changes to each place as the proposal.

Comment thread src/components/Switch.tsx Resolved
Comment thread src/components/Switch.tsx Resolved
Comment thread src/components/Text.tsx Resolved
Comment thread src/components/Text.tsx Resolved
@parasharrajat

Copy link
Copy Markdown
Member

@brandonhenry let's please speed up the work here. This is not a big issue to hold for long. We would like it to be closed asap.

@parasharrajat

Copy link
Copy Markdown
Member

Please remove [38370] from the title.

@parasharrajat parasharrajat left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

  • Add test, QA steps etc.
  • Complete the checklist.
  • Attach video of final solution.

@brandonhenry brandonhenry changed the title [38370] Fix For Spacing Around Toggle Buttons Fix For Spacing Around Toggle Buttons Mar 29, 2024
@brandonhenry
brandonhenry marked this pull request as ready for review March 29, 2024 13:17
@brandonhenry
brandonhenry requested a review from a team as a code owner March 29, 2024 13:17
@melvin-bot
melvin-bot Bot removed the request for review from a team March 29, 2024 13:18
@melvin-bot

melvin-bot Bot commented Mar 29, 2024

Copy link
Copy Markdown

@parasharrajat 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 parasharrajat March 29, 2024 13:18
@brandonhenry

Copy link
Copy Markdown
Contributor Author

@parasharrajat i agree, felt like too much refactor for something small. going with my original proposal

@parasharrajat

parasharrajat commented Mar 29, 2024 •

Copy link
Copy Markdown
Member

@brandonhenry QA tests and Offline tests all are mandatory.

@parasharrajat

Copy link
Copy Markdown
Member

@brandonhenry we need screenshots on all platforms. Can you please update those? Also, I don't think your solution worked on ios Native.
Screenshot 2024-03-30 at 12 17 31 AM

@brandonhenry

Copy link
Copy Markdown
Contributor Author

for sure. recent main pull in has broken my ios/android build so resolving

@brandonhenry

Copy link
Copy Markdown
Contributor Author

update: got my android building. looks like i had to remove the old build from the simulator first due to some odd error

@brandonhenry

brandonhenry commented Mar 30, 2024 •

Copy link
Copy Markdown
Contributor Author

@parasharrajat adjusted fix. We need to also include flexShrink to complete fix for react native as well. This article explains why in depth.

Let me know if you have any concerns. Getting updated screens now

@parasharrajat

Copy link
Copy Markdown
Member

@brandonhenry I am still waiting on other things. Please ping me once done.

@parasharrajat parasharrajat left a comment •

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Please remove QA steps 7,8 & 9. Also, add screenshot/video for all platforms. Can we please wrap this up today?

@brandonhenry

Copy link
Copy Markdown
Contributor Author

yeah sure. all done just trying to fix my ios build errors for the last two screens @parasharrajat

@brandonhenry

Copy link
Copy Markdown
Contributor Author

@parasharrajat i have completed all tests and added all necessary screenshots. back over to you

@parasharrajat

Copy link
Copy Markdown
Member

Screenshots

🔲 iOS / native

Screen.Recording.2024-03-30.at.8.00.32.PM.mov

🔲 iOS / Safari

Screen.Recording.2024-03-30.at.8.04.12.PM.mov

🔲 MacOS / Desktop

Screen.Recording.2024-03-30.at.8.06.04.PM.mov

🔲 MacOS / Chrome

Screen.Recording.2024-03-30.at.7.59.22.PM.mov

🔲 Android / Chrome

Screen.Recording.2024-03-30.at.8.07.43.PM.mov

🔲 Android / native

Screen.Recording.2024-03-30.at.8.13.19.PM.mov

@parasharrajat parasharrajat left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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 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(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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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.

🎀 👀 🎀 C+ reviewed

@melvin-bot
melvin-bot Bot requested a review from tylerkaraszewski March 31, 2024 05:59
@parasharrajat

Copy link
Copy Markdown
Member

@tylerkaraszewski Ready for review.

@parasharrajat

Copy link
Copy Markdown
Member

Bump @tylerkaraszewski

@tylerkaraszewski

Copy link
Copy Markdown
Contributor

Looks like the linter is failing here. Can you fix that?

@parasharrajat

Copy link
Copy Markdown
Member

@brandonhenry could you please run prettier npm script?

@brandonhenry

Copy link
Copy Markdown
Contributor Author

this is all good @tylerkaraszewski @parasharrajat

@melvin-bot
melvin-bot Bot requested a review from tylerkaraszewski April 3, 2024 19:58
@parasharrajat

Copy link
Copy Markdown
Member

@tylerkaraszewski Ready for merge.

@brandonhenry

Copy link
Copy Markdown
Contributor Author

@tylerkaraszewski let me know if you can get to this one today, thanks!

@brandonhenry

Copy link
Copy Markdown
Contributor Author

@tylerkaraszewski any updates? Would like to get this merged ASAP

@tylerkaraszewski
tylerkaraszewski merged commit 9a2945d into Expensify:main Apr 8, 2024
@brandonhenry
brandonhenry deleted the 38370-fix-spacing-issues-for-switch-toggles branch April 9, 2024 14:33
@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/tylerkaraszewski in version: 1.4.62-0 🚀

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

1 similar comment
@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/tylerkaraszewski in version: 1.4.62-0 🚀

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

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/tylerkaraszewski in version: 1.4.62-0 🚀

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

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.62-17 🚀

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.

4 participants