Unnecessary blank area is created when scrolling down while keyboard is open #19642 #21298

lukemorawski · 2023-06-22T07:05:40Z

Details

Prevent user from scrolling away the message composer and create an odd blank area while virtual keyboard is open on mobile Safari. This is done be scrolling back to the optimal position.

Screen.Recording.2023-06-06.at.18.02.45.mov

Fixed Issues

$ #19642
PROPOSAL: #19642 (comment)

Tests

Verify that no errors appear in the JS console

Offline tests

QA Steps

Verify that no errors appear in the JS console
Open the app in mobile Safari
Go to Report Page
Tap on message composer component to open the virtual keyboard
Scroll the message thread component down (swipe up) to reveal the hidden space under the viewport
Release the tap (touchend) - the viewport should smoothly scrollback to it's optimal position hiding that unnecessary space
Verify on other mobile and desktop browsers that everything works as expected
Verify on native platforms that everything works as expected

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

Mobile Web - Chrome

Mobile Web - Safari

Screen.Recording.2023-06-06.at.18.02.45.mov

Desktop

iOS

Android

melvin-bot · 2023-06-22T07:05:45Z

@Santhosh-Sellavel 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]

github-actions · 2023-06-22T07:05:57Z

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

lukemorawski · 2023-06-22T08:34:06Z

I have read the CLA Document and I hereby sign the CLA

lukemorawski · 2023-06-22T08:34:50Z

recheck

Santhosh-Sellavel

Please run through the author checklist once again and make sure everything is met, thanks!

src/pages/home/ReportScreen.js

src/components/withBlockViewportScroll/index.js

Santhosh-Sellavel · 2023-06-26T16:40:46Z

Resolve conflicts

Santhosh-Sellavel · 2023-06-28T03:10:50Z

@lukemorawski bump!

lukemorawski · 2023-06-28T09:04:40Z

conflict resolved

lukemorawski · 2023-06-30T14:01:00Z

I'm OOO next two weeks so someone from Callstack will takeover this issue if required.

Santhosh-Sellavel · 2023-06-30T17:50:21Z

@lukemorawski Please tag someone here, so we can follow-up with them if any help is needed, thanks!

Santhosh-Sellavel · 2023-07-02T18:45:54Z

I've played around with the new build. I like the new item, where we keep main the composer in the view by scrolling to it. But it looks glitchy on/off while scrolling to reposition or while the keyboard closes. @thienlnam Can you have a look at play around with build, and let me know your thoughts, thanks!

thienlnam · 2023-07-03T23:57:43Z

I'm running into issues with my simulator not even opening the keyboard 😵‍💫 Going to be out for the 4th, but will check back in later

Santhosh-Sellavel · 2023-07-04T17:14:42Z

@thienlnam Check Toggle Software Keyboard it will make the soft keyboard active. But the moment you start interacting with the app using the hardware keyboard it will disappear again!

Santhosh-Sellavel · 2023-07-07T21:11:51Z

@thienlnam any update?

Also @lukemorawski is OOO can you ask someone else from CallStack to takeover the PR?

thienlnam · 2023-07-11T17:59:00Z

Thanks for the bump, this slipped from my radar - will try to get around to testing this later today

fabioh8010 · 2023-07-13T12:39:23Z

Hi 👋 @lukemorawski is OOO at the moment and we don't have access to his repo, but he'll be back on Monday.

thienlnam · 2023-07-13T18:38:29Z

Finally got around to this, thanks for the tip @Santhosh-Sellavel - it's working on my end now

But it looks glitchy on/off while scrolling to reposition or while the keyboard closes

I do kinda see this but doesn't look too bad IMO
https://github.com/Expensify/App/assets/30609178/04cfb87c-648b-4f6b-ace9-976b41a98aa5

I think this is a general improvement over before, what do you think?

Santhosh-Sellavel · 2023-07-14T18:18:14Z

Okay then let's wait to resolve conflicts and do a final review & testing!

lukemorawski · 2023-07-18T08:51:41Z

Hey all, I'll be resolving the conflicts today.

lukemorawski · 2023-07-18T10:55:59Z

Conflicts resolved

Santhosh-Sellavel · 2023-07-18T23:18:17Z

@lukemorawski Solve lint errors

parasharrajat · 2023-11-16T13:34:53Z

Ok. I also don't think this behavior is a big deal. So We are good.

parasharrajat · 2023-11-16T13:35:10Z

Screenshots

🔲 iOS / native

Screen.Recording.2023-11-16.at.8.01.28.PM.mov

🔲 iOS / Safari

Screen.Recording.2023-11-16.at.7.32.18.PM.mov

🔲 MacOS / Desktop

Screen.Recording.2023-11-16.at.7.43.51.PM.mov

🔲 MacOS / Chrome

Screen.Recording.2023-11-16.at.7.49.52.PM.mov

🔲 Android / Chrome

Screen.Recording.2023-11-16.at.8.03.45.PM.mov

🔲 Android / native

Screen.Recording.2023-11-16.at.8.15.06.PM.mov

parasharrajat · 2023-11-14T13:02:28Z

src/components/SwipeableView/index.native.tsx

-        <View {...panResponder.panHandlers}>{children}</View>
-    );
+    // eslint-disable-next-line react/jsx-props-no-spreading
+    return <View {...panResponder.panHandlers}>{children}</View>;


We should apply the style prop here as well same as web.

great spotting! But this is deliberate :) When the style is added in native it brakes the layout

Ah, It will make this component inconsistent across platforms. May be we can manage the styles in such a way that works across platforms.

Otherwise, Add a comment here to explain why styles are not applied. I would still prefer it be consistent.

left the comment as I don't really have the capacity now to deal with that styling problem. Hopefully that's good enough.

parasharrajat

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.

🎀 👀 🎀 C+ reviewed

parasharrajat · 2023-11-17T11:42:22Z

src/libs/NativeWebKeyboard/index.native.js

these files will have to be created as TS otherwise, checks will fail.

parasharrajat · 2023-11-17T11:43:03Z

@lukemorawski There are some files that will have to be converted to TS.

lukemorawski · 2023-11-17T11:44:49Z

on it!

src/libs/NativeWebKeyboard/index.ts

parasharrajat

LGTM

thienlnam

Awesome, thanks for the work here!

OSBotify · 2023-11-19T16:54:07Z

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

…-blank_area_on_scroll" This reverts commit 0c77cbc, reversing changes made to 4df083c.

Revert #21298

Revert #21298 (cherry picked from commit 179fd21)

OSBotify · 2023-11-22T00:48:57Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.4.1-13 🚀

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

OSBotify · 2023-11-22T01:02:06Z

🚀 Deployed to staging by https://github.com/thienlnam in version: 1.4.2-0 🚀

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

OSBotify · 2023-11-23T16:53:38Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.4.2-3 🚀

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

lukemorawski added 2 commits June 22, 2023 07:47

viewport scroll block on report screen

87737bd

refactored function declaration

9ef0f83

lukemorawski requested a review from a team as a code owner June 22, 2023 07:05

melvin-bot bot requested review from Santhosh-Sellavel and removed request for a team June 22, 2023 07:05

Santhosh-Sellavel suggested changes Jun 22, 2023

View reviewed changes

src/pages/home/ReportScreen.js Outdated Show resolved Hide resolved

src/components/withBlockViewportScroll/index.js Outdated Show resolved Hide resolved

src/components/withBlockViewportScroll/index.js Outdated Show resolved Hide resolved

formatting, const naming and jsdocs

c342cec

Merge branch 'main' into lukemorawski19642-blank_area_on_scroll

6445869

Merge branch 'main' into lukemorawski19642-blank_area_on_scroll

21fb1b4

thienlnam self-requested a review July 18, 2023 18:18

parasharrajat suggested changes Nov 16, 2023

View reviewed changes

added comment to swipeableview style prop

7ed0356

lukemorawski requested a review from parasharrajat November 17, 2023 11:32

parasharrajat approved these changes Nov 17, 2023

View reviewed changes

parasharrajat reviewed Nov 17, 2023

View reviewed changes

src/libs/NativeWebKeyboard/index.native.js Outdated

Copy link

Member

parasharrajat Nov 17, 2023

Choose a reason for hiding this comment

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

these files will have to be created as TS otherwise, checks will fail.

lukemorawski and others added 2 commits November 17, 2023 15:26

refactor/nativewebkeyboard to TS

2a5389a

Merge branch 'main' into lukemorawski19642-blank_area_on_scroll

d94490b

lukemorawski requested a review from parasharrajat November 17, 2023 14:34

parasharrajat reviewed Nov 17, 2023

View reviewed changes

src/libs/NativeWebKeyboard/index.ts Outdated Show resolved Hide resolved

lukemorawski and others added 2 commits November 17, 2023 15:55

added comments to exported functions on NativeWebKeyboard

b704342

Merge branch 'main' into lukemorawski19642-blank_area_on_scroll

8896a4d

parasharrajat approved these changes Nov 17, 2023

View reviewed changes

thienlnam approved these changes Nov 19, 2023

View reviewed changes

thienlnam merged commit 0c77cbc into Expensify:main Nov 19, 2023
16 checks passed

os-botify bot mentioned this pull request Nov 20, 2023

Deploy Checklist: New Expensify 2023-11-20 #31556

Closed

90 tasks

amyevans mentioned this pull request Nov 21, 2023

[HOLD for payment 2023-11-30] mWeb/Safari - Chat - The top part of the UI is enlarged when posting bold text #31580

Closed

6 tasks

amyevans added a commit that referenced this pull request Nov 21, 2023

Revert "Merge pull request #21298 from lukemorawski/lukemorawski19642…

a2a4928

…-blank_area_on_scroll" This reverts commit 0c77cbc, reversing changes made to 4df083c.

amyevans mentioned this pull request Nov 21, 2023

Revert https://github.com/Expensify/App/pull/21298 #31601

Merged

47 tasks

luacmartins added a commit that referenced this pull request Nov 21, 2023

Merge pull request #31601 from Expensify/amy-revert-21298

179fd21

Revert #21298

OSBotify pushed a commit that referenced this pull request Nov 21, 2023

Merge pull request #31601 from Expensify/amy-revert-21298

4a26057

Revert #21298 (cherry picked from commit 179fd21)

github-actions bot mentioned this pull request Nov 22, 2023

Deploy Checklist: New Expensify 2023-11-22 #31667

Closed

62 tasks

0xmiros mentioned this pull request Nov 27, 2023

[HOLD for payment 2024-02-19] [HOLD for #19642][$1000] mWeb - Non-Responsive view in legal name screen #26401

Closed

6 tasks

Unnecessary blank area is created when scrolling down while keyboard is open #19642 #21298

Unnecessary blank area is created when scrolling down while keyboard is open #19642 #21298

Conversation

lukemorawski commented Jun 22, 2023 • edited by github-actions bot Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jun 22, 2023

github-actions bot commented Jun 22, 2023 • edited Loading

lukemorawski commented Jun 22, 2023

lukemorawski commented Jun 22, 2023

Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

Santhosh-Sellavel commented Jun 26, 2023

Santhosh-Sellavel commented Jun 28, 2023

lukemorawski commented Jun 28, 2023

lukemorawski commented Jun 30, 2023

Santhosh-Sellavel commented Jun 30, 2023

Santhosh-Sellavel commented Jul 2, 2023

thienlnam commented Jul 3, 2023

Santhosh-Sellavel commented Jul 4, 2023

Santhosh-Sellavel commented Jul 7, 2023

thienlnam commented Jul 11, 2023

fabioh8010 commented Jul 13, 2023 • edited Loading

thienlnam commented Jul 13, 2023

Santhosh-Sellavel commented Jul 14, 2023

lukemorawski commented Jul 18, 2023

lukemorawski commented Jul 18, 2023

Santhosh-Sellavel commented Jul 18, 2023

parasharrajat commented Nov 16, 2023 • edited Loading

parasharrajat commented Nov 16, 2023 • edited Loading

Screenshots

🔲 iOS / native

🔲 iOS / Safari

🔲 MacOS / Desktop

🔲 MacOS / Chrome

🔲 Android / Chrome

🔲 Android / native

parasharrajat Nov 14, 2023

Choose a reason for hiding this comment

lukemorawski Nov 16, 2023

Choose a reason for hiding this comment

parasharrajat Nov 16, 2023

Choose a reason for hiding this comment

parasharrajat Nov 16, 2023 • edited Loading

Choose a reason for hiding this comment

lukemorawski Nov 17, 2023

Choose a reason for hiding this comment

parasharrajat left a comment

Choose a reason for hiding this comment

Reviewer Checklist

parasharrajat Nov 17, 2023

Choose a reason for hiding this comment

parasharrajat commented Nov 17, 2023

lukemorawski commented Nov 17, 2023

parasharrajat left a comment

Choose a reason for hiding this comment

thienlnam left a comment

Choose a reason for hiding this comment

OSBotify commented Nov 19, 2023

OSBotify commented Nov 22, 2023

OSBotify commented Nov 22, 2023

OSBotify commented Nov 23, 2023

lukemorawski commented Jun 22, 2023 •

edited by github-actions bot

Loading

github-actions bot commented Jun 22, 2023 •

edited

Loading

fabioh8010 commented Jul 13, 2023 •

edited

Loading

parasharrajat commented Nov 16, 2023 •

edited

Loading

parasharrajat commented Nov 16, 2023 •

edited

Loading

parasharrajat Nov 16, 2023 •

edited

Loading