Approver remains highlighted when navigating the list with keyboard #58892

thelullabyy · 2025-03-21T08:09:27Z

Explanation of Change

Remove shouldHighlightSelectedItem completely in all places in the codebase because we set shouldHighlightSelectedItem to SelectionList make the selected option remains highlighted at all times.

Replace shouldHighlightSelectedItem by

initiallyFocusedOptionKey={selectedApproverEmail} 
shouldUpdateFocusedIndex

to highlight only selected option row.

Wrap toggleApprover by debounce function for Enter key problem, we ensure that it only triggers after a short delay.
The warning key happens because <OfflineWithFeedback> (the top-level element) was missing the key, so we move key from <MenuItemWithTopDescription> to <OfflineWithFeedback>

Fixed Issues

$#57606
PROPOSAL:#57606 (comment)

Tests

Precondition:

Workspace has a few members.
Workflows are enabled.

Go to staging.new.expensify.com
Go to workspace settings > Workflows.
Click Submission frequency.
Click Monthly > Date of month.
Use down arrow to navigate the list.
Note that the selected option is not highlighted and there is only one highlighted row.
Close the RHP.
Click on the existing workflow.
Click Approver.
Use down arrow to navigate the list
Verify selected user is not highlighted and there is only one highlighted row

Verify that no errors appear in the JS console

Offline tests

QA Steps

Precondition:

Workspace has a few members.
Workflows are enabled.

Go to staging.new.expensify.com
Go to workspace settings > Workflows.
Click Submission frequency.
Click Monthly > Date of month.
Use down arrow to navigate the list.
Note that the selected option is not highlighted and there is only one highlighted row.
Close the RHP.
Click on the existing workflow.
Click Approver.
Use down arrow to navigate the list
Verify selected user is not highlighted and there is only one highlighted row

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android_native.mov

Android: mWeb Chrome

android_chorme.mov

iOS: Native

ios_native.mp4

iOS: mWeb Safari

ios_safari.mp4

MacOS: Chrome / Safari

chorme.mp4

MacOS: Desktop

desktop.mp4

melvin-bot · 2025-03-21T08:56:10Z

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

dominictb · 2025-03-24T19:53:07Z

@thelullabyy Where is the fix for the Enter key issue?

thelullabyy · 2025-03-26T11:01:39Z

@dominictb I updated PR. Please help to check

dominictb · 2025-03-31T14:36:03Z

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: Native
- Android: mWeb Chrome
- iOS: Native
- 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 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: Native

Screen.Recording.2025-04-01.at.15.48.56.mp4

Android: mWeb Chrome

Screen.Recording.2025-03-31.at.21.49.19.mov

iOS: Native

Screen.Recording.2025-03-31.at.21.40.52.mov

iOS: mWeb Safari

Screen.Recording.2025-03-31.at.21.42.40.mov

MacOS: Chrome / Safari

Screen.Recording.2025-03-31.at.21.34.26.mov

MacOS: Desktop

Screen.Recording.2025-03-31.at.21.37.54.mov

dominictb · 2025-03-31T14:45:03Z

@thelullabyy Can you help fix this console error when we first open the approval workflow editor?

thelullabyy · 2025-04-01T10:06:35Z

@dominictb I fixed the warning. Please help to continue review PR. Thanks.

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2025-04-01.at.16.32.53.mp4

dominictb · 2025-04-01T10:58:29Z

src/pages/workspace/workflows/approvals/ApprovalWorkflowEditor.tsx

@@ -149,7 +149,10 @@ function ApprovalWorkflowEditor({approvalWorkflow, removeApprovalWorkflow, polic
                            : undefined;

                    return (
-                        <OfflineWithFeedback pendingAction={getApprovalPendingAction(approverIndex)}>
+                        <OfflineWithFeedback
+                            key={`offline-feedback-${approver?.email}`}


@thelullabyy I think just move the below key={approver-${approver?.email}-${approverIndex}} here is enough.

@dominictb I updated

dominictb

🎀👀🎀

dominictb · 2025-04-01T12:07:17Z

@thelullabyy Please update the Explanation of Change to describe the overall changes of this PR.

thelullabyy · 2025-04-01T15:40:13Z

@dominictb updated. Pls help to check again.

jasperhuangg · 2025-04-01T20:31:05Z

Thanks for the quick work!

OSBotify · 2025-04-01T20:39:22Z

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

github-actions · 2025-04-03T16:10:51Z

🚀 Deployed to staging by https://github.com/jasperhuangg in version: 9.1.23-1 🚀

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

github-actions · 2025-04-07T20:31:40Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.1.23-7 🚀

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

fix: Approver remains highlighted when navigating the list with keyboard

5afa3e9

thelullabyy marked this pull request as ready for review March 21, 2025 08:56

thelullabyy requested a review from a team as a code owner March 21, 2025 08:56

melvin-bot bot requested review from dominictb and removed request for a team March 21, 2025 08:56

thelullabyy added 2 commits March 26, 2025 17:46

fix: enter key problem

2546e38

fix: ESLint

3c475ba

thelullabyy added 2 commits April 1, 2025 15:27

Merge branch 'main' into fix/57606-approver-remains-highlighted

38c02d0

fix: Add unique keys to list items to resolve key prop warning

440c724

thelullabyy closed this Apr 1, 2025

thelullabyy reopened this Apr 1, 2025

fix: ESlint

21e37fd

dominictb suggested changes Apr 1, 2025

View reviewed changes

refactor

b9c55be

dominictb approved these changes Apr 1, 2025

View reviewed changes

melvin-bot bot requested a review from jasperhuangg April 1, 2025 11:23

dominictb approved these changes Apr 1, 2025

View reviewed changes

jasperhuangg approved these changes Apr 1, 2025

View reviewed changes

jasperhuangg merged commit 4325900 into Expensify:main Apr 1, 2025
19 of 20 checks passed

github-actions bot mentioned this pull request Apr 3, 2025

Deploy Checklist: New Expensify 2025-04-03 #59590

Closed

86 tasks

melvin-bot bot mentioned this pull request Apr 7, 2025

[Due for payment 2025-04-14] [$250] Workflows - Approver remains highlighted when navigating the list with keyboard #57606

Closed

8 tasks

Approver remains highlighted when navigating the list with keyboard #58892

Approver remains highlighted when navigating the list with keyboard #58892

Uh oh!

Conversation

thelullabyy commented Mar 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Mar 21, 2025

Uh oh!

dominictb commented Mar 24, 2025

Uh oh!

thelullabyy commented Mar 26, 2025

Uh oh!

dominictb commented Mar 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

dominictb commented Mar 31, 2025

Uh oh!

thelullabyy commented Apr 1, 2025

Uh oh!

dominictb Apr 1, 2025

Choose a reason for hiding this comment

Uh oh!

thelullabyy Apr 1, 2025

Choose a reason for hiding this comment

Uh oh!

dominictb left a comment

Choose a reason for hiding this comment

Uh oh!

dominictb commented Apr 1, 2025

Uh oh!

thelullabyy commented Apr 1, 2025

Uh oh!

jasperhuangg commented Apr 1, 2025

Uh oh!

Uh oh!

OSBotify commented Apr 1, 2025

Uh oh!

github-actions bot commented Apr 3, 2025

Uh oh!

github-actions bot commented Apr 7, 2025

Uh oh!

Uh oh!

thelullabyy commented Mar 21, 2025 •

edited

Loading

dominictb commented Mar 31, 2025 •

edited

Loading