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

Task description scroll #21553

Merged
merged 2 commits into from
Jul 6, 2023
Merged

Conversation

dhairyasenjaliya
Copy link
Contributor

@dhairyasenjaliya dhairyasenjaliya commented Jun 26, 2023

Details

Fixed Issues

$ #21347
PROPOSAL: #21347 (comment)

Tests

  1. Login to ND
  2. Click on + icon and select Assign task option
  3. Enter title and description(with multiple line ~30line)
  4. Click on the Next button
  5. Notice on confirm page the description input should show 2 lines
  • Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

  1. Login to ND
  2. Click on + icon and select Assign task option
  3. Enter title and description(with multiple line ~30line)
  4. Click on the Next button
  5. Notice on confirm page the description input should show 2 lines
  • 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 / Chrome
    • iOS / native
    • iOS / 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 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 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 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(themeColors.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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web Screenshot 2023-07-01 at 1 03 51 AM
Mobile Web - Chrome Screenshot 2023-07-01 at 1 04 09 AM
Mobile Web - Safari Screenshot 2023-07-01 at 1 04 09 AM
Desktop Screenshot 2023-07-01 at 1 03 51 AM 0a-54b540133dc8
iOS
Android

@dhairyasenjaliya dhairyasenjaliya marked this pull request as ready for review June 27, 2023 01:30
@dhairyasenjaliya dhairyasenjaliya requested a review from a team as a code owner June 27, 2023 01:30
@melvin-bot melvin-bot bot requested review from allroundexperts and removed request for a team June 27, 2023 01:30
@melvin-bot
Copy link

melvin-bot bot commented Jun 27, 2023

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

@allroundexperts
Copy link
Contributor

allroundexperts commented Jun 27, 2023

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 / Chrome
    • iOS / native
    • iOS / 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(themeColors.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 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

Web Screenshot 2023-07-01 at 8 08 06 PM
Mobile Web - Chrome Screenshot 2023-07-01 at 8 14 08 PM
Mobile Web - Safari Screenshot 2023-07-01 at 8 12 02 PM
Desktop Screenshot 2023-07-01 at 8 11 05 PM
iOS Screenshot 2023-07-01 at 10 36 49 PM
Android Screenshot 2023-07-01 at 10 55 07 PM

@allroundexperts
Copy link
Contributor

@dhairyasenjaliya Do you know why we are being in-consistent here on native and web? Why are we showing a single line on native contrary to the web?

@dhairyasenjaliya
Copy link
Contributor Author

Not sure but that's the way it was predefined on component across the app @allroundexperts

@allroundexperts
Copy link
Contributor

Not sure but that's the way it was predefined on component across the app @allroundexperts

Can you give an example of another component which has a similar behaviour?

@allroundexperts
Copy link
Contributor

@shawnborton Is this inconsistency expected?

@shawnborton
Copy link
Contributor

Can you elaborate? I'm not sure what you mean.

@allroundexperts
Copy link
Contributor

Can you elaborate? I'm not sure what you mean.

@shawnborton On native platforms we're showing task description in a single line only, while on web, we're showing whole description text. See the images below.
Screenshot 2023-06-27 at 5 28 35 PM
Screenshot 2023-06-27 at 5 28 45 PM

Is this expected? Or should we show a single line on all platforms?

@shawnborton
Copy link
Contributor

I agree we should stay consistent. How about we truncate after 2 lines on all platforms?

Also, is there a reason why these fields don't follow our standard push-to-page patterns? For example, if nothing is added to Assignee or Description, that label text becomes larger and aligns vertically in that row. cc @thienlnam @jasperhuangg any ideas what's going on there?

@allroundexperts
Copy link
Contributor

@dhairyasenjaliya Instead of a scroll view, can you truncate the text so that it gets to 2 lines max?

@dhairyasenjaliya
Copy link
Contributor Author

@allroundexperts sure actually thats i have proposed on solution 2 😅 will add that changes soon

@thienlnam
Copy link
Contributor

@shawnborton

Also, is there a reason why these fields don't follow our standard push-to-page patterns? For example, if nothing is added to Assignee or Description, that label text becomes larger and aligns vertically in that row. cc @thienlnam @jasperhuangg any ideas what's going on there?

I believe that's currently the case where it is vertically aligned in the row - are you saying the label text should be larger here? There was a previous App PR that updated these inputs to use the same component

Screen.Recording.2023-06-27.at.10.19.28.AM.mov

@shawnborton
Copy link
Contributor

When a push row has no value, the label should float vertically and have a font size of 15px which matches our default font size. Then when it does have a value, the label is at 13px and sits above the value:

image

@shawnborton
Copy link
Contributor

In your screenshot, the labels with no value are too small.

@thienlnam
Copy link
Contributor

Created an issue to investigate that here: #21715

@dhairyasenjaliya
Copy link
Contributor Author

@allroundexperts @shawnborton can we confirm max number of line on description so that i can proceed

@allroundexperts
Copy link
Contributor

I agree we should stay consistent. How about we truncate after 2 lines on all platforms?

@dhairyasenjaliya @shawnborton did mention that we want to truncate after 2 lines.

@dhairyasenjaliya
Copy link
Contributor Author

Oh oky sure but for description multi line input i think we are allowing max 5 lines do we think we should add same or just add max 2 lines

@allroundexperts
Copy link
Contributor

Oh oky sure but for description multi line input i think we are allowing max 5 lines do we think we should add same or just add max 2 lines

Let's show two lines as @shawnborton suggested for now and get his review.

@dhairyasenjaliya
Copy link
Contributor Author

Alright mostly today i will add changes

@dhairyasenjaliya
Copy link
Contributor Author

@allroundexperts added changes
Desktop

@allroundexperts
Copy link
Contributor

@allroundexperts added changes Desktop

@shawnborton Can you confirm if this is good enough?

@allroundexperts
Copy link
Contributor

@allroundexperts I did check out that PR mentioned above and found out we are redesigning the Task Detailed View that is showing on LHN, I can see that we are not re-designing the flow of creating the task not sure why this was brought up here but still let's wait for @jasperhuangg

I also think the same @dhairyasenjaliya, but still want to wait for @jasperhuangg to be double sure.

@thienlnam
Copy link
Contributor

Let's move forward with this - those changes are about the task view when created and don't touch the creation flow that this does

@dhairyasenjaliya
Copy link
Contributor Author

dhairyasenjaliya commented Jun 30, 2023

@allroundexperts removed Scroll & added max 2 line to display also steps and screenshot updated

@@ -80,7 +81,7 @@ function MenuItem(props) {
props.shouldShowBasicTitle ? undefined : styles.textStrong,
props.shouldShowHeaderTitle ? styles.textHeadlineH1 : undefined,
props.interactive && props.disabled ? {...styles.disabledText, ...styles.userSelectNone} : undefined,
styles.pre,
styles.preWrap,
Copy link
Contributor

Choose a reason for hiding this comment

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

@dhairyasenjaliya Let's apply preWrap only if props.numberOfLinesTitle is more than 1.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@allroundexperts
Copy link
Contributor

@dhairyasenjaliya In the PR description, can you remove (with web, desktop or m-web since this PR effect only on those)? I think this PR affects all the platforms.

Copy link
Contributor

@allroundexperts allroundexperts 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 cead22 July 1, 2023 18:03
@dhairyasenjaliya
Copy link
Contributor Author

Done

@cead22
Copy link
Contributor

cead22 commented Jul 3, 2023

Code looks good, but there's conflicts -- sorry for delay, but one thing I wanted to ask is if we should set the number of lines to something greater than 2, eg 3 or 4. I think as long as we pick a number that isn't so high that the rest of the UI won't fit (which means the original problem won't be solved), even when the font is set to the highest setting, that should work.

I don't feel that strongly about this, so if you think this is a premature optimization, we can go with 2 for now

@allroundexperts
Copy link
Contributor

@shawnborton What's your opinion on number of lines? Should we increase those to 3 or maybe 4?

@allroundexperts
Copy link
Contributor

@dhairyasenjaliya Please resolve the conflicts.

@conorpendergrast
Copy link
Contributor

Coming from this comment, given this task detailed view redesign, should we continue with this PR?

@allroundexperts
Copy link
Contributor

allroundexperts commented Jul 4, 2023

Coming from this comment, given this task detailed view redesign, should we continue with this PR?

@conorpendergrast I think the same thing is discussed here. The conclusion of the discussion was that we'll need this PR.

@conorpendergrast
Copy link
Contributor

@allroundexperts Excellent, thank you!

@dhairyasenjaliya
Copy link
Contributor Author

@allroundexperts @cead22 conflict resolved

@dhairyasenjaliya
Copy link
Contributor Author

Bump @cead22 @allroundexperts conflicts resolved again are we waiting for some input?

@cead22
Copy link
Contributor

cead22 commented Jul 6, 2023

I agree we should stay consistent. How about we truncate after 2 lines on all platforms?

Sorry, I missed @shawnborton 's original comment on this, so let's go with what we have

@cead22 cead22 merged commit c088821 into Expensify:main Jul 6, 2023
10 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Jul 6, 2023

✋ 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

OSBotify commented Jul 7, 2023

🚀 Deployed to staging by https://github.com/cead22 in version: 1.3.38-0 🚀

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

@ayazhussain79
Copy link
Contributor

@allroundexperts can you please check this is that a regression of this PR, "..." not added when you enter multi line with single word

screen-recording-2023-07-08-at-15234-am_d0pbOiLc.mp4

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.38-7 🚀

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.

9 participants