Adding animation for children of switch components #53938

sumo-slonik · 2024-12-11T14:42:36Z

Explanation of Change

These PR add animations of the appearance and disappearance of elements after the switch using reanimated.

Fixed Issues

$ #53759

PROPOSAL:

Tests

Go to settings
Launch workflows
Enter workflows
Click the switches and check if the content below appears with a smooth animation

Verify that no errors appear in the JS console

Offline tests

Offline tests are not needed.

QA Steps

Same as tests

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.native.mp4

Android: mWeb Chrome

web.android.mp4

iOS: Native

ios.native.mp4

iOS: mWeb Safari

web.ios.mp4

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

desktop.mp4

github-actions · 2024-12-12T15:59:23Z

🚧 @mountiny has triggered a test build. You can view the workflow run here.

Kicu

Looks mostly ok. There is one thing with the translation keys and state that is a bit confusing. If you cannot rewrite it in any way, then at least drop a comment.
Otherwise lgtm 👍

You have a typo in name of the PR: childreans -> childrens

Kicu · 2024-12-13T09:34:39Z

src/components/Acordition/index.tsx

+import type {SharedValue} from 'react-native-reanimated';
+import Animated, {useAnimatedStyle, useDerivedValue, useSharedValue, withTiming} from 'react-native-reanimated';
+
+function AccordionItem({isExpanded, children, duration = 300}: {isExpanded: SharedValue<boolean>; children: ReactNode; duration?: number}) {


Please make sure the file and main export are named the same:
Component is called AccordionItem but the file is Accordion/index.ts (you have a type in the name).

Kicu · 2024-12-13T09:37:55Z

src/components/Acordition/index.tsx

+    }));
+
+    return (
+        <Animated.View style={[bodyStyle, {overflow: 'hidden'}]}>


Suggested change

<Animated.View style={[bodyStyle, {overflow: 'hidden'}]}>

<Animated.View style={[bodyStyle, styles.overflowHidden]}>

where styles come from:
const styles = useThemeStyles();

Kicu · 2024-12-13T09:39:56Z

src/components/Switch.tsx

@@ -26,21 +26,30 @@ type SwitchProps = {

    /** Callback to fire when the switch is toggled in disabled state */
    disabledAction?: () => void;
+
+    /**
+     * onStateChange: Callback function triggered only after the external state of the switch has successfully changed.


Suggested change

* onStateChange: Callback function triggered only after the external state of the switch has successfully changed.

* Callback function triggered only after the external state of the switch has successfully changed.

repeating the name is not needed, as the name of prop is right below this comment

I feel like this comment is a bit inaccurate.
This callback is triggered inside Switch component after the external state has changed AND the animation has finished, right?

Because if it was only after state change, then the external component could handle this itself. So I'm guessing it is important that this runs after the line:
offsetX.set(withTiming([...])...

Does this make sense?

Yes after the animation of moving the circle inside the switch, but it is this callback that actually triggers in our case the animation of rolling up and unrolling children

Kicu · 2024-12-13T09:47:42Z

src/pages/workspace/accounting/intacct/import/SageIntacctToggleMappingsPage.tsx

+        if (!isImportMappingEnable) {
+            return;
+        }
+        setTranslationKey(getDisplayTypeTranslationKeys(config?.mappings?.[mappingName]));


This line will be confusing, since assigning translation keys to state is quite uncommon.
Perhaps we could add a short 1-line comment to at least say its done for animation purpose?

The problem here is that changing the switch changes the content of the object:
config.mappings
which resulted in changing the content of the translation itself, that's why I changed the assignment here to only non-empty values, I was afraid of operating on the config logic itself so I think it's safe to leave a comment here

github-actions · 2024-12-13T18:06:19Z

🚧 @mountiny has triggered a test build. You can view the workflow run here.

github-actions · 2024-12-13T18:34:26Z

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/53938/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/53938/index.html

Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/53938/NewExpensify.dmg	https://53938.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

Kicu

LGTM 👍 the animation is tricky but I was not able to come up with a better solution

melvin-bot · 2024-12-16T08:38:34Z

@dubielzyk-expensify @thesahindia 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]

blazejkustra

Great work @sumo-slonik 🚀

blazejkustra · 2024-12-16T10:29:57Z

src/pages/workspace/accounting/intacct/import/SageIntacctToggleMappingsPage.tsx

+    // We are storing translation keys in the local state for animation purposes.
+    // Otherwise, the values change to undefined immediately after clicking, before the closing animation finishes,
+    // resulting in a janky animation effect.
+


Suggested change

blazejkustra · 2024-12-16T10:32:52Z

src/components/Switch.tsx

    const styles = useThemeStyles();
    const offsetX = useSharedValue(isOn ? OFFSET_X.ON : OFFSET_X.OFF);
    const theme = useTheme();

    useEffect(() => {
        offsetX.set(withTiming(isOn ? OFFSET_X.ON : OFFSET_X.OFF, {duration: 300}));
-    }, [isOn, offsetX]);
+        if (onStateChange) {
+            onStateChange(isOn);


Can't we use onToggle for this? 🤔

Unfortunately it seems to me that it does not, because doing it in onToggle called the animation trigger at the wrong time, but I will make sure that in the final version of the code it did not become possible

I was able to remove the use of this method and it is no longer needed.

blazejkustra · 2024-12-16T10:33:54Z

src/components/Accordion/index.tsx

+import Animated, {useAnimatedStyle, useDerivedValue, useSharedValue, withTiming} from 'react-native-reanimated';
+import useThemeStyles from '@hooks/useThemeStyles';
+
+function Accordion({isExpanded, children, duration = 300}: {isExpanded: SharedValue<boolean>; children: ReactNode; duration?: number}) {


Let's extract props type to a separate type above, a good rule of thumb is to always do it for complex types like this

blazejkustra · 2024-12-16T10:35:27Z

src/components/Accordion/index.tsx

+                onLayout={(e) => {
+                    height.set(e.nativeEvent.layout.height);
+                }}
+                style={{position: 'absolute', left: 0, right: 0, top: 0}}


Let's use styling utilities here:

styles.pAbsolute, styles.t0 ...

dubielzyk-expensify · 2024-12-17T05:05:21Z

The animation works well, but the padding here is wrong:

All rows go to the end and the padding should be like this:

sumo-slonik · 2024-12-17T08:47:27Z

@dubielzyk-expensify good catch, I'll fix it

sumo-slonik · 2024-12-17T09:58:12Z

@dubielzyk-expensify
Is it good now?

Screen.Recording.2024-12-17.at.10.53.55.mov

…itch_childreans

thesahindia · 2024-12-20T04:54:48Z

When you toggle the switch for an item at the bottom of the page, you have to scroll yourself to see the content at the bottom (Unrelated to this PR)

1.mov

If the switch is in the enabled state then it works fine

2.mov

Should we also work on the animation for the items in the settings list or will it be tackled separately?

Screen.Recording.2024-12-20.at.9.54.14.AM.mov

sumo-slonik · 2024-12-20T08:37:36Z

Connect bank account' isn't in the center.

I'll fix it.

Are we only updating Sage intacct page in this PR?

I'm fixing it so it will work for the others too

sumo-slonik · 2024-12-20T08:41:02Z

Should we also work on the animation for the items in the settings list or will it be tackled separately?

It seems to me that this should not be a part of this PR, but if you think it would be good to take care of it I will be happy to take care of it in the new one (not sure if there should be a new issue)

…, fix hover effect

dannymcclain · 2024-12-20T13:43:20Z

I tend to agree that we should not mess with the left hand nav right now. Let's keep this PR focused. @Expensify/design can weigh in too, but I feel like it would be better to tackle those in a separate issue.

shawnborton · 2024-12-20T14:10:11Z

Yeah, makes sense to me 👍

mountiny · 2024-12-22T17:24:35Z

@thesahindia how is it going on testing part?

mountiny · 2024-12-23T15:07:35Z

@sumo-slonik @thesahindia Would like to confirm, what is the nest step for this pr. Can you please fix the Prettier check? Thanks!

thesahindia · 2024-12-23T17:50:44Z

I have to finish the final testing and complete the checklist. I will do it soon.

blazejkustra · 2024-12-23T20:22:52Z

I merged the newest main and fixed prettier for you @thesahindia.

@mountiny I think it is ready for testing and C+ review :)

thesahindia · 2024-12-24T11:06:26Z

src/pages/workspace/workflows/ToggleSettingsOptionRow.tsx

@@ -1,7 +1,9 @@
-import type {ReactNode} from 'react';
+import {ReactNode, useEffect} from 'react';


Suggested change

import {ReactNode, useEffect} from 'react';

import type {ReactNode} from 'react';

thesahindia · 2024-12-24T11:08:29Z

src/pages/workspace/workflows/ToggleSettingsOptionRow.tsx

@@ -1,7 +1,9 @@
-import type {ReactNode} from 'react';
+import {ReactNode, useEffect} from 'react';
 import React, {useMemo} from 'react';


Suggested change

import React, {useMemo} from 'react';

import React, {useMemo, useEffect} from 'react';

thesahindia · 2024-12-24T11:10:02Z

src/CONST.ts

@@ -6440,6 +6440,8 @@ const CONST = {
    },

    MIGRATED_USER_WELCOME_MODAL: 'migratedUserWelcomeModal',
+
+    DEFAULT_POLICY_ID: '-1',


Suggested change

DEFAULT_POLICY_ID: '-1',

thesahindia · 2024-12-24T11:11:03Z

src/pages/workspace/accounting/intacct/import/SageIntacctToggleMappingsPage.tsx

@@ -50,11 +52,23 @@ function SageIntacctToggleMappingsPage({route}: SageIntacctToggleMappingsPagePro

    const policy = usePolicy(route.params.policyID);
    const mappingName: SageIntacctMappingName = route.params.mapping;
-    const policyID: string = policy?.id ?? '-1';
-
+    const policyID: string = policy?.id ?? CONST.DEFAULT_POLICY_ID;


@sumo-slonik ^

thesahindia · 2024-12-24T11:19:02Z

src/pages/workspace/accounting/qbo/import/QuickbooksLocationsPage.tsx

@@ -1,5 +1,7 @@
 import React, {useCallback, useEffect} from 'react';
 import {View} from 'react-native';


Please remove the View import and the Text import on line 8.

It's weird, I get an error when I try to comment on other lines.

mountiny · 2025-01-06T15:17:32Z

@sumo-slonik @blazejkustra I believe you are back tomorrow, happy new year!

Lets try to wrap this one up this week 🙌 Thanks!

sumo-slonik · 2025-01-07T11:25:07Z

After consideration, I decided not to fix the issue "Do not default string IDs to any value" Changed files ESLint check in this PR because it requires changes in many files (the number of changes exceeds 20 files). Together with @blazejkustra , we concluded that this would be too risky.

mountiny · 2025-01-07T14:10:44Z

@thesahindia hello! are you bale to wrap up the review and testing on this one?

github-actions · 2025-01-07T14:11:19Z

🚧 @mountiny has triggered a test build. You can view the workflow run here.

github-actions · 2025-01-07T14:37:50Z

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/53938/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/53938/index.html

Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/53938/NewExpensify.dmg	https://53938.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

thesahindia · 2025-01-07T19:52:41Z

I think we should add animations to these -

Qbo > Advanced > Sync reimbursed reports

Screen.Recording.2025-01-07.at.11.42.22.PM.mov

NetSuite > Import > Customer/project

Screen.Recording.2025-01-08.at.12.52.05.AM.mov

SageIntacct > Export > Export out-of-pocket expenses as > Default vendor

Screen.Recording.2025-01-08.at.1.21.04.AM.mov

dannymcclain · 2025-01-07T19:57:09Z

Yeah I agree with that. Basically anytime a switch makes something else appear we should add the animation to it.

thesahindia · 2025-01-07T20:02:57Z

The background color needs to cover the entire area in the hovered and pressed states

Xero > Tracking categories

Xero > Advanced

Qbo > Import > Customers/projects

thesahindia · 2025-01-07T20:19:58Z

Wondering if it would be better to avoid showing any animation when children are already visible on page load. On the workflows page, the 'Add Approvals' switch child has large content, and the animation doesn't feel smooth when I navigate to the page

Screen.Recording.2025-01-08.at.1.44.29.AM.mov

dannymcclain · 2025-01-07T20:40:23Z

Wondering if it would be better to avoid showing any animation when children are already visible on page load.

Strong agree with this! If it's already visible, no animation is necessary. The animation is simply affordance for the transition between states. Nice catch.

dubielzyk-expensify · 2025-01-08T04:18:55Z

Agree with that as well. This animation should only really trigger when the switch itself is changing

sumo-slonik added 5 commits December 11, 2024 10:46

smooth animation

dad3f55

work in progress

457b549

clean code before PR

eaa7d47

animation works in all places

d852938

refactor before PR

2b2b451

sumo-slonik mentioned this pull request Dec 12, 2024

[$250] Implement animation to the switch expandable sections #53759

Open

mountiny assigned sumo-slonik Dec 12, 2024

mountiny added the Ready To Build label Dec 12, 2024

This comment has been minimized.

Sign in to view

Kicu reviewed Dec 13, 2024

View reviewed changes

changes after code review

c2fb131

sumo-slonik changed the title ~~Feature/kuba nowakowski/add animation for switch childreans~~ Feature/kuba nowakowski/add animation for switch childrens Dec 16, 2024

Kicu approved these changes Dec 16, 2024

View reviewed changes

sumo-slonik marked this pull request as ready for review December 16, 2024 08:38

sumo-slonik requested a review from a team as a code owner December 16, 2024 08:38

melvin-bot bot requested review from dubielzyk-expensify and thesahindia December 16, 2024 08:38

melvin-bot bot removed the request for review from a team December 16, 2024 08:38

blazejkustra suggested changes Dec 16, 2024

View reviewed changes

changes after Blazej review

4473400

fix padding problem in toggle page

7443bc5

sumo-slonik added 2 commits December 17, 2024 11:02

Merge branch 'main' into feature/kuba_nowakowski/add_animation_for_sw…

6c8771d

…itch_childreans

fix eslint

24cd3ca

adding accordion to all places, remove unnecessary callback in switch…

408750f

…, fix hover effect

add easing to effect

be4015e

thesahindia suggested changes Dec 24, 2024

View reviewed changes

sumo-slonik force-pushed the feature/kuba_nowakowski/add_animation_for_switch_childreans branch from 6af03ef to 060cae7 Compare January 7, 2025 09:06

fix liner reanimated API

53fd209

sumo-slonik force-pushed the feature/kuba_nowakowski/add_animation_for_switch_childreans branch from f73179f to 53fd209 Compare January 7, 2025 10:41

sumo-slonik added 2 commits January 7, 2025 11:53

remove unnecessary const

314dca1

fix linter

d99e589

blazejkustra approved these changes Jan 7, 2025

View reviewed changes

	<Animated.View style={[bodyStyle, {overflow: 'hidden'}]}>
	<Animated.View style={[bodyStyle, styles.overflowHidden]}>

	* onStateChange: Callback function triggered only after the external state of the switch has successfully changed.
	* Callback function triggered only after the external state of the switch has successfully changed.

		@@ -1,7 +1,9 @@
		import type {ReactNode} from 'react';
		import {ReactNode, useEffect} from 'react';

	import React, {useMemo} from 'react';
	import React, {useMemo, useEffect} from 'react';

		@@ -1,5 +1,7 @@
		import React, {useCallback, useEffect} from 'react';
		import {View} from 'react-native';

Adding animation for children of switch components #53938

Are you sure you want to change the base?

Adding animation for children of switch components #53938

Conversation

sumo-slonik commented Dec 11, 2024 • edited Loading

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

github-actions bot commented Dec 12, 2024

This comment has been minimized.

Kicu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Dec 13, 2024

github-actions bot commented Dec 13, 2024

Kicu left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Dec 16, 2024

blazejkustra left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dubielzyk-expensify commented Dec 17, 2024

sumo-slonik commented Dec 17, 2024

sumo-slonik commented Dec 17, 2024

thesahindia commented Dec 20, 2024 • edited Loading

sumo-slonik commented Dec 20, 2024

sumo-slonik commented Dec 20, 2024

dannymcclain commented Dec 20, 2024

shawnborton commented Dec 20, 2024

mountiny commented Dec 22, 2024

mountiny commented Dec 23, 2024

thesahindia commented Dec 23, 2024

blazejkustra commented Dec 23, 2024

thesahindia Dec 24, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thesahindia Dec 24, 2024 • edited Loading

Choose a reason for hiding this comment

mountiny commented Jan 6, 2025

sumo-slonik commented Jan 7, 2025

mountiny commented Jan 7, 2025

github-actions bot commented Jan 7, 2025

github-actions bot commented Jan 7, 2025

thesahindia commented Jan 7, 2025

dannymcclain commented Jan 7, 2025

thesahindia commented Jan 7, 2025

thesahindia commented Jan 7, 2025

dannymcclain commented Jan 7, 2025

dubielzyk-expensify commented Jan 8, 2025

sumo-slonik commented Dec 11, 2024 •

edited

Loading

thesahindia commented Dec 20, 2024 •

edited

Loading

thesahindia Dec 24, 2024 •

edited

Loading

thesahindia Dec 24, 2024 •

edited

Loading