Fix search type popover has 2 items highlighted #53330

bernhardoj · 2024-11-30T07:22:48Z

Explanation of Change

Fixed Issues

$ #50224
PROPOSAL: #50224 (comment)

Tests

Same as QA Steps

Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

Prerequisite: have a saved search

For web/desktop: resize it to a small screen

Open search page
Press on the search type dropdown button
Select a saved search
Press the Cancel text button
Press on the search type dropdown button again
Verify only the Expense option is highlighted
Select any option other than the Expense
Press on the search type dropdown button again
Hide the popover without selecting any option
Press on the search type dropdown button again
Use keyboard navigation (up/down) and verify the navigation starts from the selected/highlighted item

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

Android: mWeb Chrome

android.mweb.mp4

iOS: Native

ios.mp4

iOS: mWeb Safari

ios.mwe.b.mp4

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

desktop.mp4

… item is changed

…hides

melvin-bot · 2024-11-30T07:22:53Z

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

bernhardoj · 2024-11-30T07:28:11Z

I didn't update this -1 focused index for the sub menu back button because I think if there is a sub-menu, then the parent menu won't have a selected option.

App/src/components/PopoverMenu.tsx

Lines 236 to 239 in 1a6f48e

    
           onPress={() => { 
        
               setCurrentMenuItems(previousMenuItems); 
        
               setFocusedIndex(-1); 
        
               setEnteredSubMenuIndexes((prevState) => prevState.slice(0, -1));

For this one, when we select the item, the popover will be closed or entered in the submenu. I didn't touch this one too because we already reset the focused index when the modal hides.

App/src/components/PopoverMenu.tsx

Lines 296 to 297 in 1a6f48e

    
           selectItem(focusedIndex); 
        
           setFocusedIndex(-1); // Reset the focusedIndex on selecting any menu

s77rt · 2024-11-30T16:14:43Z

src/components/PopoverMenu.tsx

+    useEffect(() => {
+        if (isVisible) {
+            return;
+        }
+        setFocusedIndex(currentMenuItemsFocusedIndex);
+    }, [isVisible, currentMenuItemsFocusedIndex, setFocusedIndex]);


currentMenuItemsFocusedIndex is changed due to the change in currentMenuItems which is due to the call setCurrentMenuItems(menuItems) that is done in the above useLayoutEffect. This is a known change and not a side effect and it should be done as soon as possible, i.e. call setFocusedIndex right after setCurrentMenuItems.

Note: Keep the isVisible condition but add a comment that we don't want the focus index to change if we dynamically change the items e.g.

If we have:

Item 1 (Selected)

Item 2 (Focused)

Item 3

then the selected item is changed (externally), the result should be as follow:

Item 1

Item 2 (Focused)

Item 3 (Selected)

Added comment with the help from ChatGPT.

s77rt · 2024-12-01T08:51:49Z

src/components/PopoverMenu.tsx

+
+        // Update the focused item to match the selected item, but only when the popover is not visible.
+        // This ensures that if the popover is visible, highlight from the keyboard navigation is not overridden
+        // by external updates to the selected item, preventing user experience disruption.


Suggested change

// by external updates to the selected item, preventing user experience disruption.

// by external updates.

bernhardoj added 2 commits November 30, 2024 15:14

update the focused index whilet the popover is hidden if the selected…

dc8a2db

… item is changed

reset the focused index to the selected item if any when the popover …

bf580a2

…hides

bernhardoj requested a review from a team as a code owner November 30, 2024 07:22

melvin-bot bot requested review from s77rt and removed request for a team November 30, 2024 07:22

lint

5bad35f

s77rt reviewed Nov 30, 2024

View reviewed changes

add comment

c564f3c

s77rt reviewed Dec 1, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix search type popover has 2 items highlighted #53330

Fix search type popover has 2 items highlighted #53330

bernhardoj commented Nov 30, 2024

melvin-bot bot commented Nov 30, 2024

bernhardoj commented Nov 30, 2024

s77rt Nov 30, 2024

bernhardoj Dec 1, 2024

s77rt Dec 1, 2024

	// by external updates to the selected item, preventing user experience disruption.
	// by external updates.

Fix search type popover has 2 items highlighted #53330

Are you sure you want to change the base?

Fix search type popover has 2 items highlighted #53330

Conversation

bernhardoj commented Nov 30, 2024

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Nov 30, 2024

bernhardoj commented Nov 30, 2024

s77rt Nov 30, 2024

Choose a reason for hiding this comment

bernhardoj Dec 1, 2024

Choose a reason for hiding this comment

s77rt Dec 1, 2024

Choose a reason for hiding this comment