Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[UX Reliability] Improve the bottom modal animations #55157

Draft
wants to merge 43 commits into
base: main
Choose a base branch
from

Conversation

BartoszGrajdek
Copy link
Contributor

@BartoszGrajdek BartoszGrajdek commented Jan 13, 2025

Explanation of Change

This PR reimplements the library react-native-modal that we've been using for all modals but with react-native-reanimated instead of react-native-animatable inside of it.

We'll gradually switch to the new solution, going through each type of bottom-docked modals. In this PR, we're adding the refactored and changed code and implementing the new solution in components that use PopoverWithMeasuredConent (excluding ButtonWithDropdownMenu since it has quite a few use cases).

Fixed Issues

$
PROPOSAL:

Tests

I think testing of each modal should go like this:

  1. Open the modal.
  2. Close it by clicking the backdrop.
  3. Open the modal.
  4. Close it through the "back" button if it exists on your device.
  5. Open the modal.
  6. Go through each button/option in that modal and verify that everything's functioning properly.

I'll now go through each modal we're going to change in this PR and explain how you can reach it.

EmojiPicker
  1. Open any chat
  2. Click emoji button in the composer

You can also reach it through message reactions like so:

  1. Long press on a message in chat
  2. In the reaction list you should see smiley face with "+" next to it to see more emojis - click it
PopoverReportActionContextMenu
  1. Open any chat
  2. Send a message
  3. Long-press on the message you've sent
BasePopoverReactionList
  1. Open any chat
  2. Send a message
  3. Add a reaction to this message (long-press the message & choose any emoji)
  4. After a reaction is added long-press on the emoji you've reacted with that appeared under the message. A modal containing all reactions should appear
ThreeDotsMenu

There's multiple instances of ThreeDotsMenu around the app i.e.:

  1. Go to settings
  2. Open "Workspaces" section
  3. You should see three dots in the corner of any of your workspace items, after clicking on it the modal should open.
AvatarWithImagePicker

Prerequisite: you need an avatar image, the default Expensify profile pictures don't work

  1. Open settings
  2. Go into "Profile" section
  3. Click on your avatar, this should open the modal
FloatingActionButtonAndPopover
  1. Open the default screen that shows up after opening the app (with chat list)
  2. Click on the green button with "+" sign on it
AttachmentPickerWithMenuItems
  1. Open any chat
  2. Click on the "+" button next to composer - this is the modal
AccountSwitcher
  1. In Settings > Security add a copilot account with full access
  2. Log into that account
  3. At the top of your settings page you should see arrows next to your profile / email, click on it
VideoPopoverMenu
  1. Add a video attachment
  2. In video preview click onto three dots menu
SearchTypeMenuNarrow
  1. Go into the search tab
  2. Click on the search type button at the top of the screen
SecuritySettingsPage
  1. Settings → Security
  2. Add a copilot account
  3. In the list of copilots click on three dot menu of any item
AddPaymentMethodMenu

I didn't manage to get it opened through normal methods, so hard-coded it to appear in this case.

ConnectToNetSuiteFlow

Prerequisite: You need a net suite integration set up first

  1. Go to the settings
  2. Workspace settings > Accounting
  3. Click Net Suite "Connect"
ConnectToSageIntacctFlow

Prerequisite: You need a sage intacct integration set up first

  1. Go to the settings
  2. Workspace settings > Accounting
  3. Click Sage Intacct "Connect"

Offline tests

N/A - nothing should change in this case

QA Steps

Same as in the Tests section

  • 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: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

BartoszGrajdek and others added 29 commits November 6, 2024 11:39
…oszGrajdek/react-native-modal-refactor-Vkuba

# Conflicts:
#	src/pages/home/report/ContextMenu/ContextMenuActions.tsx
…act-native-modal-refactor-Vkuba

adding some types, and do some refactor
…oszGrajdek/react-native-modal-refactor_kuba_v2

# Conflicts:
#	src/components/Search/SearchRouter/SearchRouterModal.tsx
…oszGrajdek/react-native-modal-refactor_kuba_v2

# Conflicts:
#	src/components/Modal/BaseModal.tsx
@bartosz grajdek/react native modal refactor kuba v2
@BartoszGrajdek BartoszGrajdek changed the title @bartosz grajdek/react native modal refactor Bottom Docked Modals Improvements Jan 13, 2025
@BartoszGrajdek BartoszGrajdek changed the title Bottom Docked Modals Improvements [UX Reliability] Improve the bottom modal animations Jan 13, 2025
Copy link
Contributor

@WoLewicki WoLewicki left a comment

Choose a reason for hiding this comment

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

I left some comments, looks good overall!

};

function ModalComponent({type, shouldUseNewModal, ...props}: ModalComponentProps) {
if (type === CONST.MODAL.MODAL_TYPE.BOTTOM_DOCKED && shouldUseNewModal) {
Copy link
Contributor

Choose a reason for hiding this comment

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

If we control all the modals with shouldUseNewModal then is type comparison needed too?

src/components/Modal/BottomDockedModal/Backdrop/index.tsx Outdated Show resolved Hide resolved
src/components/Modal/BottomDockedModal/Backdrop/index.tsx Outdated Show resolved Hide resolved
src/components/Modal/BottomDockedModal/panResponders.ts Outdated Show resolved Hide resolved
src/pages/home/report/ContextMenu/ContextMenuActions.tsx Outdated Show resolved Hide resolved
paddingTop: 0, // adjusting this because the mobile modal adds additional padding that we don't need for our layout
maxHeight: '95%',
},
maxHeight: isSmallScreenWidth ? '100%' : '95%',
Copy link
Contributor

Choose a reason for hiding this comment

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

What is this magic? 🪄 95% seems random

Copy link
Contributor Author

Choose a reason for hiding this comment

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

AFAIK This is a fix to a bug where in EmojiModal after focusing the search input the modal + keyboard took so much space that the user couldn't click the backdrop & exit modal. I still need to look into it though, maybe there's a better solution for this issue

src/components/Modal/BottomDockedModal/Backdrop/index.tsx Outdated Show resolved Hide resolved
src/components/Modal/BottomDockedModal/index.tsx Outdated Show resolved Hide resolved
src/components/Modal/BottomDockedModal/index.tsx Outdated Show resolved Hide resolved
@mountiny
Copy link
Contributor

@BartoszGrajdek I think it would be nice to only migrate one instance of the modal for now so we dont need to have very large pr to revert in case there are some blockers. Lets just do one and ask QA to test it thoroughly in staging and then do the others if we are all good

@BartoszGrajdek
Copy link
Contributor Author

@mountiny sure - makes sense. In that case, I'll make the appropriate changes tomorrow 👀

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.

5 participants