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

feat: Add temporary focus to enabled option in workspace initial page #38546

Merged
merged 23 commits into from
Apr 4, 2024

Conversation

allroundexperts
Copy link
Contributor

@allroundexperts allroundexperts commented Mar 18, 2024

Details

Adds temporary focus to the workspace feature that was enabled on narrow screens.

Fixed Issues

$ #38372
PROPOSAL: N/A

Tests

For narrow screen layouts only:

  1. Open app and go to any collect workspace
  2. Tap more features
  3. Enable any option

Verify that the row of the enabled option is highlighted when we take the user back to the LHN.

  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

For narrow screen layouts only:

  1. Open app and go to any collect workspace
  2. Tap more features
  3. Enable any option

Verify that the row of the enabled option is highlighted when we take the user back to the LHN.

  • 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 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
      • If any non-english text was added/modified, I verified the translation was requested/reviewed 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.js 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.
  • 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
Screen.Recording.2024-03-19.at.4.05.23.AM.mov
Android: mWeb Chrome
Screen.Recording.2024-03-19.at.4.04.50.AM.mov
iOS: Native
Screen.Recording.2024-03-19.at.4.03.14.AM.mov
iOS: mWeb Safari
Screen.Recording.2024-03-19.at.4.02.46.AM.mov
MacOS: Chrome / Safari
Screen.Recording.2024-03-19.at.3.32.13.AM.mov
MacOS: Desktop
Screen.Recording.2024-03-19.at.3.34.48.AM.mov

@allroundexperts allroundexperts changed the title feat: Add temp focus to workspace initial page feat: Add temporary focus to enabled option in workspace initial page Mar 18, 2024
@allroundexperts allroundexperts marked this pull request as ready for review March 18, 2024 23:24
@allroundexperts allroundexperts requested a review from a team as a code owner March 18, 2024 23:24
@melvin-bot melvin-bot bot requested review from rushatgabhane and removed request for a team March 18, 2024 23:24
Copy link

melvin-bot bot commented Mar 18, 2024

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

@allroundexperts
Copy link
Contributor Author

I think @rojiphil is supposed to review this cc @mountiny

@mountiny
Copy link
Contributor

@allroundexperts nice! any chance it could fade away?

cc @Expensify/engineering team for 👁️ maybe we want to update the time

@mountiny
Copy link
Contributor

I believe we want the effect to be more of a "highlight", I will leave that to the design team though

@allroundexperts
Copy link
Contributor Author

allroundexperts commented Mar 18, 2024

@allroundexperts nice! any chance it could fade away?

This is similar to how its being done in #38036. We don't have the fade effect there or do we?

@allroundexperts
Copy link
Contributor Author

Just for the reference of the design team, the focus time is 3s right now.

@thienlnam
Copy link
Contributor

I think you tagged the wrong team here heh @mountiny

src/pages/workspace/WorkspaceInitialPage.tsx Outdated Show resolved Hide resolved
src/pages/workspace/WorkspaceInitialPage.tsx Outdated Show resolved Hide resolved
src/components/MenuItem.tsx Outdated Show resolved Hide resolved
src/components/MenuItem.tsx Outdated Show resolved Hide resolved
src/components/MenuItem.tsx Outdated Show resolved Hide resolved
@rojiphil

This comment was marked as off-topic.

@rojiphil

This comment was marked as outdated.

@allroundexperts
Copy link
Contributor Author

allroundexperts commented Mar 19, 2024

@rojiphil This is not how it should work. I'll check and get back!

@allroundexperts
Copy link
Contributor Author

@allroundexperts @mountiny Please find the test video for the above implementation. Does this look fine to you?

38546-highlight-fix.mp4

@rojiphil Is this running on my branch? I can't seem to reproduce this behaviour.

@allroundexperts
Copy link
Contributor Author

Since highlight was the original expectation, please check if the following implementation would meet the requirement of highlight implementation

Isn't highlight the same as temporary focus?

@allroundexperts
Copy link
Contributor Author

The current changes are for the categories feature. Further, this has the advantage of remembering the previous active route and highlighting the same.

Not sure what you're talking about here.

@mountiny
Copy link
Contributor

Oh damn sorry for the wrong tag here team, typo + autosuggestion

It was meant to be @Expensify/design

@rojiphil
Copy link
Contributor

Isn't highlight the same as temporary focus?

Hmm... It seemed to me that the expectation was to keep the highlight on and not have a temporary focus. If the expectation is to have a temporary focus then all what I said can be ignored.

@shawnborton
Copy link
Contributor

So just to make sure we're all on the same page here:

  1. On mobile, when you enable a feature from the More features page, you navigate back to the workspace editor navigation menu
  2. When you get back to the workspace navigation menu, we want to show a visual highlight of the feature we just enabled

I think that's all we're trying to accomplish here, right?

What I think I would recommend is that we highlight the newly enabled feature by:

  • giving it the :active background color, which is the same as our border color or product400
  • we also make the icon of the highlighted nav item use our success/green400 color

I think the highlight should stay for like 1.5-2.5 seconds, and when the highlight is over, we should fade it out with a slight transition instead of instant.

Curious if that is what the rest of the @Expensify/design is thinking too.

@dannymcclain
Copy link
Contributor

@shawnborton yeah that sounds good to me. 👍

I also wonder if we could add a slight delay to the transition from the more features page to the navigation menu? Right now it happens so fast you can't even see the toggle go all the way to the on state. I think a tiny amount of delay there would really help it feel not so jarring.

@shawnborton
Copy link
Contributor

Oh yeah, I love that idea!

@luacmartins luacmartins self-requested a review March 19, 2024 18:43
@shawnborton
Copy link
Contributor

though I will say that the mobile animation seems to be cut off at the start due to the navigation up the hierarchy.

Yup, this stood out to me too.

@rojiphil
Copy link
Contributor

rojiphil commented Apr 4, 2024

@allroundexperts Looks like we introduced regression here. Can you also please check on this?

Screenshot 2024-04-04 at 12 32 51 PM

38372-pr-branch.mp4

@rojiphil
Copy link
Contributor

rojiphil commented Apr 4, 2024

I just checked on all the platforms. To me, the feature works like a charm on all. Just that while testing with a small screen device scenario on MacOS:safari platform, I noticed that the highlight animation is quite quick (as can be seen in the test video). But, maybe we can ignore this as mobile platforms seem to work well.

Screenshots/Videos

Android: Native
38372-android-native.mp4
Android: mWeb Chrome
38372-mweb-chrome.mp4
iOS: Native
38372-ios-native.mp4
iOS: mWeb Safari
38372-mweb-safari.mp4
MacOS: Safari
38372-web-safari.mp4
MacOS: Desktop
38372-desktop.mp4

@rojiphil
Copy link
Contributor

rojiphil commented Apr 4, 2024

though I will say that the mobile animation seems to be cut off at the start due to the navigation up the hierarchy

@dubielzyk-expensify @shawnborton Just to be on the same page, did you mean a similar observation (as mentioned here) as on testing a MacOS:safari platform with small screen device scenario? Or did you mean something else?

@shawnborton
Copy link
Contributor

I think it's a similar comment, yes. Basically the highlight animation seems to start slightly before the page transition (goBack) happens.

mountiny
mountiny previously approved these changes Apr 4, 2024
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.

Its shaping up well now, no major comments to the code, I think we are at the point we should get this to staging and feel it out

@mountiny
Copy link
Contributor

mountiny commented Apr 4, 2024

Except this regression obviously

@allroundexperts
Copy link
Contributor Author

Regression is fixed. @rojiphil Please verify.

@allroundexperts
Copy link
Contributor Author

Also, @mountiny @luacmartins, just to be sure that we're on the same page, with this useEffect approach, the items might get highlighted if a feature is enabled on another device. I can't see any good way to avoid this unless we make use of some kind of state variable that tells that the user came back from the enable feature page explicitly.

Copy link
Contributor

@rojiphil rojiphil left a comment

Choose a reason for hiding this comment

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

Looks like we introduced few more issues. But I think we are very close. Please check.

@@ -0,0 +1,36 @@
import type {ForwardedRef} from 'react';
import {forwardRef} from 'react';
Copy link
Contributor

Choose a reason for hiding this comment

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

Looks like we missed adding React here.
Screenshot 2024-04-04 at 5 59 35 PM

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's weird that there is no lint / type error for this. I've added it anyways.

<MenuItem
// eslint-disable-next-line react/jsx-props-no-spreading
{...restOfProps}
wrapperStyle={animatedHighlightStyle}
Copy link
Contributor

Choose a reason for hiding this comment

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

Did you mean outerWrapperStyle={animatedHighlightStyle}?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yep, my bad. Fixed.

src/components/HighlightableMenuItem.tsx Show resolved Hide resolved
Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

Looking good

src/hooks/useAnimatedHighlightStyle/config.ts Show resolved Hide resolved
@rojiphil
Copy link
Contributor

rojiphil commented Apr 4, 2024

the items might get highlighted if a feature is enabled on another device.

Yea. Thanks for bringing this up. I had captured this in my iOS:Native platform testing here. Please use the test video for reference if needed. But, it looked a nice little feature to me.

Copy link
Contributor

@rojiphil rojiphil left a comment

Choose a reason for hiding this comment

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

Awesome. Tests well on all platforms. LGTM.

@melvin-bot melvin-bot bot requested a review from mountiny April 4, 2024 14:14
Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

LGTM

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.

Thank you!

@luacmartins luacmartins merged commit de09508 into Expensify:main Apr 4, 2024
17 of 21 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Apr 4, 2024

✋ 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
Copy link
Contributor

OSBotify commented Apr 8, 2024

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.4.61-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Apr 8, 2024

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.4.61-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.61-8 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.