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

feat: add Down Caret to Report Titles #42154

Conversation

kosmydel
Copy link
Contributor

@kosmydel kosmydel commented May 14, 2024

Details

This PR adds Down Carets to the Report Titles.

Fixed Issues

$ #42073
PROPOSAL: N/A

Tests

Verify that the down carets are displayed on the report titles:

  1. Go to #admins room of a workspace
  2. Create a public room #social
  3. Create a group of users (FAB -> Start chat -> Add people -> Start group)
  4. Create an expense report (FAB -> Track expense). Open the receipt preview and verify the down caret is displayed.
  5. Assign a task to a user, open the task. Verify the down caret is displayed.
  6. Verify other types of reports, ensure each report type has the down caret displayed.

Offline tests

N/A

QA Steps

  • Verify that no errors appear in the JS console
  • Do the tests from the above.

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 Screenshot 2024-05-15 at 12 22 52
Android: mWeb Chrome Screenshot 2024-05-15 at 12 04 19
iOS: Native

simulator_screenshot_C6C29A84-B6D0-4514-97BA-95EEDA983026

iOS: mWeb Safari

Simulator Screenshot - iPhone 15 Pro - 2024-05-15 at 12 33 29

MacOS: Chrome / Safari Screenshot 2024-05-15 at 11 59 08 Screenshot 2024-05-15 at 11 59 12 Screenshot 2024-05-15 at 11 59 23
MacOS: Desktop Screenshot 2024-05-15 at 12 00 39

@kosmydel
Copy link
Contributor Author

@Expensify/design

@kosmydel kosmydel marked this pull request as ready for review May 15, 2024 10:47
@kosmydel kosmydel requested a review from a team as a code owner May 15, 2024 10:47
@melvin-bot melvin-bot bot requested review from ikevin127 and removed request for a team May 15, 2024 10:47
Copy link

melvin-bot bot commented May 15, 2024

@ikevin127 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
Contributor

@ikevin127 ikevin127 left a comment

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

@melvin-bot melvin-bot bot requested a review from grgia May 16, 2024 02:38
@grgia grgia added Design and removed Design labels May 16, 2024
@grgia grgia requested a review from a team May 16, 2024 09:08
grgia
grgia previously approved these changes May 16, 2024
Copy link
Contributor

@grgia grgia left a comment

Choose a reason for hiding this comment

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

Code is very clean, nice! I can't recall off the top of my head if any of these components are in storybook, do you think it's worth adding a story for this?

@grgia
Copy link
Contributor

grgia commented May 16, 2024

@Expensify/design could you take a quick pass at the screenshots for this PR?

@grgia
Copy link
Contributor

grgia commented May 16, 2024

triggering a build for design...

Copy link
Contributor

@kosmydel
Copy link
Contributor Author

Code is very clean, nice! I can't recall off the top of my head if any of these components are in storybook, do you think it's worth adding a story for this?

Hmm, I found stories for the Header and HeaderWithBackButton components. But those aren't the components we need.

@shawnborton
Copy link
Contributor

Looking pretty good!

Small thing that might not be related to this PR: the overflow ellipsis uses the same style as the room name, which feels weird when there is a description present which causes the workspace name to be in the top line:
CleanShot 2024-05-16 at 08 26 43@2x

But it's all good when there is no description set:
CleanShot 2024-05-16 at 08 27 51@2x

@kosmydel
Copy link
Contributor Author

Looking pretty good!

Small thing that might not be related to this PR: the overflow ellipsis uses the same style as the room name, which feels weird when there is a description present which causes the workspace name to be in the top line

Yeah, that is out of the scope of this issue.

@dubielzyk-expensify
Copy link
Contributor

Tested on iOS and looks great to me!

@dannymcclain
Copy link
Contributor

Yeah I think this is looking good! Man that little caret is so helpful haha.

the overflow ellipsis uses the same style as the room name, which feels weird when there is a description present which causes the workspace name to be in the top line

This is definitely a bummer, but I understand it's not in scope for this issue. It would be ideal to come up with a separate/follow-up fix for this though, as it looks pretty meh when it happens.

@shawnborton
Copy link
Contributor

Agree!

dannymcclain
dannymcclain previously approved these changes May 17, 2024
Copy link
Contributor

@dannymcclain dannymcclain left a comment

Choose a reason for hiding this comment

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

Approving from a design perspective since I think all the designers have checked it out.

@ikevin127
Copy link
Contributor

Looks like we have some conflicts, awaiting for conflicts to be resolved so this can be merged.

@grgia
Copy link
Contributor

grgia commented May 28, 2024

@kosmydel bump on conflicts, thanks!

@kosmydel kosmydel dismissed stale reviews from dannymcclain and grgia via 60aa7aa May 29, 2024 07:03
@kosmydel
Copy link
Contributor Author

@kosmydel bump on conflicts, thanks!

Done ✅

@ikevin127
Copy link
Contributor

cc @grgia

@kosmydel
Copy link
Contributor Author

kosmydel commented Jun 3, 2024

I've pulled the main and retested it to keep it up-to-date.

@grgia grgia merged commit 19dc29c into Expensify:main Jun 3, 2024
15 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Jun 3, 2024

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

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.

None yet

8 participants