feat: add animation for auto suggestions popup #19933

aswin-s · 2023-06-01T03:27:38Z

Details

This PR add an animation to auto suggestions popup using react-native-reanimated package.

Fixed Issues

$ #18974
PROPOSAL: #18974 (comment)

Tests

Open chat
Try to input a mention by pressing '@'
It should bring up mention suggestions popup
Suggestions popup should have animation when shown
Suggestions popup height should animate when items in the popup gets added or removed
Popup should animate out when input is cleared
Emoji suggestions popup should also behave in the same manner when user tries to enter an emoji by pressing ':'
Verify animation is present in all platforms (iOS, Android, Web, mWeb & Desktop)

Verify that no errors appear in the JS console

Offline tests

QA Steps

Open chat
Try to input a mention by pressing '@'
It should bring up mention suggestions popup
Suggestions popup should have animation when shown
Suggestions popup height should animate when items in the popup gets added or removed
Popup should animate out when input is cleared
Emoji suggestions popup should also behave in the same manner when user tries to enter an emoji by pressing ':'
Verify animation is present in all platforms (iOS, Android, Web, mWeb & Desktop)

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

web.mov

Mobile Web - Chrome

mWeb-Android.webm

Mobile Web - Safari

mWeb-iOS.mp4

Desktop

desktop.mov

iOS

iOS.mp4

Android

android.webm

melvin-bot · 2023-06-01T03:27:43Z

@puneetlath @s77rt One of you needs to 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]

src/components/AutoCompleteSuggestions/BaseAutoCompleteSuggestions.js

s77rt · 2023-06-01T11:04:13Z

src/components/AutoCompleteSuggestions/BaseAutoCompleteSuggestions.js

            ref={props.forwardedRef}
-            style={[styles.autoCompleteSuggestionsContainer, StyleUtils.getAutoCompleteSuggestionContainerStyle(rowHeight, props.shouldIncludeReportRecipientLocalTimeHeight)]}
+            style={animatedStyles}
+            exiting={FadeOutDown.duration(100)}


Why we are adding an existing animation here? Can you upload two videos with/without the existing animation?

Without exit animation the popup gets hidden abruptly if we clear the input. Fadeout animation smooths it out a bit.

without FadeOut

withOut-FadeOut.mov

with FadeOut

withFadeOut.mov

Let's ~~annoy~~ ask @shawnborton 😁 Thoughts here?

I don't mind the fade, but why can't we exit it the same way it enters? That feels more consistent to me.

When we clear the input the suggestions popup gets removed from layout at ReportActionCompose level. For entry and further change in height of popup we are animating the container height variable. But for exit we wouldn't get an opportunity to animate the container height further, as the component gets removed from layout hierarchy immediately. That's why I'm using the exiting prop with FadeOutDown animation which feels closer to the entry animation. Other exit animation options are Bounce, Flip, Stretch, Zoom, Slide, LightSpeed, Pinwheel, Roll, Rotate. But none of those match the entry behaviour.

Below I've modified the FadeOutDown animation to add easeInOut easing to make it feel closer to the timing animation for height.

Screen.Recording.2023-06-01.at.6.50.12.PM.mov

@shawnborton Thoughts on the above ^

I think that feels fine to me, so let's go with that. Thanks for sharing!

src/components/AutoCompleteSuggestions/BaseAutoCompleteSuggestions.js

s77rt · 2023-06-05T18:32:33Z

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 / Chrome
- iOS / native
- iOS / 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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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.js 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(themeColors.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 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.
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

Web

web.mp4

Mobile Web - Chrome

mweb-chrome.mp4

Mobile Web - Safari

mweb-safari.mp4

Desktop

desktop.mp4

iOS

ios.mp4

Android

android.mp4

s77rt

LGTM! 🚀

cc @puneetlath

OSBotify · 2023-06-06T00:40:31Z

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

OSBotify · 2023-06-06T19:50:21Z

🚀 Cherry-picked to staging by https://github.com/puneetlath in version: 1.3.24-5 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2023-06-07T03:27:31Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.24-5 🚀

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

OSBotify · 2023-06-07T13:19:10Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.24-5 🚀

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

aswin-s added 3 commits May 31, 2023 14:10

feat: add animation for suggestions popup

1c0563a

Merge branch 'main' into issue-18974

c0436a4

remove unused imports

e732277

aswin-s requested a review from a team as a code owner June 1, 2023 03:27

melvin-bot bot requested review from puneetlath and s77rt and removed request for a team June 1, 2023 03:27

aswin-s mentioned this pull request Jun 1, 2023

[HOLD for payment 2023-06-13] [$2000] Fix auto-suggestion animation on Android #18974

Closed

s77rt suggested changes Jun 1, 2023

View reviewed changes

fix: move non animated styles out

a38e99b

s77rt suggested changes Jun 1, 2023

View reviewed changes

src/components/AutoCompleteSuggestions/BaseAutoCompleteSuggestions.js Outdated Show resolved Hide resolved

src/components/AutoCompleteSuggestions/BaseAutoCompleteSuggestions.js Outdated Show resolved Hide resolved

aswin-s added 2 commits June 1, 2023 16:54

fix: prettier styles

bdeb8eb

fix: remove unnecessary destructuring

b14f94a

aswin-s requested a review from s77rt June 1, 2023 11:34

fix: add easeInOut easing for exit animation

6ce5efc

s77rt approved these changes Jun 5, 2023

View reviewed changes

puneetlath approved these changes Jun 6, 2023

View reviewed changes

puneetlath merged commit ea65d35 into Expensify:main Jun 6, 2023

s77rt mentioned this pull request Jun 7, 2023

fix: android app crash fix due to wrong position of LayoutAnimation #18842

Merged

56 tasks

This was referenced Jun 15, 2023

[$2000] Dev: IOS - Chat - Console error on dismiss keyboard without sending message #20552

Closed

Fix: Obsolete LayoutAnimation #20888

Closed

feat: add animation for auto suggestions popup #19933

feat: add animation for auto suggestions popup #19933

Uh oh!

Conversation

aswin-s commented Jun 1, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Jun 1, 2023

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

s77rt commented Jun 5, 2023

Reviewer Checklist

Screenshots/Videos

Uh oh!

s77rt left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Jun 6, 2023

Uh oh!

OSBotify commented Jun 6, 2023

Uh oh!

OSBotify commented Jun 7, 2023

Uh oh!

OSBotify commented Jun 7, 2023

Uh oh!

Uh oh!