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

Changed default visibility for caret - ListItemRightCaretWithLabel #51225

Merged
merged 6 commits into from
Oct 24, 2024

Conversation

ChavdaSachin
Copy link
Contributor

@ChavdaSachin ChavdaSachin commented Oct 22, 2024

Details

  • Changed default visibility for caret - ListItemRightCaretWithLabel
  • Fixed header styles to adjust with new change

Fixed Issues

$ #51053
PROPOSAL: #51053 (comment)

Tests

Same as QA tests

  • Verify that no errors appear in the JS console

Offline tests

Same as QA tests.

QA Steps

Prerequisite : A workspace with Distance Rates, Categories, Tags, Taxes, Report Fields.(Enable from More Features)

  1. Navigate to settings > workspaces.
  2. Open Distance Rates
  3. Verify '>' is not visible for list item
  4. Verify header text aligns with list item elements(ie. status aligns with enable/disable....).
  5. Select a few items - verify header text aligns with list item elements(ie. status aligns with enable/disable....).
  6. Repeat step 2-5 for Categories, Tags, Taxes, Report Fields.
  • 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-10-22.at.1.52.09.PM.mov
Android: mWeb Chrome
Screen.Recording.2024-10-22.at.1.55.08.PM.mov
iOS: Native

Uploading Screen Recording 2024-10-22 at 2.08.17 PM.mov…

iOS: mWeb Safari
Screen.Recording.2024-10-22.at.2.02.34.PM.mov
MacOS: Chrome / Safari
Screen.Recording.2024-10-22.at.1.41.53.PM.mov
MacOS: Desktop
Screen.Recording.2024-10-22.at.1.45.18.PM.mov

@ChavdaSachin ChavdaSachin requested a review from a team as a code owner October 22, 2024 07:32
@melvin-bot melvin-bot bot requested a review from fedirjh October 22, 2024 07:32
Copy link

melvin-bot bot commented Oct 22, 2024

@fedirjh 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 removed the request for review from a team October 22, 2024 07:32
@ChavdaSachin
Copy link
Contributor Author

Adding videos in a while

@shawnborton
Copy link
Contributor

Going to run a test build for us.

Copy link
Contributor

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖 iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/51225/index.html ❌ FAILED ❌
Android The QR code can't be generated, because the iOS build failed
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/51225/NewExpensify.dmg https://51225.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

@shawnborton
Copy link
Contributor

Can't seem to login with the test build but the screenshots above look good to me from a design perspective, cc @Expensify/design

@trjExpensify
Copy link
Contributor

trjExpensify commented Oct 22, 2024

Can't seem to login with the test build but the screenshots above look good to me from a design perspective,

Out of curiosity, what error you hitting? Is it infinite skeletons? (Context)

@shawnborton
Copy link
Contributor

Nope, getting the bug page where you can either refresh or sign out.

@ChavdaSachin
Copy link
Contributor Author

ChavdaSachin commented Oct 22, 2024

Hey @shawnborton while working on this issue, I noticed IOUStepCategoriesPage and IOUStepTagsPage has major visual and functional inconsistencies, do you think it needs improvement?

Screen.Recording.2024-10-22.at.4.25.55.PM.mov

@shawnborton
Copy link
Contributor

Hmm I don't see what you are talking about, maybe you can bring this up in the open source channel for discussion though!

@ChavdaSachin
Copy link
Contributor Author

ChavdaSachin commented Oct 22, 2024

I am not yet invited to slack channel, but NVM.
In fact if you cant see that clearly means it is alright.

@dannymcclain
Copy link
Contributor

Screenshots/video is looking pretty good to me too. Nice.

@fedirjh
Copy link
Contributor

fedirjh commented Oct 23, 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 Screenshot 2024-10-23 at 1 55 13 PM Screenshot 2024-10-23 at 1 55 29 PM Screenshot 2024-10-23 at 1 55 36 PM Screenshot 2024-10-23 at 1 55 43 PM Screenshot 2024-10-23 at 1 55 49 PM
Android: mWeb Chrome Screenshot 2024-10-23 at 1 58 10 PM Screenshot 2024-10-23 at 1 58 15 PM Screenshot 2024-10-23 at 1 58 19 PM Screenshot 2024-10-23 at 1 58 27 PM Screenshot 2024-10-23 at 1 58 31 PM
iOS: Native

Screenshot 2024-10-23 at 1 15 33 PM

Screenshot 2024-10-23 at 1 15 55 PM

Screenshot 2024-10-23 at 1 16 04 PM

Screenshot 2024-10-23 at 1 16 10 PM

Screenshot 2024-10-23 at 1 17 06 PM

iOS: mWeb Safari

Screenshot 2024-10-23 at 1 42 56 PM

Screenshot 2024-10-23 at 1 43 17 PM

Screenshot 2024-10-23 at 1 43 27 PM

Screenshot 2024-10-23 at 1 43 31 PM

Screenshot 2024-10-23 at 1 43 37 PM

MacOS: Chrome / Safari Screenshot 2024-10-23 at 1 39 37 PM Screenshot 2024-10-23 at 1 39 48 PM Screenshot 2024-10-23 at 1 40 03 PM Screenshot 2024-10-23 at 1 40 07 PM Screenshot 2024-10-23 at 1 40 24 PM
MacOS: Desktop Screenshot 2024-10-23 at 1 46 39 PM Screenshot 2024-10-23 at 1 46 46 PM Screenshot 2024-10-23 at 1 46 49 PM Screenshot 2024-10-23 at 1 46 51 PM Screenshot 2024-10-23 at 1 46 53 PM

@ChavdaSachin
Copy link
Contributor Author

Created new component and adjusted style accordingly.

Copy link
Contributor

@fedirjh fedirjh left a comment

Choose a reason for hiding this comment

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

LGTM . cc @Expensify/design

@melvin-bot melvin-bot bot requested a review from dangrous October 23, 2024 15:02
@shawnborton
Copy link
Contributor

The screenshots and styles look good to me. But I don't quite understand why we had to write a totally new component CustomListHeader to accomplish this? Can someone help me understand that part?

I would think this should be as simple as just removing the caret icon from these table styles.

@ChavdaSachin
Copy link
Contributor Author

ChavdaSachin commented Oct 23, 2024

I would think this should be as simple as just removing the caret icon from these table styles.

yes @shawnborton, that was the first thought. But after removing caret I did realize that header was mis-aligned since we used to take caret space into account for header.
So we had to make changes to header. And later exact same code was used too many times so, @fedirjh suggested to create a new component instead.

Example Screenshot 2024-10-24 at 12 45 53 AM

@shawnborton
Copy link
Contributor

Got it, will let @dangrous weigh on on the technical aspects then :)

@dangrous
Copy link
Contributor

Yeah I think it makes sense to create a new component, even though that wasn't the original plan. If we make edits now, they'll all be in one place.

This is looking good to me - one question, did we / can we double check that we're passing shouldShowCaret=true anywhere where we still need it? The only one I noticed was maybe WorkspaceViewTagsPage - but wanted to make sure we gave it another look. Code itself seems perfect!

@shawnborton
Copy link
Contributor

I don't think we want any carets anywhere on table rows anymore in case that's helpful for your question.

@dangrous
Copy link
Contributor

oh, then I think we're good!

@dangrous dangrous merged commit 4ef00ef into Expensify:main Oct 24, 2024
17 checks passed
Copy link

melvin-bot bot commented Oct 24, 2024

Congrats, that’s your 5th PR merged! 🎉 Do you know about the ContributorPlus role? It’s an opportunity to earn more in the Expensify Open Source community. Keep up the great work - thanks!

Copy link

melvin-bot bot commented Oct 24, 2024

@dangrous looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

@melvin-bot melvin-bot bot added the Emergency label Oct 24, 2024
@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.

Copy link
Contributor

🚀 Deployed to staging by https://github.com/dangrous in version: 9.0.54-0 🚀

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

Copy link
Contributor

🚀 Deployed to production by https://github.com/Beamanator in version: 9.0.54-11 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 failure ❌
🍎 iOS 🍎 failure ❌
🕸 web 🕸 success ✅
🤖🔄 android HybridApp 🤖🔄 skipped 🚫
🍎🔄 iOS HybridApp 🍎🔄 skipped 🚫

Copy link
Contributor

🚀 Deployed to production by https://github.com/Beamanator in version: 9.0.54-11 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 failure ❌
🕸 web 🕸 success ✅
🤖🔄 android HybridApp 🤖🔄 skipped 🚫
🍎🔄 iOS HybridApp 🍎🔄 skipped 🚫

@rushatgabhane
Copy link
Member

rushatgabhane commented Nov 26, 2024

coming from #51457

this pr missed a case to update the label

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

Successfully merging this pull request may close these issues.

8 participants