Skip to content

Use reanimated modal in Help modal#65409

Merged
mountiny merged 19 commits intoExpensify:mainfrom
software-mansion-labs:feat/use-reanimated-modal-in-help-modal
Jul 17, 2025
Merged

Use reanimated modal in Help modal#65409
mountiny merged 19 commits intoExpensify:mainfrom
software-mansion-labs:feat/use-reanimated-modal-in-help-modal

Conversation

@jmusial
Copy link
Contributor

@jmusial jmusial commented Jul 3, 2025

Explanation of Change

This PR uses react-native-reanimated based modal for Help Modal and AvatarCrop Modal. Some of the changes in this PR overlap with #65409, due to animation slide in from right.

Fixed Issues

$ #64778

PROPOSAL:

https://expensify.slack.com/archives/C05LX9D6E07/p1750147058498549

Depends on

#65250

Tests

  1. Open the app
  2. Open help modal
  3. Close help modal
  4. Open chat
  5. Click the chat name
  6. Click the avatar
  7. Click "Upload photo"
  8. Select image
  9. Crop image
  10. Click save

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
0030.andoroid.native.mov
Android: mWeb Chrome https://github.com/user-attachments/assets/1b090d09-96a4-4b39-a7fb-bec5af608929
iOS: Native
0030.ios.natie.mp4
iOS: mWeb Safari
0030.ios.safari.mp4
MacOS: Chrome / Safari
0030.desktop.native.mov
MacOS: Desktop
0030.desktop.chrome.mov

@jmusial jmusial changed the title Use reanimated modal in help modal Use reanimated modal in help & AvatarCrop modal Jul 10, 2025
@jmusial jmusial changed the title Use reanimated modal in help & AvatarCrop modal Use reanimated modal in Help & AvatarCrop modal Jul 10, 2025
@jmusial jmusial marked this pull request as ready for review July 11, 2025 11:38
@jmusial jmusial requested a review from a team as a code owner July 11, 2025 11:38
@melvin-bot melvin-bot bot requested review from ZhenjaHorbach and removed request for a team July 11, 2025 11:38
@melvin-bot
Copy link

melvin-bot bot commented Jul 11, 2025

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

@ZhenjaHorbach
Copy link
Contributor

ZhenjaHorbach commented Jul 14, 2025

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
Android: mWeb Chrome
android-web.mov
iOS: HybridApp
ios.mov
iOS: mWeb Safari
ios-web.mov
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov

@jmusial jmusial changed the title Use reanimated modal in Help & AvatarCrop modal Use reanimated modal in Help modal Jul 14, 2025
@jmusial jmusial requested a review from a team as a code owner July 14, 2025 15:49
@shawnborton
Copy link
Contributor

Is it just me or are we getting a double overlay here when the Edit Photo modal comes in?

Starts like this:
CleanShot 2025-07-14 at 12 09 12@2x

Ends like this:
CleanShot 2025-07-14 at 12 08 40@2x

cc @Expensify/design for viz too

@dannymcclain
Copy link
Contributor

Definitely looks like double-overlay there. I don't think I'd expect that for stacked RHPs, only when we show a confirmation dialog on top of an RHP screen (I think).

@shawnborton
Copy link
Contributor

Good shout, I definitely agree with that!

@jmusial
Copy link
Contributor Author

jmusial commented Jul 15, 2025

Hey @shawnborton, @dannymcclain Currently on main we have double overlays as well. This is being addressed in #66132.

@shawnborton
Copy link
Contributor

Sounds good, thanks for confirming.

@ZhenjaHorbach
Copy link
Contributor

@jmusial
Could you fix conflicts ?

Copy link
Contributor

@blazejkustra blazejkustra left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@ZhenjaHorbach
Copy link
Contributor

Found this
On Edit photo modal I can't open Help modal

2025-07-16.15.48.20.mov

@ZhenjaHorbach
Copy link
Contributor

Minor cursor inconsistency
Now the default cursor is used on Edit photo modal background
On staging we have select cursor
(For some reason, the cursor on the video recording is always the default one 😅)

2025-07-16.16.10.43.mov

@mhawryluk
Copy link
Contributor

do want the select pointer when hovering on backdrop? I believe we set it to default in other modal PRs. (and the cursor is default for me on the main branch, not sure why it's different on staging)

@ZhenjaHorbach
Copy link
Contributor

do want the select pointer when hovering on backdrop? I believe we set it to default in other modal PRs. (and the cursor is default for me on the main branch, not sure why it's different on staging)

Hmmmm
Good point
Actually yes
It seems that the default cursor is more preferable 😅

@melvin-bot melvin-bot bot requested a review from mountiny July 17, 2025 12:34
@ZhenjaHorbach
Copy link
Contributor

ZhenjaHorbach commented Jul 17, 2025

LGTM !
And I will create a bug for this
#65409 (comment)

Since it is not related to reanimated modals

@ZhenjaHorbach
Copy link
Contributor

ZhenjaHorbach commented Jul 17, 2025

Damn
We have conflicts
@blazejkustra @mhawryluk
Could you fix it please ?

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

@jmusial conflicts now

@@ -1,5 +1,7 @@
import React, {forwardRef, useCallback, useContext, useEffect, useMemo, useRef} from 'react';
import {View} from 'react-native';
// Animated required for side panel navigation
Copy link
Contributor

Choose a reason for hiding this comment

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

Why do we need this? Is there any plan to use something that is not restricted?

Copy link
Contributor

Choose a reason for hiding this comment

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

we use an animated value obtained from navigation to fix the modals being covered by the help modal. unfortunately, react-navigation uses Animated, instead of Reanimated, under the hood, so we cannot escape it here :/

@mountiny mountiny merged commit 86e5505 into Expensify:main Jul 17, 2025
18 checks passed
@github-actions
Copy link
Contributor

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

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

@lanitochka17
Copy link

@jmusial Hi Should the user see the help icon in this build 83-0?
Or can the tester check by running the following command: Onyx.set('nvp_sidePanel', {}) ?

@blazejkustra
Copy link
Contributor

@jmusial Hi Should the user see the help icon in this build 83-0? Or can the tester check by running the following command: Onyx.set('nvp_sidePanel', {}) ?

You have to run Onyx.set('nvp_sidePanel', {}) in the console to see the help button.

@github-actions
Copy link
Contributor

🚀 Deployed to production by https://github.com/cristipaval in version: 9.1.83-5 🚀

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

@mhawryluk mhawryluk deleted the feat/use-reanimated-modal-in-help-modal branch August 25, 2025 08:46
@mhawryluk mhawryluk restored the feat/use-reanimated-modal-in-help-modal branch August 25, 2025 08:47
@mhawryluk mhawryluk deleted the feat/use-reanimated-modal-in-help-modal branch August 26, 2025 08:36
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