feat: Add logic for better bottom SafeArea handling + Enable translucent Android NavBar

[chrispader]

@mountiny @lakchote

Explanation of Change

MOBILE-EXPENSIFY: https://github.com/Expensify/Mobile-Expensify/pull/13455

Based on the plan laid out in #53186 (comment).

New props

This PR introduces a enableEdgeToEdgeBottomSafeAreaPadding prop to multiple components, that should be removed after all screens have been fully migrated to edge-to-edge bottom safe area handling. There are also some other additional props, that will be kept, since they can be used to enable logic for bottom safe area handling in generic components on per screen/component individually.

This PR introduces the following flags/props to these components:

• ScreenWrapper
  • enableEdgeToEdgeBottomSafeAreaPadding: Temporary; Used to disable includeSafeAreaPaddingBottom logic, render bottomContent only when it's set and apply the bottom padding styles correctly.
  • shouldKeyboardOffsetBottomSafeAreaPadding: Explained below. Passed forward to KeyboardAvoidingView.
• KeyboardAvoidingView
  • shouldOffsetBottomSafeAreaPadding: Can be used to let the KeyboardAvoidingView offset the bottom safe area padding. The KeyboardAvoidingView will basically set keyboardVerticalOffset={-paddingBottom}, to compensate for the bottom safe area, when the keyboard is open.
• Modal
  • enableEdgeToEdgeBottomSafeAreaPadding: This disables (extra) bottom safe area in the Modal. Once all modals have migrated to handling bottom safe area padding locally, we can remove this prop.
• ScrollView
  • addBottomSafeAreaPadding: Used to trigger the useContentContainerStyleWithBottomSafeAreaPadding logic and apply contentContainerStyle with bottom padding on the SectionList
  • contentContainerStyle: contentContainerStyle prop can still be used; if paddingBottom is set, the padding will be added to the one from addBottomSafeAreaPadding.
• SelectionList
  • addBottomSafeAreaPadding: This flag will apply the padding in contentContainerStyle of the nested SectionList, as well as on the FixedFooter component, rather than on the container view.
  • shouldFooterContentStickToBottom: Explained below. Passed forward to FixedFooter
• SectionList
  • addBottomSafeAreaPadding* Same as in ScrollView. Triggers useContentContainerStyleWithBottomSafeAreaPadding
  • contentContainerStyle: Same as in ScrollVIew. contentContainerStyle prop can still be used
• FormProvider (andFormWrapper)
  • addBottomSafeAreaPadding: This flag gets passed forward to ScrollView and enables padding handling there.
  • shouldSubmitButtonStickToBottom: This flag enables logic which moves the SubmitButton component out of the scrollable content and places it sticking at the bottom. This is especially useful on screens that have scrollable content, a submit button at the bottom and an input that triggers the keyboard. When the keyboard opens, we still want to see the submit button, e.g. on the WorkspaceInvitePage.
• FixedFooter
  • addBottomSafeAreaPadding: If set, the fixed footer will add bottom padding for the safe area inset.
  • shouldStickToBottom: Passed down from SelectionList. If set, a the footer will stick to the bottom with padding applied by bottom: paddingBottom + styles.pb5.paddingBottom. This works hand in hand with the addBottomSafeAreaPadding flag.
• Other components with enableEdgeToEdgeBottomSafeAreaPadding prop:
  • InteractiveStepWrapper
  • ConnectionLayout

Props marked bold props will get removed after the migration, as they are just temporary.

useContentContainerStyleWithBottomSafeAreaPadding: This hooks contains logic around merging contentContainerStyle prop (e.g. on ScrollView and SectionList) with additional bottom safe area padding. The style sheet will get flattened and if paddingBottom is already set, it will be added to the bottom safe area padding.

Follow-up PRs

These are the follow-up PRs that use the flags introduced here:

• Modals: Edge-to-edge Bottom Safe Area Padding: Modals #57181
• Workspace screens: Edge-to-edge Bottom Safe Area Padding: Workspace screens #57281

Fixed Issues

$ #53186
PROPOSAL: #53186 (comment)

Tests

• Verify that no errors appear in the JS console

This PR introduces new logic that is not enabled by default. Therefore, there should be no changes in app behaviour.

Offline tests

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

• Verify that no errors appear in the JS console

No QA needed.

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: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

[mountiny]

Unverified commits

[chrispader]

Unverified commits

weird thanks, i'll check that

[github-actions]

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

[lakchote]

LGTM! Thanks @chrispader for your work on this one

[chrispader]

@lakchote @mountiny let me know once we want to merge this, only then i'll merge main again, because we get merge conflicts frequently with so many changes

[mountiny]

Thanks for all the changes

[mountiny]

@chrispader Ping us in slack when this is ready

@hungvu193 could you please do some more testing on this one tomorrow just in case

[github-actions]

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

[github-actions]

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

[mountiny]

Thanks!

[mountiny]

Fortune favours the brave

[melvin-bot]

@mountiny looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

[mountiny]

Not emergency, the eslint failures are from optional changes and this was very large PR already

[github-actions]

🚀 Deployed to staging by https://github.com/mountiny in version: 9.1.13-0 🚀

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

[github-actions]

🚀 Deployed to production by https://github.com/mountiny in version: 9.1.13-5 🚀

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

[ZhenjaHorbach]

Came from this issue
We had an issue when grey navigation bar covers content when keyboard opens in modal window
Fix here