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

Viewport jumping up #16443

Merged
merged 17 commits into from
Apr 21, 2023
Merged

Conversation

gedu
Copy link
Contributor

@gedu gedu commented Mar 23, 2023

Details

Added a new prop to ScreenWrapper which lets you ignore the change added in this ticket. This new prop will make the component use 100% height. So on screens that you don't want the components get moved up by the Keyboard in this case you will have to set lockHeight to true

Fixed Issues

$ #15270
PROPOSAL: #15270 (comment)

Tests

  1. Open Send Money or Request Money screen
  2. Click on the Currency Sign
  3. The Keybard should open (if not open it clicking on the input)
  4. Close it, and when going back the NumericPad should be in place
  5. Going to the last screen the confirm button should avoid the keyboard
  • Verify that no errors appear in the JS console

Offline tests

  1. Open Send Money or Request Money screen
  2. Click on the Currency Sign
  3. The Keybard should open (if not open it clicking on the input)
  4. Close it, and when going back the NumericPad should be in place
  5. Going to the last screen the confirm button should avoid the keyboard

QA Steps

  1. Open Send Money or Request Money screen
  2. Click on the Currency Sign
  3. The Keybard should open (if not open it clicking on the input)
  4. Close it, and when going back the NumericPad should be in place
  5. Going to the last screen the confirm button should avoid the keyboard
  • 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 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 correct English and 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 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
noJumpingChrome.mp4
noJumpingSafari.mp4
Mobile Web - Chrome
noJumpingChromeMobile.mp4
Mobile Web - Safari
noJumpingSafariMobile.mp4
Desktop
noJumpingDesktop.mp4
iOS
noJumpingIphone.mp4
Android
noJumpingAndroid.mp4

@gedu gedu requested a review from a team as a code owner March 23, 2023 12:11
@melvin-bot melvin-bot bot requested review from hayata-suenaga and thesahindia and removed request for a team March 23, 2023 12:11
@MelvinBot
Copy link

@hayata-suenaga @thesahindia 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]

ArekChr
ArekChr previously approved these changes Mar 23, 2023
@hayata-suenaga
Copy link
Contributor

hayata-suenaga commented Mar 23, 2023

@gedu thank you for the quick PR. I was wondering if the original issue is the IOU amount page specific. as we discussed before, this jumping issue might exist on other screens, too.

@gedu
Copy link
Contributor Author

gedu commented Mar 23, 2023

@gedu thank you for the quick PR. I was wondering if the original issue is the IOU amount page specific. as we discussed before, this jumping issue might exist on other screens, too.

@hayata-suenaga
The issue is not specific to IOUXXX; it arises from the ScreenWrapper component listening to height changes and updating the maxHeight. Therefore, any screen that utilizes this component will have the "keyboard avoiding" feature turned on by default. Additionally, on iOS, there is a slight delay in the height change event, which causes the component to jump. In the example you linked we could lockHeight, and given the screen has a scroll view all will work, and because is using 100% height the next screen should look ok, I can give it a try later.

@hayata-suenaga
Copy link
Contributor

@gedu thank you for the detailed explanation. I think we can find and fix all places where this issue is observed.

@gedu
Copy link
Contributor Author

gedu commented Mar 24, 2023

@gedu thank you for the detailed explanation. I think we can find and fix all places where this issue is observed.

@hayata-suenaga do you mean in this PR or on follow-up PRs?

@hayata-suenaga
Copy link
Contributor

@gedu I believe we should handle all similar issues in your PRs as the root cause is the same among them.

@gedu
Copy link
Contributor Author

gedu commented Mar 27, 2023

@gedu I believe we should handle all similar issues in your PRs as the root cause is the same among them.

@hayata-suenaga I went through the app and found 2 places that I think make sense to add this new flag, Report List, and Profile screen, I'm adding videos so you can see the before and after

Before

LHN_before.mp4

After

LHN_after.mp4

Before

Profile_before.mp4

After

Profile_after.mp4

hayata-suenaga
hayata-suenaga previously approved these changes Mar 27, 2023
Copy link
Contributor

@hayata-suenaga hayata-suenaga left a comment

Choose a reason for hiding this comment

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

LGTM! @thesahindia could you also review this one, please?

@gedu
Copy link
Contributor Author

gedu commented Mar 28, 2023

@hayata-suenaga I was looking at some edit comment issues and saw this behavior, I think we should apply this fix to the ReportScreen

Before

Report_before.mp4

After

Report_after.mp4

# Conflicts:
#	src/pages/home/ReportScreen.js
@thesahindia
Copy link
Member

Didn't get enough time today to review this PR. It's EOD for me. I will get to this in the morning.

@hayata-suenaga
Copy link
Contributor

@gedu good catch!

@gedu
Copy link
Contributor Author

gedu commented Mar 31, 2023

@hayata-suenaga is all ok? is something that I can help with?

@hayata-suenaga
Copy link
Contributor

@gedu could you check this comment?

@gedu
Copy link
Contributor Author

gedu commented Mar 31, 2023

@hayata-suenaga replied

@gedu
Copy link
Contributor Author

gedu commented Apr 5, 2023

Received the list of which screens the button should avoid the keyboard. Working on them

@hayata-suenaga
Copy link
Contributor

@gedu please ping @thesahindia and me when you're ready for the review again 🙂

# Conflicts:
#	src/pages/iou/MoneyRequestModal.js
@gedu
Copy link
Contributor Author

gedu commented Apr 17, 2023

Fixed the conflicts, the comment and fixed MoneyRequestDescriptionPage so the save button moves up

@hayata-suenaga @thesahindia

@@ -44,6 +48,7 @@ const defaultProps = {
onEntryTransitionEnd: () => {},
modal: {},
keyboardAvoidingViewBehavior: 'padding',
shouldEnableMaxHeight: !DeviceCapabilities.canUseTouchScreen(),
Copy link
Member

Choose a reason for hiding this comment

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

@gedu, why aren't we using false here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Because the issue was reported mainly on web mobile, so I wanna leave the behavior for web as is just in case, but I think it can be false, should I change it?

Copy link
Member

Choose a reason for hiding this comment

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

Yes. We should use false.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated

@thesahindia
Copy link
Member

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 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
Screen.Recording.2023-04-18.at.2.22.47.AM.mov
Mobile Web - Chrome
Screen.Recording.2023-04-18.at.12.57.46.AM.mov
Mobile Web - Safari
Screen.Recording.2023-04-18.at.12.43.55.AM.mov
Desktop
Screen.Recording.2023-04-18.at.1.01.21.AM.mov
iOS Screenshot 2023-04-18 at 12 51 14 AM
Android
Screen.Recording.2023-04-18.at.12.58.54.AM.mov

@thesahindia
Copy link
Member

Looks good. Will approve once #16443 (comment) gets resolved.

Copy link
Contributor

@hayata-suenaga hayata-suenaga left a comment

Choose a reason for hiding this comment

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

It's probably discussed previously, but could you remind me again why we're not using enabled prop of KeyboardAvoidingView and instead setting maxHeight?

@thesahindia
Copy link
Member

It's probably discussed previously, but could you remind me again why we're not using enabled prop of KeyboardAvoidingView and instead setting maxHeight?

I believe it doesn't work on ios safari (tested just now), I think that's why we used maxHeight.

Copy link
Member

@thesahindia thesahindia left a comment

Choose a reason for hiding this comment

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

Looks good and works well!

All yours @hayata-suenaga

@hayata-suenaga
Copy link
Contributor

It's probably discussed previously, but could you remind me again why we're not using enabled prop of KeyboardAvoidingView and instead setting maxHeight?

for a moment, I completely forgot the purpose of this PR. please never mind the above question.

Copy link
Contributor

@hayata-suenaga hayata-suenaga left a comment

Choose a reason for hiding this comment

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

LGTM

NAB: just a question

does anybody know why we're not using flex: 1 and instead using maxHeight on KeyboardAvodingView?

@MelvinBot
Copy link

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!

@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.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.3.4-0 🚀

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

@s77rt
Copy link
Contributor

s77rt commented Apr 24, 2023

Hey, looks the PR didn't fix all the instances of the view port jump behaviour on the request money page, we got another report here #17866

@@ -109,7 +111,7 @@ class ScreenWrapper extends React.Component {
paddingStyle,
]}
>
<KeyboardAvoidingView style={[styles.w100, styles.h100, {maxHeight: this.props.windowHeight}]} behavior={this.props.keyboardAvoidingViewBehavior}>
<KeyboardAvoidingView style={[styles.w100, styles.h100, {maxHeight}]} behavior={this.props.keyboardAvoidingViewBehavior}>
Copy link
Member

Choose a reason for hiding this comment

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

No inline styles cc: @thesahindia

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.4-0 🚀

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

@hayata-suenaga
Copy link
Contributor

Hey, looks the PR didn't fix all the instances of the view port jump behaviour on the request money page, we got another report here #17866

The linked issue seems to be a little bit different from the original issue (button jumps to the bottom vs. keyboard jumps to the top). @gedu @thesahindia could one of you check if this is a regression caused from this PR?

@Christinadobrzyn
Copy link
Contributor

nudging @thesahindia and @gedu about ^ regression question so we can determine if we should move forward with this job as a separate fix. Thanks!

@thesahindia
Copy link
Member

Ahh sorry, I forgot to comment here. Actually I wasn't able to repro the issue and I don't think it is a regression from this PR.

@thesahindia
Copy link
Member

The purpose of this PR was fixing the jump issue on ios safari.

@s77rt
Copy link
Contributor

s77rt commented Jul 25, 2023

We didn't handle all the pages that needs the shouldEnableMaxHeight prop e.g. NewContactMethodPage (Coming from #22661).

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.