Skip to content

[No-QA] refactor: Navigation code in SelectionList component #92662

Open
TaduJR wants to merge 10 commits into
Expensify:mainfrom
TaduJR:refactor-Navigation-code-in-SelectionList-component
Open

[No-QA] refactor: Navigation code in SelectionList component #92662
TaduJR wants to merge 10 commits into
Expensify:mainfrom
TaduJR:refactor-Navigation-code-in-SelectionList-component

Conversation

@TaduJR

@TaduJR TaduJR commented Jun 4, 2026

Copy link
Copy Markdown
Contributor

Explanation of Change

BaseSelectionList (flat) and BaseSelectionListWithSections (sectioned) carried near-identical, copy-pasted forks of the same focus/navigation logic, which had already started to drift. This PR consolidates that duplicated navigation/interaction logic into shared, single-source modules under src/components/SelectionList/:

  • useSelectionListKeyboardFocus — the navigation core: wraps useArrowKeyFocusManager and owns the scroll-suppression ref, the focus-restore-aware cursor setters (setFocusedIndexFromRowFocus / setFocusedIndexWithoutScrollOnChange), suppressNextFocusScroll, and the keyboard-navigation modality (the hasKeyBeenPressed flag + Tab listener).
  • useSelectionListScroll — the bounds-checked scrollToIndex and its debounced variant.
  • useSelectionListShortcuts — the Enter / Ctrl+Enter shortcuts and disableEnterShortcut gating.
  • useSelectionListTextInput — the search-input refs and key handlers.
  • SelectionListEmptyState — the shared loading-skeleton / empty-state rendering.

Both BaseSelectionList and BaseSelectionListWithSections now consume these instead of maintaining their own copies; the per-list differences (data source, isActive expression, section flattening) are passed in as parameters.

Fixed Issues

$ #91033
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console

Offline tests

Same as tests

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."
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 verified there are no new alerts related to the canBeMissing param for useOnyx
  • 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 new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • 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: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari

@TaduJR TaduJR requested review from a team as code owners June 4, 2026 11:29
@melvin-bot melvin-bot Bot requested review from JmillsExpensify and mkhutornyi and removed request for a team June 4, 2026 11:29
@melvin-bot

melvin-bot Bot commented Jun 4, 2026

Copy link
Copy Markdown

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

@melvin-bot melvin-bot Bot removed the request for review from a team June 4, 2026 11:29
@TaduJR TaduJR changed the title refactor: Navigation code in SelectionList component [No-QA] refactor: Navigation code in SelectionList component Jun 4, 2026
@TaduJR

TaduJR commented Jun 4, 2026

Copy link
Copy Markdown
Contributor Author

@codex review

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 04144e2b06

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread src/components/SelectionList/hooks/useSelectionListTextInput.ts
Comment thread src/components/SelectionList/hooks/useSelectionListScroll.ts
@codecov

codecov Bot commented Jun 4, 2026

Copy link
Copy Markdown

Codecov Report

✅ Changes either increased or maintained existing code coverage, great job!

Files with missing lines Coverage Δ
src/components/SelectionList/BaseSelectionList.tsx 83.55% <100.00%> (+16.22%) ⬆️
...ListWithSections/BaseSelectionListWithSections.tsx 90.32% <100.00%> (+6.07%) ⬆️
...lectionList/components/SelectionListEmptyState.tsx 100.00% <100.00%> (ø)
...s/SelectionList/hooks/useSelectionListShortcuts.ts 100.00% <100.00%> (ø)
...s/SelectionList/hooks/useSelectionListTextInput.ts 100.00% <100.00%> (ø)
...lectionList/hooks/useSelectionListKeyboardFocus.ts 96.29% <96.29%> (ø)
...ents/SelectionList/hooks/useSelectionListScroll.ts 88.88% <88.88%> (ø)
... and 12 files with indirect coverage changes

@JmillsExpensify JmillsExpensify left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No product review required.

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Another round soon, please!

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

@mkhutornyi

Copy link
Copy Markdown
Contributor

Please merge main

Comment thread src/components/SelectionList/hooks/useSelectionListScroll.ts Outdated
Comment thread src/components/SelectionList/components/SelectionListEmptyState.tsx Outdated
@MelvinBot

Copy link
Copy Markdown
Contributor

Review

Reviewed the SelectionList navigation/focus consolidation. The extraction is faithful — the imperative ref API, props interface, arrow-key/scroll-suppression logic, Enter/Ctrl+Enter shortcuts, and focus-restore-aware setters all match the originals after substitution. No correctness regressions found.

Two minor behavioral deltas worth a look (posted inline):

  1. useSelectionListScroll.ts:28 — the flat BaseSelectionList used to swallow the FlashList scroll error silently; the shared hook now Log.warns for both list types, adding backend-forwarded log noise during rapid filtering.
  2. SelectionListEmptyState.tsx:29 — the sectioned-list skeleton telemetry now carries skeleton.shouldUseUserSkeletonView=undefined, a key that was absent before.
Things I checked that are fine
  • Lost useCallbacks (scrollToIndex, setHasKeyBeenPressed, focusTextInput): the explicit memoization was dropped, but React Compiler runs over src/ and re-memoizes these (the PR even has a commit making BaseSelectionList Compiler-compliant), so no listener-churn/identity regression in production builds.
  • shouldShowTextInput ?? vs destructuring default: only differs for null, and the prop is typed boolean | undefined, so TS forbids null — no behavioral change.
  • Imperative handle method names/signatures unchanged; all selectionListRef.current?.* call sites still resolve.
  • disabledArrowKeyIndexes (flat) / disabledIndexes (sections) routed correctly; row onFocus → setFocusedIndexFromRowFocus wiring preserved.

Next Steps: Reply with @MelvinBot <feedback> to refine this review.

@TaduJR

TaduJR commented Jun 8, 2026

Copy link
Copy Markdown
Contributor Author

Please merge main

Done.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants