Scroll to the right spot when clicking "Fix Errors" #12954
Conversation
|
Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers! |
melvin-bot
bot
requested review from
danieldoglas and
rushatgabhane
and removed request for
a team
|
@rushatgabhane @danieldoglas 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] |
|
@Gonals oops, looks like we have some lint errors |
src/components/Form.js
Outdated
| @@ -245,6 +246,10 @@ class Form extends React.Component { | |||
| style={[styles.w100, styles.flex1]} | |||
| contentContainerStyle={styles.flexGrow1} | |||
| keyboardShouldPersistTaps="handled" | |||
| ref={el => this.form = el} | |||
| onLayout={(event) => { | |||
| this.inputPosition = event.nativeEvent.layout.y + 1; | |||
There was a problem hiding this comment.
@Gonals why the +1?
suggestion: add a comment for this
There was a problem hiding this comment.
Yep, adding a comment.
Without the +1, we'll scroll right to the border of the component, potentially covering the upper border
There was a problem hiding this comment.
thanks, that makes sense!
|
Checks passing! I'm having trouble testing on Android today, so if you could give it a try there, it'd be awesome! |
src/components/Form.js
Outdated
| @@ -259,6 +266,9 @@ class Form extends React.Component { | |||
| const errors = !_.isEmpty(this.state.errors) ? this.state.errors : this.props.formState.errorFields; | |||
| const focusKey = _.find(_.keys(this.inputRefs), key => _.keys(errors).includes(key)); | |||
| this.inputRefs[focusKey].focus(); | |||
| this.inputRefs[focusKey].measure((fx, fy, width, height, px, py) => { | |||
| this.form.scrollTo({y: py - this.viewPosition, animated: false}); | |||
There was a problem hiding this comment.
@danieldoglas @Gonals I'm not sure how to handle this, but we need an enhancement.
Problem: On mobile, when the keyboard is open we scroll to a position that's hidden under the keyboard.
Solution 1: Always scroll to a position so that the input is just above the keyboard.
Solution 2: Always scroll to a position so that the input is at the very top of screen.
...??
Screen.Recording.2022-11-23.at.9.32.49.PM.mov
There was a problem hiding this comment.
Oh, nice catch! Looking into it
There was a problem hiding this comment.
If it's too complicated to calculate the scroll postion / detect if the keyboard is open, we might need keyboard avoiding view experts on this?
There was a problem hiding this comment.
Ok, I changed things around a little bit and I think it is working more smoothly now!
Quick thing, I see you added a bunch of Name fields for testing. Make sure you give them different inputID, as those are involved when determining where to scroll and might be the reason of the weird behavior you saw
no worries, I'll take care of it |
There was a problem hiding this comment.
Quick thing, I see you added a bunch of Name fields for testing. Make sure you give them different inputID, as those are involved when determining where to scroll and might be the reason of the weird behavior you saw
thanks @Gonals , I'll make sure to use unique ids.
prerequisites:
- increase the page height. This can be done by inserting a bunch of dummy input fields just after name. make sure to use unique ids.
- use iOS and make sure the virtual keyboard is open by pressing
⌘ + K
bug: focused input is behind the keyboard
steps:
- click on zip code
- click on expensify password
- click on
fix the errors - scroll down and click on
fix the errorsagain.
Expected: zip code input is above the keyboard
Actual: zip code input is behind the keyboard
Screen.Recording.2022-11-24.at.2.51.16.PM.mov
|
Ok! The math was becoming a pain, so I completely changed the approach and it seems to be working! Ready for another look! |
|
|
There was a problem hiding this comment.
@Gonals noticed three bugs on Android
- Sometimes the form can't be scrolled on clicking fix errors for expiry date input (
0:10mark in video) - On clicking fix errors, the password input is hidden behind the keyboard (
0:17mark). - Click on password field and the save button is always behind the keyboard (
0:39mark)
WhatsApp.Video.2022-11-29.at.00.34.35.mp4
Hi @rushatgabhane,
|
Oh yeah, you're right! I was mistaken that it should scroll to password.
agree! |
There was a problem hiding this comment.
Reviewer Checklist
@danieldoglas LGTM!
@Gonals fantastic work in changing to a new approach! ✨
- I have verified the author checklist is complete (all boxes are checked off).
- I verified the correct issue is linked in the
### Fixed Issuessection 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
Testssection - I verified the steps for Staging and/or Production testing are in the
QA stepssection - 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:
- iOS / native
- Android / native
- iOS / Safari
- Android / Chrome
- MacOS / Chrome
- 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.
toggleReportand notonIconClick). - 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 was added in all
src/languages/*files - I verified any copy / text that was added to the app is correct English and approved by marketing by adding the
Waiting for Copylabel 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 usingAvatarhave 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
thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor) - Any internal methods bound to
thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis 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 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 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
Avataris modified, I verified thatAvataris 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.
- I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.
Screenshots/Videos
Web
Screen.Recording.2022-12-01.at.1.57.45.AM.mov
Mobile Web - Chrome
Screen.Recording.2022-12-01.at.2.43.37.AM.mov
Mobile Web - Safari
Screen.Recording.2022-12-01.at.2.00.42.AM.mov
Desktop
Screen.Recording.2022-12-01.at.1.58.50.AM.mov
iOS
Screen.Recording.2022-12-01.at.2.45.21.AM.mov
Android
WhatsApp.Video.2022-12-01.at.02.42.59.mp4
|
@danieldoglas All yours! |
|
@danieldoglas bump! |
|
oops, sorry! Looking into this now! |
|
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
|
I think this PR caused this regression (not yet in staging): #13401 If I revert the changes, the spinner is back at the middle of the page. |
|
That's so interesting. really curious to know why it's affecting the spinner for some empty page that's a form child |
| setPosition(element, position) { | ||
| if (!element.props.inputID && element.props.children) { | ||
| _.forEach(element.props.children, (child) => { | ||
| this.setPosition(child, position); | ||
| }); | ||
| } else { | ||
| this.childPosition[element.props.inputID] = position; | ||
| } |
There was a problem hiding this comment.
If element.props.inputID is false, but element.props.children is also falsey, then you will enter in the else which I think is wrong.
There was a problem hiding this comment.
I put some console logs, and it doesn't happen in the debit card form, but in other forms like opening Personal details it does happen:
element.props.inputID is undefined and element.props.children is also undefined
|
Reverting PR here + different fix to achieve the same: #13499 |
|
🚀 Deployed to production by @chiragsalian in version: 1.2.38-6 🚀
|
|
Just FYI that this PR caused this bug. |
Details
Fixed Issues
$ #12942
Tests
Offline tests
Not relevant
QA Steps
Same as Tests
PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectiontoggleReportand notonIconClick)src/languages/*filesWaiting for Copylabel for a copy review on the original GH to get the correct copy.STYLE.md) were followedAvatar, I verified the components usingAvatarare working as expected)/** comment above it */thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor)thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick)StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)Avataris modified, I verified thatAvataris working as expected in all cases)PR Reviewer Checklist
The reviewer will copy/paste it into a new comment and complete it after the author checklist is completed
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectiontoggleReportand notonIconClick).src/languages/*filesWaiting for Copylabel for a copy review on the original GH to get the correct copy.STYLE.md) were followedAvatar, I verified the components usingAvatarhave been tested & I retested again)/** comment above it */thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor)thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick)StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)Avataris modified, I verified thatAvataris working as expected in all cases)Screenshots/Videos
Web
Desktop
iOS
Android