Enable keyboard avoiding view in search modal by bernhardoj · Pull Request #57458 · Expensify/App

bernhardoj · 2025-02-26T08:59:22Z

Explanation of Change

Fixed Issues

$ #56342
PROPOSAL: #56342 (comment)

Tests

Same as QA Steps

Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

Prerequisite: Have between 7 and 9 chats available in the account.

Press the search icon on the top right corner.
Open the keyboard if it´s not displayed yet.
Verify you can scroll the list

No keyboard on Web/Desktop

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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 used JaimeGPT to get English > Spanish translation. I then posted it 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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.ts 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 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(theme.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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
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.
I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
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.

Screenshots/Videos

Android: Native

android.mp4

Android: mWeb Chrome

android.mweb.mp4

iOS: Native

ios.mp4

iOS: mWeb Safari

ios.mweb.mp4

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2025-02-26T08:59:28Z

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

…eyboard-opened

eh2077 · 2025-02-26T09:15:37Z

@DylanDylann Sorry for the ping. I'll review this PR. Thank you

eh2077 · 2025-02-26T11:09:22Z

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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.ts 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(theme.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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
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.
For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
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

Android: Native

Screen.Recording.2025-02-26.at.9.07.53.PM.mov

Android: mWeb Chrome

Screen.Recording.2025-02-26.at.8.10.54.PM.mov

iOS: Native

Screen.Recording.2025-02-26.at.9.10.55.PM.mov

iOS: mWeb Safari

Screen.Recording.2025-03-03.at.9.53.32.AM.mov

MacOS: Chrome / Safari

MacOS: Desktop

eh2077 · 2025-02-26T13:07:00Z

@bernhardoj I found that there're two scrollable views on mobile Safari and the inner one is introduced by this PR. Is this expected? Please check below clips to compare with staging

Dev	Staging
Screen.Recording.2025-02-26.at.8.36.16.PM.mov	Screen.Recording.2025-02-26.at.8.37.06.PM.mov

Important

Though scrolling on staging also looks weird - the header isn't fixed. It's out of scope and should be handled separately

…eyboard-opened

bernhardoj · 2025-02-28T04:50:46Z

@eh2077 fixed.

eh2077 · 2025-03-03T01:42:41Z

-            )}
+            <KeyboardAvoidingView
+                behavior="padding"
+                style={[styles.flex1, {maxHeight: windowHeight}]}


Should we only add maxHeight: windowHeight for mobile Safari?

eh2077 · 2025-03-03T01:46:33Z

            ListItem={SearchRouterItem}
            containerStyle={[styles.mh100]}
-            sectionListStyle={[styles.ph2, styles.pb2]}
+            sectionListStyle={[styles.ph2, styles.pb2, styles.overscrollBehaviorContain]}


Should we apply overscrollBehaviorContain only for mobile WebKit? I found a use case here.

App/src/components/ScreenWrapper.tsx

Line 284 in cd92ca9

const isAvoidingViewportScroll = useTackInputFocus(isFocused && shouldEnableMaxHeight && shouldAvoidScrollOnVirtualViewport && isMobileWebKit());

I retested other platforms with different use cases, with few contacts (7-9) or long contact list. I didn't find any inconsistencies, so these comments won't be a blocker. They're just for discussing

I didn't find any issues on other platforms too, so I think we can just leave it, same as maxHeight above.

They probably add it for iOS mWeb only since it's the only platform where the viewport scroll issue happens, but since it doesn't cause any inconsistency on other platforms, I think it's fine to apply it to all. It's actually more consistent if we apply the overscroll style to all platforms instead of only 1 platform.

eh2077

LGTM!

OSBotify · 2025-03-03T13:58:55Z

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

github-actions · 2025-03-03T17:15:12Z

🚀 Deployed to staging by https://github.com/Gonals in version: 9.1.8-0 🚀

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

github-actions · 2025-03-04T21:54:27Z

🚀 Deployed to production by https://github.com/puneetlath in version: 9.1.8-1 🚀

platform	result
🤖 android 🤖	true ❌
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	failure ❌
🍎🔄 iOS HybridApp 🍎🔄	failure ❌

enable keyboard avoiding view in search modal

276731b

bernhardoj requested a review from a team as a code owner February 26, 2025 08:59

melvin-bot Bot requested review from DylanDylann and removed request for a team February 26, 2025 08:59

Merge branch 'main' into fix/56342-can't-scroll-search-results-when-k…

fa57cf3

…eyboard-opened

bernhardoj added 3 commits February 28, 2025 12:19

Merge branch 'main' into fix/56342-can't-scroll-search-results-when-k…

8b04d0b

…eyboard-opened

keyboard avoiding view in mweb safari

52096f5

prevent viewport scrolling

abf96de

eh2077 reviewed Mar 3, 2025

View reviewed changes

eh2077 approved these changes Mar 3, 2025

View reviewed changes

melvin-bot Bot requested a review from Gonals March 3, 2025 12:34

Gonals approved these changes Mar 3, 2025

View reviewed changes

Gonals merged commit 0d67347 into Expensify:main Mar 3, 2025

github-actions Bot mentioned this pull request Mar 3, 2025

Deploy Checklist: New Expensify 2025-03-03 #57683

Closed

42 tasks

melvin-bot Bot mentioned this pull request Mar 4, 2025

[Due for payment 2025-03-11] [$250] Android - Search - Search list can´t be scrolled when keyboard is opened. #56342

Closed

8 tasks

Conversation

bernhardoj commented Feb 26, 2025

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Feb 26, 2025

Uh oh!

eh2077 commented Feb 26, 2025

Uh oh!

eh2077 commented Feb 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

eh2077 commented Feb 26, 2025

Uh oh!

bernhardoj commented Feb 28, 2025

Uh oh!

eh2077 Mar 3, 2025

Choose a reason for hiding this comment

Uh oh!

eh2077 Mar 3, 2025

Choose a reason for hiding this comment

Uh oh!

eh2077 Mar 3, 2025

Choose a reason for hiding this comment

Uh oh!

bernhardoj Mar 3, 2025

Choose a reason for hiding this comment

Uh oh!

eh2077 left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Mar 3, 2025

Uh oh!

github-actions Bot commented Mar 3, 2025

Uh oh!

github-actions Bot commented Mar 4, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

eh2077 commented Feb 26, 2025 •

edited

Loading