Skip to content

Improve native top spacing for bottom docked modals when keyboard shows#63970

Merged
Gonals merged 16 commits into
Expensify:mainfrom
software-mansion-labs:update-mobile-test-drive-for-better-scroll
Jul 7, 2025
Merged

Improve native top spacing for bottom docked modals when keyboard shows#63970
Gonals merged 16 commits into
Expensify:mainfrom
software-mansion-labs:update-mobile-test-drive-for-better-scroll

Conversation

@jmusial

@jmusial jmusial commented Jun 11, 2025

Copy link
Copy Markdown
Contributor

Explanation of Change

This PR fixes 3 things for Feature Training bottom docked modals that overflow the screen when keyboard is shown :

  1. On native: adds space on top.
  2. On safari ios: fixes the overscroll issue described here Fix test drive modal not moving when keyboard openes #62799 (comment)
  3. On mobile chrome: adds scrolling to the modal (was not working before)

Fixed Issues

$ #63569

PROPOSAL:
N/A

Tests

  1. Log in with a new Gmail account.
  2. Tap Skip on work email page.
  3. Select Track and budget expenses.
  4. Enter name > Continue.
  5. On "Take us for a test drive" modal, tap on the email field.
  6. Verify the email field is visible after the keyboard is opened.
  7. Verify that the modal is scrollable w/o sideeffects if it's bigger than remaining screen
  8. Verify that the top bar is not covered by modal

Offline tests

Same as tests

QA Steps

Same as tests

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 verified there are no new alerts related to the canBeMissing param for useOnyx
  • 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
andorid_native.mov
Android: mWeb Chrome
android_chrome.mov
iOS: Native
ios_native.mp4
iOS: mWeb Safari
ios_safari.mp4
MacOS: Chrome / Safari
desktop_chrome.mov
MacOS: Desktop
desktop_native.mov

@blazejkustra blazejkustra left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM! I know it wasn't easy to fix on all platforms and it looks impressive, GJ 🚀

@jmusial jmusial marked this pull request as ready for review June 12, 2025 09:24
@jmusial jmusial requested review from a team as code owners June 12, 2025 09:24
@melvin-bot melvin-bot Bot requested review from dominictb and removed request for a team June 12, 2025 09:24
@melvin-bot

melvin-bot Bot commented Jun 12, 2025

Copy link
Copy Markdown

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

@jmusial

jmusial commented Jun 12, 2025

Copy link
Copy Markdown
Contributor Author

hey @shawnborton please take a look at the videos and let me know if that looks ok ?

@shawnborton

Copy link
Copy Markdown
Contributor

That feels pretty good to me! The only thing I wonder, is if we should have the modal scrolled all the way to the bottom so that you can see both buttons when the input is focused? Basically like this:
CleanShot 2025-06-12 at 20 49 52@2x

cc @Expensify/design for their opinions too!

@dannymcclain

Copy link
Copy Markdown
Contributor

The only thing I wonder, is if we should have the modal scrolled all the way to the bottom so that you can see both buttons when the input is focused?

Yeah I like that idea. But otherwise looking pretty good to me too.

@dubielzyk-expensify

Copy link
Copy Markdown
Contributor

+1 to what Shawn is suggesting 👍 The illustration is less important than the input field and button when the keyboard is active.

@jmusial

jmusial commented Jun 16, 2025

Copy link
Copy Markdown
Contributor Author

@shawnborton, ok managed to do that. 1 problem is that on native IOS the slide animation is "2 phased". Is that ok ?

IOS native
slide_ios_native.mp4
IOS safari
slide_ios_safari.mp4

Android web works same as IOS safari, and for Android native this behaviour is a default.

@dannymcclain

Copy link
Copy Markdown
Contributor

Hmm, the iOS native version looks pretty stutter-y, but I think the Safari one is looking pretty good.

@shawnborton

Copy link
Copy Markdown
Contributor

Oof yeah that does not feel great on iOS - how can we adjust that? I wouldn't feel comfortable shipping that personally.

@jmusial

jmusial commented Jun 17, 2025

Copy link
Copy Markdown
Contributor Author

Ok I think I managed to unify the behaviour across platforms

IOS native
ios_native.mp4
IOS safari
ios_safari.mp4
Android native
android_native.mov
Android chrome
android_chrome.mov

@shawnborton

Copy link
Copy Markdown
Contributor

Better, though admittedly it does still feel a bit choppy... not sure if we can do much to keep smoothening it out?

@jmusial

jmusial commented Jun 17, 2025

Copy link
Copy Markdown
Contributor Author

@shawnborton the choppiness may be the emulator + dev build. Can we trigger ad hoc builds for the PR and check then ?

@shawnborton

Copy link
Copy Markdown
Contributor

Sure, I'll fire them up now.

@github-actions

Copy link
Copy Markdown
Contributor

🚧 @shawnborton has triggered a test Expensify/App build. You can view the workflow run here.

@github-actions

Copy link
Copy Markdown
Contributor

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪
Built from App PR #63970.

Android 🤖 iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/63970/index.html https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/63970/index.html
Android iOS
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/63970/NewExpensify.dmg https://63970.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

@shawnborton

Copy link
Copy Markdown
Contributor

It does feel smoother on a real device:
https://github.com/user-attachments/assets/336e359f-9993-4635-8013-b121a5f3c717

But I found a few things... we are missing SafeSpace below the buttons in the modal, notice how close the homebar is to the buttons:
CleanShot 2025-06-17 at 15 08 38@2x

And as you can see from my video above, it's kinda impossible to tap outside of the modal to dismiss it. You have to tap another area in the modal to unfocus the input, which maybe isn't so bad, but not quite what I expected.

@dannymcclain

Copy link
Copy Markdown
Contributor

I think the transition is feeling much better.

And as you can see from my video above, it's kinda impossible to tap outside of the modal to dismiss it.

The only thing I can really think to do about this is to add an X in the top right corner? Any other ideas? Is it something you think we need to address? Also, if you click "Skip", does the modal go away? If so, we probably don't need to do anything about it.

@shawnborton

Copy link
Copy Markdown
Contributor

Any other ideas?

Ah, I mean I mostly just want to be able to tap the area by the top status bar for the modal to dismiss. Tapping that area above the modal doesn't make it close, and I think it should make it close.

@dannymcclain

Copy link
Copy Markdown
Contributor

OH! I understand now. Yeah I agree with that.

@dominictb

dominictb commented Jun 17, 2025

Copy link
Copy Markdown
Contributor

it's kinda impossible to tap outside of the modal to dismiss it. You have to tap another area in the modal to unfocus the input, which maybe isn't so bad, but not quite what I expected

I also experienced this.

@jmusial

jmusial commented Jun 26, 2025

Copy link
Copy Markdown
Contributor Author

updated the margins on input

IOS native
modal.ios.native.mp4
IOS safari
modal.ios.safari.mp4
Android native
modal.android.native.mov
Android chrome
modal.andorid.chrome.mov

@jmusial jmusial requested a review from dominictb June 30, 2025 08:09
@dominictb

dominictb commented Jun 30, 2025

Copy link
Copy Markdown
Contributor

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 that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
  • I verified tests pass on all platforms & I tested again on:
    • Android: HybridApp
    • Android: mWeb Chrome
    • iOS: HybridApp
    • 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 there are no new alerts related to the canBeMissing param for useOnyx
  • 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: HybridApp
Screen.Recording.2025-06-30.at.19.05.38-compressed.mov
Android: mWeb Chrome
Screen.Recording.2025-06-30.at.19.07.10-compressed.mov
iOS: HybridApp
Screen.Recording.2025-06-30.at.17.58.13-compressed.mov
iOS: mWeb Safari
Screen.Recording.2025-07-02.at.17.52.22-compressed.mov
MacOS: Chrome / Safari
Screen.Recording.2025-06-30.at.19.08.44.mov
MacOS: Desktop
Screen.Recording.2025-06-30.at.19.08.16-compressed.mov

@dominictb

Copy link
Copy Markdown
Contributor

BUG: On mWeb Safari, modal is filled with blank space at the bottom when I scroll up:

Screen.Recording.2025-06-30.at.18.00.19.mov

@jmusial

jmusial commented Jun 30, 2025

Copy link
Copy Markdown
Contributor Author

@dominictb yeah, this is what I mentioned for IOS safari couple comments up. Bug described better here.

On current main it is the same with 1 difference. On main it always triggers full screen scroll, on this branch when user scrolls up the scroll stays within the modal. I know it's not ideal but TBH nit sure if it's fixable (happy to take input on how to do it if you have any ideas).

justifyContent: 'center',
overflow: 'hidden',
boxShadow: theme.shadow,
...(isMobileSafari() ? {maxHeight: `${windowDimensions.windowHeight}px`} : {}),

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Each of these platform-specific change should have an explanative comment

Comment thread src/styles/utils/index.ts

const paddingBottom = getCombinedSpacing(styles.pb5.paddingBottom, safeAreaPaddingBottom, true);
return {
style: isMobileChrome()

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Same here

@dominictb

Copy link
Copy Markdown
Contributor

Also please merge main.

@dubielzyk-expensify

Copy link
Copy Markdown
Contributor

updated the margins on input

Looks good to me! Thanks for fixing @jmusial

@jmusial

jmusial commented Jul 4, 2025

Copy link
Copy Markdown
Contributor Author

@dominictb done and done

@dominictb dominictb left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM :shipit:

@melvin-bot

melvin-bot Bot commented Jul 7, 2025

Copy link
Copy Markdown

We did not find an internal engineer to review this PR, trying to assign a random engineer to #63569 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

@melvin-bot melvin-bot Bot requested a review from Gonals July 7, 2025 09:59
@Gonals

Gonals commented Jul 7, 2025

Copy link
Copy Markdown
Contributor

LGTM!

@Gonals Gonals merged commit c25272c into Expensify:main Jul 7, 2025
19 checks passed
@OSBotify

OSBotify commented Jul 7, 2025

Copy link
Copy Markdown
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.

@github-actions

github-actions Bot commented Jul 8, 2025

Copy link
Copy Markdown
Contributor

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

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

@github-actions

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 9.1.78-4 🚀

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

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.

8 participants