fix: keyboard is not displayed on iOS for autofocused inputs by martasudol · Pull Request #58760 · Expensify/App

martasudol · 2025-03-19T19:07:27Z

Explanation of Change

This change fixes the issue of the keyboard not appearing on iOS in the browser (mWeb). The problem occurs not only in the Description Field on the Scan Expense Confirmation Page but also in any input field where we use autofocus.

Fixed Issues

$#58040

Tests

Open the web app on an iOS device (Chrome / Safari).
Navigate to the Create Expense view.
Tap on an input field with autofocus, such as Description or Merchant.
Expected behavior: The keyboard should appear.
Navigate to Settings → Profile → Display Name.
Expected behavior: Input fields should not be auto-focused, and the keyboard should not appear.

Verify that no errors appear in the JS console

Offline tests

Same as Tests.

QA Steps

Same as Tests.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

https://github.com/user-attachments/assets/71ce1b61-b2c2-48a7-9b97-b419256bd5ed

Android: mWeb Chrome

https://github.com/user-attachments/assets/24aa6d64-7727-4482-b76a-9daddcf0ffb7

iOS: Native

https://github.com/user-attachments/assets/0f0ea5b1-cb6f-4d8f-84cb-b108ba023ec3

iOS: mWeb Safari

https://github.com/user-attachments/assets/aa30d9e4-439c-4324-abef-8ab5928a921b

MacOS: Chrome / Safari

https://github.com/user-attachments/assets/80ae0665-e943-4cec-8a1c-c06d1b78796e

MacOS: Desktop

https://github.com/user-attachments/assets/e2d9af49-8f3a-4a27-bc52-effde426a2e2

melvin-bot · 2025-03-19T19:07:31Z

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

melvin-bot · 2025-03-20T07:14:22Z

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

martasudol · 2025-03-20T07:17:26Z

Keyboard behavior can vary between iOS and Android, as well as between real devices, simulators, and emulators. For Android system, I was only able to test this on an emulator since I don’t have access to a real Android device. It would be great if someone could run these changes on a physical Android device to verify everything works as expected. Let me know if you notice any issues!

DylanDylann · 2025-03-25T05:21:45Z

    const styles = useThemeStyles();
    const textInputRef = useRef<HTMLFormElement | null>(null);
    const removeVisibilityListenerRef = useRef<RemoveVisibilityListener>(null);
+    const isAutoFocusEnabled = typeof ref === 'function' || props.autoFocus;


@martasudol Could you help to detail the RCA and how this change will fix the problem?

The main issue was likely that ref could be a function when using the useAutoFocusInput hook, which might have caused unexpected behavior in the keyboard visibility check.

But why useAutoFocusInput doesn't work on this case?

For clear, in useAutoFocusInput we already implemented a logic to auto focus the input

App/src/hooks/useAutoFocusInput.ts

Line 32 in 8c827d7

inputRef.current?.focus();

And I think we need to point out why it doesn't work on the physical devices

It seems that autofocus is triggered differently on iOS real devices compared to Android or simulators/emulators - timing and visibility behavior can vary quite a bit depending on the platform.

Anyway, I’ve just tested the latest version of the app on a real iOS device, and it looks like the issue is no longer reproducible - everything works as expected now.

Could you please re-test on your side and confirm whether the bug is still happening for you? 🙏 Looks like someone fixed this in the meantime :D

I still can reproduce on Chrome on Iphone (with latest main)

You’re right - I was able to reproduce the issue in the browser on iOS as well.

My fix specifically addresses this problem, which only occurs in iOS browsers. The root cause is that React Native for Web doesn’t fully support autofocus for web iOS; a focus trigger is required for autofocus to work properly.

In our case, we use the useAutoFocusInput hook and then pass down the default props, which slightly changes how autofocus is triggered for iOS browsers. This difference in behavior is likely what caused the issue.

DylanDylann · 2025-03-26T11:14:05Z

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 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 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
- 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.js 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.
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-03-26.at.18.21.17.mov

Android: mWeb Chrome

FILE.2025-03-26.16.20.03.mp4

iOS: Native

Screen.Recording.2025-03-26.at.18.20.09.mov

iOS: mWeb Safari

6444331329418.mp4

MacOS: Chrome / Safari

Screen.Recording.2025-03-26.at.18.17.35.mov

MacOS: Desktop

Screen.Recording.2025-03-26.at.18.18.29.mov

melvin-bot · 2025-03-26T11:35:52Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #58040 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

OSBotify · 2025-03-26T12:48:04Z

✋ 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-03-27T14:07:41Z

🚀 Deployed to staging by https://github.com/carlosmiceli in version: 9.1.20-0 🚀

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

cristipaval · 2025-03-28T11:48:47Z

We reverted this PR because it introduced 5 deploy blockers. See here

github-actions · 2025-03-31T10:06:04Z

🚀 Deployed to production by https://github.com/mountiny in version: 9.1.20-2 🚀

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

fix: keyboard is not displayed on iOS for autofocused inputs

998acfd

ESLint changes

33c630e

martasudol marked this pull request as ready for review March 20, 2025 07:14

martasudol requested a review from a team as a code owner March 20, 2025 07:14

melvin-bot Bot requested review from DylanDylann and removed request for a team March 20, 2025 07:14

martasudol mentioned this pull request Mar 20, 2025

[HOLD #52414][$250] Description Field Not Focused Properly on Scan Expense Confirmation Page #58040

Closed

8 tasks

DylanDylann reviewed Mar 25, 2025

View reviewed changes

DylanDylann approved these changes Mar 26, 2025

View reviewed changes

melvin-bot Bot requested a review from carlosmiceli March 26, 2025 11:36

carlosmiceli approved these changes Mar 26, 2025

View reviewed changes

carlosmiceli merged commit b9a704a into Expensify:main Mar 26, 2025

github-actions Bot mentioned this pull request Mar 27, 2025

Deploy Checklist: New Expensify 2025-03-27 #59215

Closed

45 tasks

FitseTLT mentioned this pull request Mar 27, 2025

[$250] FAB - Cursor overlaps with the label when starting a chat #59234

Closed

8 tasks

nkdengineer mentioned this pull request Mar 27, 2025

[Due for payment 2025-04-08] [$250] FAB - Start chat tabs are not visible #59223

Closed

8 tasks

amyevans mentioned this pull request Mar 28, 2025

Split - Individual split input is auto-focused and unfocused on confirmation page #59244

Closed

8 tasks

daledah mentioned this pull request Mar 28, 2025

[Due for payment 2025-05-13] [$250] workspace-On refreshing workspace "role" page, user navigated to previous"confirm details"page #58966

Closed

8 tasks

This was referenced Mar 28, 2025

[CP Staging] Revert "fix: keyboard is not displayed on iOS for autofocused inputs" #59287

Merged

Hold expense - Hold reason field auto validates and it throws "This field is required" error #59240

Closed

Conversation

martasudol commented Mar 19, 2025

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Mar 19, 2025

Uh oh!

melvin-bot Bot commented Mar 20, 2025

Uh oh!

martasudol commented Mar 20, 2025

Uh oh!

DylanDylann Mar 25, 2025

Choose a reason for hiding this comment

Uh oh!

martasudol Mar 25, 2025

Choose a reason for hiding this comment

Uh oh!

DylanDylann Mar 25, 2025

Choose a reason for hiding this comment

Uh oh!

DylanDylann Mar 25, 2025

Choose a reason for hiding this comment

Uh oh!

martasudol Mar 25, 2025 • 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!

DylanDylann Mar 25, 2025

Choose a reason for hiding this comment

Uh oh!

martasudol Mar 26, 2025

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Mar 26, 2025

Uh oh!

OSBotify commented Mar 26, 2025

Uh oh!

github-actions Bot commented Mar 27, 2025

Uh oh!

cristipaval commented Mar 28, 2025

Uh oh!

github-actions Bot commented Mar 31, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

martasudol Mar 25, 2025 •

edited

Loading

DylanDylann commented Mar 26, 2025 •

edited

Loading