Add focus trap by adamgrzybowski · Pull Request #39520 · Expensify/App

adamgrzybowski · 2024-04-03T16:44:23Z

Details

This PR adds focus-trap to fix the problem when the user navigates with tab between elements that are not visible.

Fixed Issues

$ #36476
PROPOSAL: #36476 (comment)

Tests

Open LHP, RHP or modal.
Try to navigate with TAB.
Only elements in LHP or RHP should focus.

Verify that no errors appear in the JS console

Offline tests

QA Steps

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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

src/components/FocusTrap/FocusTrapForModal/index.tsx

jnowakow · 2024-05-09T07:16:09Z

package.json

    "expo-av": "~13.10.4",
    "expo-image": "1.11.0",
    "expo-image-manipulator": "11.8.0",
+    "focus-trap-react": "^10.2.3",


Request to add library

Request was resolved successfully

WojtekBoman · 2024-05-09T08:03:37Z

src/components/FocusTrap/BOTTOM_TAB_SCREENS.ts

@@ -0,0 +1,5 @@
+import SCREENS from '@src/SCREENS';
+
+const BOTTOM_TAB_SCREENS: string[] = [SCREENS.HOME, SCREENS.SETTINGS.ROOT];


Instead of string[], use BottomTabName[]

jnowakow · 2024-05-13T13:34:31Z

Details

Fixed Issues

$ #36476
PROPOSAL: #36476 (comment)

Tests

Open LHP, RHP or modal.
Try to navigate with TAB.
Only elements in LHP or RHP should focus.

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as in 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 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

N/A

Android: mWeb Chrome

N/A

iOS: Native

N/A

iOS: mWeb Safari

N/A

MacOS: Chrome / Safari

web-rhp.mov

web-context-menu.mov

MacOS: Desktop

desktop-rhp.mov

desktop-context-menu.mov

Skalakid

LGTM, left one small comment 🛸

Skalakid · 2024-05-14T10:46:23Z

src/components/FocusTrap/FocusTrapForScreen/index.web.tsx

+import useWindowDimensions from '@hooks/useWindowDimensions';
+import type FocusTrapProps from './FocusTrapProps';
+
+let activeRouteName = '';


Do we need activeRouteName variable outside the component? Can't we just use, for example, useRef?

This variable is shared between instances of FocusTrap component

tsa321 · 2024-06-14T00:43:37Z

Just my opinion:
There is already a focus trap in react-native-web modal: https://github.com/necolas/react-native-web/blob/master/packages/react-native-web/src/exports/Modal/ModalFocusTrap.js

Do we need to put additional focustrap in baseModal?
CMIW

OSBotify · 2024-06-14T23:02:49Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.83-3 🚀

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

dangrous · 2024-06-18T17:36:55Z

Pinged in Slack too, but this might be causing an issue with the debug modal - #43897 . Let me know what you think!

jjcoffee · 2024-06-26T09:45:56Z

Coming from #43664, there was a regression caused by the focus trap that resulted in the sign in page scrolling to bottom when signing in from a public room.

parasharrajat · 2024-06-29T16:00:25Z

src/components/FocusTrap/FocusTrapForModal/index.web.tsx

+            focusTrapOptions={{
+                trapStack: sharedTrapStack,
+                allowOutsideClick: true,
+                fallbackFocus: document.body,


We should disable the initial focus to prevent default selection on popup menus.#43659

hoangzinh · 2024-08-02T10:21:27Z

Hi team. Coming from #43713, there was an issue that the workspace switcher has a blue border after login in mWeb.

situchan

Coming from #45629:
There's one more case of modal (EmojiPicker) to be wrapped with FocusTrapForModal.

rayane-d · 2024-08-22T16:02:55Z

This PR caused #43719, a detailed RCA can be found in this proposal: #43719 (comment)

wildan-m · 2024-11-13T03:55:46Z

src/libs/Navigation/AppNavigator/Navigators/FullScreenNavigator.tsx

-                />
-            </RootStack.Navigator>
-        </View>
+        <FocusTrapForScreens>


@adamgrzybowski Why do we have FocusTrapForScreens here if each child screen already has a screenwrapper containing it?

@wildan-m hello, I also worked on this PR so I can answer. The reason is that FullScreenNavigator can display two screens, for example:

In this case we have to disable FocusTrap which is rendered by ScreenWrapper. Otherwise we would have trap active only in red screen or blue screen. FocusTrap over navigator allows us to trap focus in both visible screens.
You can see screens with disabled focus trap in src/components/FocusTrap/WIDE_LAYOUT_INACTIVE_SCREENS.ts file.

btw are you working on something connected? Maybe we should put the comment in that place

@jnowakow Thank you for your response. Although I haven't encountered any actual issues yet, I noticed that on smaller screens, when the trap is disabled in the screen wrapper (for some reason), it still traps the focus because the parent container FullScreenNavigator's focus trap exists.

Okey, so probably it's desired behaviour

adamgrzybowski added 3 commits April 3, 2024 17:25

fix BaseGenericPressable defocusing after press

ec50a62

add focus-trap-react package

623f6ca

add focus trap for screens and popovers

7700359

adamgrzybowski mentioned this pull request Apr 3, 2024

[$500] Improve Tab Navigation & Accessibility #36476

Closed

6 tasks

roryabraham reviewed Apr 3, 2024

View reviewed changes

src/components/FocusTrap/FocusTrapForModal/index.tsx Show resolved Hide resolved

kosmydel and others added 8 commits April 8, 2024 13:17

fix back button

ee852a4

Merge branch 'main' into add-focus-trap

d64cb37

Merge branch 'main' into add-focus-trap

cfdab9a

Merge branch 'main' into add-focus-trap

76887e4

Add focus trap to report context menu

7f25987

Merge branch 'main' into add-focus-trap

3425512

Fix focus and tab navigation in Context Menu

9740843

Point to new search screen in autofocus

368610e

jnowakow mentioned this pull request May 9, 2024

Add focus-trap-react library #41877

Closed

jnowakow reviewed May 9, 2024

View reviewed changes

Fix linter

5ced21b

WojtekBoman reviewed May 9, 2024

View reviewed changes

Apply review comment

9928153

bernhardoj mentioned this pull request May 9, 2024

[Held on 39520] IOU - Pressing on the space bar while date picker RHP is open scrolls the details page #41928

Closed

6 tasks

jnowakow added 4 commits May 13, 2024 08:19

Merge branch 'main' into add-focus-trap

12846dd

Fix ts

41862ad

Merge branch 'main' into add-focus-trap

eb4b654

Fix prettier

6e3ba8c

jnowakow added 2 commits May 14, 2024 10:23

Merge branch 'main' into add-focus-trap

23f47d4

useCallback

1ac3596

Skalakid approved these changes May 14, 2024

View reviewed changes

jnowakow added 3 commits May 15, 2024 09:19

Merge branch 'main' into add-focus-trap

bc9e6eb

Workspace screens in autofocus

296e9a1

Merge branch 'main' into add-focus-trap

e707d95

github-actions bot mentioned this pull request Jun 13, 2024

Deploy Checklist: New Expensify 2024-06-13 #43655

Closed

64 tasks

fedirjh mentioned this pull request Jun 13, 2024

[HOLD for payment 2024-06-24] [$250] The FAB or Search category selector are narrow #43657

Closed

6 tasks

This was referenced Jun 13, 2024

[PAID] [$500] Keyboard focus is on the "close" button when uploading an attachment #43726

Closed

[HOLD for Payment 2024-08-22] [$250] Submit expense - Tabs disappear when changing from Scan to Distance via SHIFT+TAB #43719

Closed

rayane-d mentioned this pull request Jun 14, 2024

[$250] mWeb - Chat - Emoji picker cut off in the bottom #43692

Closed

6 tasks

This was referenced Jun 14, 2024

[CP Staging] Disable initial focus in modals #43743

Merged

[CP Staging] Fix autofocus on Sign In page #43752

Merged

situchan mentioned this pull request Jun 17, 2024

[HOLD for payment 2024-07-17] [$500] Web – Chat – Blue frame appears around message Reply when open context menu & use keyboard arrow #32279

Closed

6 tasks

Krishna2323 mentioned this pull request Jun 20, 2024

[HOLD for payment 2024-08-13] [$250] Context menu - Unable to add reaction by Enter key/navigate from first option to last by up key #44095

Closed

6 tasks

allgandalf mentioned this pull request Jun 27, 2024

[$250] [HOLD payment 2024-08-09] [CRITICAL] [Guided setup] The onboarding flow can be dismissed by navigating to different route #44401

Closed

parasharrajat reviewed Jun 29, 2024

View reviewed changes

This was referenced Jul 3, 2024

[HOLD for payment 2024-07-25] [$250] Incorrect animation when accessing Referral information page #44745

Closed

[HOLD for payment 2024-07-22] [$250] Web - Chat - Notification preferences RHP does not animate smoothly #44421

Closed

aimane-chnaif mentioned this pull request Jul 9, 2024

[HOLD for payment 2024-07-10] Composer is not highlighted when focused after enabling toggle and clicking + button #43766

Closed

6 tasks

sobitneupane mentioned this pull request Jul 31, 2024

[$250] mWeb – Chat – Blue frame appears around + button when open conversation link URL in a new tab #46109

Closed

6 tasks

situchan reviewed Aug 19, 2024

View reviewed changes

situchan mentioned this pull request Aug 19, 2024

[HOLD for payment 2024-08-19] [$250] Cannot search for emojis in status page #45629

Closed

6 tasks

wildan-m reviewed Nov 13, 2024

View reviewed changes

thelullabyy mentioned this pull request Jul 22, 2025

[Due for payment 2025-08-15] [$250] Workspace - Usd currency changed displays blue border. #66693

Closed

8 tasks

aimane-chnaif mentioned this pull request Dec 15, 2025

Add Concierge to the Side Panel = Concierge Everywhere! #76277

Merged

52 tasks

		@@ -0,0 +1,5 @@
		import SCREENS from '@src/SCREENS';

		const BOTTOM_TAB_SCREENS: string[] = [SCREENS.HOME, SCREENS.SETTINGS.ROOT];

Conversation

adamgrzybowski commented Apr 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jnowakow commented May 13, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

Skalakid left a comment

Choose a reason for hiding this comment

Uh oh!

Skalakid May 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tsa321 commented Jun 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

OSBotify commented Jun 14, 2024

Uh oh!

dangrous commented Jun 18, 2024

Uh oh!

jjcoffee commented Jun 26, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hoangzinh commented Aug 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

situchan left a comment

Choose a reason for hiding this comment

Uh oh!

rayane-d commented Aug 22, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

17 participants

adamgrzybowski commented Apr 3, 2024 •

edited

Loading

Skalakid May 14, 2024 •

edited

Loading

tsa321 commented Jun 14, 2024 •

edited

Loading

hoangzinh commented Aug 2, 2024 •

edited

Loading