-
Notifications
You must be signed in to change notification settings - Fork 2.9k
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: Allow adding newlines in description for tasks #19377
Conversation
@youssef-lr @sobitneupane One of you needs to 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] |
@sobitneupane There appears to be a couple of bugs with the way the autogrow TextInput control is implemented. The
Are these known issues? If not, shall I report them on Slack? |
@akinwale I don't think we would expect you to solve those issues if they are pre-existing and will only be re-surfaced by your PR. cc: @youssef-lr |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cursor is expected at the end of already input text.
Screen.Recording.2023-05-22.at.20.30.35.mov
User cannot save description with newline. It might be a backend issue. @akinwale Can you please look around the code and confirm it is not a front end issue. |
@akinwale Instead of trimming the description, we should continue description from the next line. Screen.Recording.2023-05-23.at.18.46.57.mov |
@sobitneupane This would require modifying the App/src/components/MenuItem.js Lines 159 to 166 in b424edc
Update: #19377 (comment) |
I ended up adding a prop called
|
@sobitneupane Yeah, this is done. Please check the latest commit. |
Since we have made the text input multiline, I think we should make the Description text multiline. But the lower section of the report is scrollable. So, we should either make the whole report scrollable including Task Title and Task Description or fix the height of Description and make just the Description scrollable. Screen.Recording.2023-05-24.at.12.03.34.mov@youssef-lr What is your opinion on this? |
@akinwale #19377 (comment) |
@sobitneupane Sorry, I misunderstood. I thought you were referring to the multiline description here. Not being able to save descriptions containing newlines is a backend issue. I've confirmed this as descriptions without newlines are saved just fine. I was planning to submit a bug report for this after this PR gets merged. |
@youssef-lr User cannot save description with newline. Probably it is a backend issue. Screen.Recording.2023-05-24.at.12.08.38.mov |
@sobitneupane I think the intended design here is for the header to be fixed, while the report below is scrollable. You can also observe the same behaviour with the Will wait for @youssef-lr's thoughts on this. |
@sobitneupane I think you could also start a discussion on Slack about this so that we can have an idea on the design and close this soon. |
@youssef-lr Bump on #19377 (comment) and #19377 (comment) |
@akinwale Sounds good. Can you please start a discussion on #expensify-open-source? |
Thanks @thienlnam. @akinwale Can you please resolve the conflict and let me know. If everything goes well, let's get it merged today. |
@sobitneupane Will do. Also, @tjferriss raised a point about merging this issue with one for the money request header here because they are very similar. Do you want to clarify if it's ok to move forward with this? |
Commented on the issue |
@sobitneupane Clarified here so we can move forward with this PR as is. I have fixed the merge conflicts so I'll just wait for the final review. Thanks. |
@akinwale Android app crashes on opening task report with multiline description. Please make sure to retest PR on all platform after making any major update and please do update the screenshots in PR body as well. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Screenshots/Videos
Mobile Web - Chrome
Screen.Recording.2023-06-06.at.14.37.28.mov
Mobile Web - Safari
Screen.Recording.2023-06-06.at.14.43.18.mov
Desktop
Screen.Recording.2023-06-06.at.14.59.00.mov
iOS
Screen.Recording.2023-06-06.at.14.46.14.mov
Android
Screen.Recording.2023-06-06.at.14.49.25.mov
@sobitneupane I have made the necessary changes and retested on all platforms. Everything works fine now. I have also updated the videos for all platforms in the first post. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As suggested by @thienlnam in slack, we will leave the preview of task description as it is (i.e., single line) and will make the change only on task description input.
src/components/MenuItem.js
Outdated
@@ -79,7 +79,6 @@ const MenuItem = (props) => { | |||
props.icon ? styles.ml3 : undefined, | |||
props.shouldShowBasicTitle ? undefined : styles.textStrong, | |||
props.interactive && props.disabled ? {...styles.disabledText, ...styles.userSelectNone} : undefined, | |||
styles.pre, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@akinwale Looks like you have forgotten to undo the change here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@sobitneupane Oops. Fixed. Thanks.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changes look good and tests well.
Screen.Recording.2023-06-08.at.17.11.17.mov
There was a problem hiding this 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 verified the steps for local testing are in the
- 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 notonIconClick
). - 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
- 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.
- 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 usingAvatar
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. foronClick={this.submit}
the methodthis.submit
should be bound tothis
in the constructor) - Any internal methods bound to
this
are necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);
ifthis.submit
is never passed to a component event handler likeonClick
) - 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 thatAvatar
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 theTest
steps. - I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
🚀 Deployed to staging by https://github.com/youssef-lr in version: 1.3.28-0 🚀
|
const length = props.task.report.description.length; | ||
setSelection({start: length, end: length}); | ||
} | ||
}, [props.task.report]); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should have been a custom hook maybe. We try to follow the DRY principle.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just saw these comments, sorry. Yeah, this would probably work but I'll be removing it anyway due to the React Native iOS bug with the selection prop.
@@ -48,6 +48,17 @@ function TaskDescriptionPage(props) { | |||
|
|||
const inputRef = useRef(null); | |||
|
|||
// Same as NewtaskDescriptionPage, use the selection to place the cursor correctly if there is prior text |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Who knows what this page might use in the future or if it will continue to exist at all. Referencing it here does not add anything.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added this comment to provide some additional context since they were all task-related and the files were modified in the same commit.
// Same as NewtaskDescriptionPage, use the selection to place the cursor correctly if there is prior text | ||
const [selection, setSelection] = useState({start: 0, end: 0}); | ||
|
||
// eslint-disable-next-line rulesdir/prefer-early-return |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why disabled?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didn't think doing an early return here made much sense. It would've been 3 additional lines of code if (!condition) { return; }
which don't really add anything.
🚀 Deployed to production by https://github.com/AndrewGable in version: 1.3.28-5 🚀
|
Details
Make the text input controls for the task descriptions support multiline input and autogrow.
Fixed Issues
$ #19135
PROPOSAL: #19135 (comment)
Tests
Offline tests
N/A
QA Steps
Same as tests.
PR Author Checklist
### Fixed Issues
section aboveTests
sectionOffline steps
sectionQA steps
sectiontoggleReport
and notonIconClick
)myBool && <MyComponent />
.src/languages/*
files and using the translation methodWaiting for Copy
label for a copy review on the original GH to get the correct copy.STYLE.md
) were followedAvatar
, I verified the components usingAvatar
are working as expected)/** comment above it */
this
properly so there are no scoping issues (i.e. foronClick={this.submit}
the methodthis.submit
should be bound tothis
in the constructor)this
are necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);
ifthis.submit
is never passed to a component event handler likeonClick
)StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
)Avatar
is modified, I verified thatAvatar
is working as expected in all cases)ScrollView
component to make it scrollable when more elements are added to the page.main
branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTest
steps.Screenshots/Videos
Web
19135-web.mp4
Mobile Web - Chrome
19135-android-chrome.webm
Mobile Web - Safari
19135-ios-safari.mp4
Desktop
19135-desktop.mp4
iOS
19135-ios-native.mp4
Android
19135-android-native.webm