fix: refocus the input field on the login screen after returning to the tab #21656

akinwale · 2023-06-27T00:58:40Z

Details

Refocuses the input field on the login screen when a user switches back from a different tab in order to keep the soft keyboard visible.

Fixed Issues

$ #20690
PROPOSAL: #20690 (comment)

Tests

Open the login page
Tap on the email field to open the soft keyboard
Scroll down and click on any link
Go back to the login page
Verify the expected behaviours as outlined below.

Android Chrome: The soft keyboard remains open and the screen automatically scrolls to the email input.
Android native: The soft keyboard remains open. The screen does not automatically scroll to the email input until typing starts.
iOS native: The soft keyboard remains open. The screen does not automatically scroll to the email input even after typing starts.
iOS Safari: The soft keyboard does not remain open (due to a system limitation which only allows the soft keyboard to be open from a user interaction event). The screen automatically scrolls to the email input.

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as tests.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Mobile Web - Chrome

20690-android-chrome.mp4

Mobile Web - Safari

20690-ios-safari.mp4

Desktop

20690-ios-safari.mp4

iOS

20690-ios-native.mp4

Android

20690-android-native.mp4

melvin-bot · 2023-06-27T00:58:45Z

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

src/pages/signin/LoginForm.js

akinwale · 2023-07-15T07:34:55Z

@parasharrajat The modifications were pretty straightforward in the TextInput component and behaviour remains the same as outlined in my initial post after testing on all platforms. It's ready for review now, thanks.

parasharrajat · 2023-07-15T11:53:49Z

src/components/TextInput/index.js

+        this.unsubscribeVisibilityListener = Visibility.onVisibilityChange(() => {
+            if (!Visibility.isVisible() || !this.textInput || DomUtils.getActiveElement() !== this.textInput) {
+                return;
+            }
+            this.textInput.blur();
+            this.textInput.focus();
+        });
+    }


How will this determine which input to focus when there are many on the same page?

This check in the early return condition ensures that it is the current active (focused) element: DomUtils.getActiveElement() !== this.textInput.

Here is the reference doc for document.activeElement which is what the getActiveElement method returns.

@parasharrajat can we test this out?

akinwale · 2023-07-18T06:49:23Z

@parasharrajat Did you get a chance to do another review yet?

parasharrajat · 2023-07-18T06:50:24Z

Not yet. But I will try to get that today.

parasharrajat

Testing.

parasharrajat · 2023-07-20T12:47:03Z

src/components/TextInput/index.js

+    constructor(props) {
+        super(props);
+        this.unsubscribeVisibilityListener = null;
+    }
+


Suggested change

constructor(props) {

super(props);

this.unsubscribeVisibilityListener = null;

}

Not needed.

parasharrajat · 2023-07-20T12:52:23Z

If we want to promote consistency, we can prevent Android chrome from scrolling to the input. @akinwale Do you think, it is possible?

akinwale · 2023-07-20T13:31:13Z

If we want to promote consistency, we can prevent Android chrome from scrolling to the input. @akinwale Do you think, it is possible?

@parasharrajat After doing some digging, I don't see a way to achieve this because it is the default behaviour with Android Chrome when an input field is focused. The only way to prevent the autoscroll would be to NOT re-establish focus on the text input which defeats the purpose of this PR.

parasharrajat · 2023-07-20T14:12:52Z

There is a way via preventing default but that will be problematic if directly apply it. No problem, I don't think this problem is affecting a lot of users thus, we should be fine.

parasharrajat · 2023-07-20T14:19:48Z

src/components/TextInput/index.js

@@ -14,6 +16,21 @@ class TextInput extends React.Component {
        if (this.props.name) {
            this.textInput.setAttribute('name', this.props.name);
        }
+
+        this.unsubscribeVisibilityListener = Visibility.onVisibilityChange(() => {


Please add a explanation for these changes.

parasharrajat · 2023-07-20T14:21:09Z

Screenshots

🔲 iOS / native

Screen.Recording.2023-07-20.at.8.07.43.PM.mov

🔲 iOS / Safari

Screen.Recording.2023-07-20.at.8.04.54.PM.mov

🔲 MacOS / Desktop

Screen.Recording.2023-07-20.at.7.54.48.PM.mov

🔲 MacOS / Chrome

Screen.Recording.2023-07-20.at.7.55.55.PM.mov

🔲 Android / Chrome

Screen.Recording.2023-07-20.at.7.56.39.PM.mov

🔲 Android / native

Screen.Recording.2023-07-20.at.9.40.20.PM.mov

parasharrajat · 2023-07-20T14:41:36Z

src/components/TextInput/index.js

+        /**
+         * A visibliity listener responsible for re-establishing focus on the TextInput in cases where a user
+         * switches away from an MWeb tab and back. This forces the soft keyboard to be activated on Android
+         * after switching back to the tab. See https://github.com/Expensify/App/issues/20690 for more details.
+         */


Suggested change

/**

* A visibliity listener responsible for re-establishing focus on the TextInput in cases where a user

* switches away from an MWeb tab and back. This forces the soft keyboard to be activated on Android

* after switching back to the tab. See https://github.com/Expensify/App/issues/20690 for more details.

*/

// Forcefully activate the soft keyboard when the user switches between tabs while input was focused.

parasharrajat · 2023-07-20T15:12:34Z

Please merge main @akinwale

akinwale · 2023-07-20T15:23:26Z

Please merge main @akinwale

@parasharrajat Done.

parasharrajat

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 / Chrome
- iOS / native
- iOS / 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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(themeColors.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 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.

🎀 👀 🎀 C+ reviewed

akinwale · 2023-07-21T08:01:23Z

@youssef-lr Hoping we can get this merged today. Thanks.

src/components/TextInput/index.js

OSBotify · 2023-07-25T12:46:37Z

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

OSBotify · 2023-07-26T16:10:43Z

🚀 Deployed to staging by https://github.com/youssef-lr in version: 1.3.46-0 🚀

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

OSBotify · 2023-07-27T22:08:48Z

🚀 Deployed to staging by https://github.com/youssef-lr in version: 1.3.47-0 🚀

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

OSBotify · 2023-07-27T22:39:29Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.3.46-2 🚀

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

OSBotify · 2023-07-31T18:37:18Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.47-6 🚀

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

akinwale requested a review from a team as a code owner June 27, 2023 00:58

melvin-bot bot requested review from parasharrajat and removed request for a team June 27, 2023 00:58

akinwale changed the title ~~refocus the input field on the login screen after returning to the tab~~ fix: refocus the input field on the login screen after returning to the tab Jun 27, 2023

parasharrajat reviewed Jun 27, 2023

View reviewed changes

src/pages/signin/LoginForm.js Outdated Show resolved Hide resolved

parasharrajat reviewed Jun 27, 2023

View reviewed changes

src/pages/signin/LoginForm.js Outdated Show resolved Hide resolved

parasharrajat reviewed Jun 27, 2023

View reviewed changes

src/pages/signin/LoginForm.js Outdated Show resolved Hide resolved

akinwale mentioned this pull request Jul 10, 2023

[HOLD for payment 2023-08-03] [$1000] [mWeb] input field is focused but keyboard does not open #20690

Closed

6 tasks

handle showing the soft keyboard upon refocus in the TextInput component

f05e29e

akinwale force-pushed the task-20690 branch from 62a97e5 to f05e29e Compare July 15, 2023 07:19

akinwale requested a review from parasharrajat July 15, 2023 07:33

parasharrajat reviewed Jul 15, 2023

View reviewed changes

parasharrajat suggested changes Jul 20, 2023

View reviewed changes

remove unnecessary constructor

1de6b04

akinwale requested a review from parasharrajat July 20, 2023 13:31

parasharrajat reviewed Jul 20, 2023

View reviewed changes

add comments for explanation

232bf8d

akinwale requested a review from parasharrajat July 20, 2023 14:40

parasharrajat reviewed Jul 20, 2023

View reviewed changes

modify comment

6de85ec

akinwale requested a review from parasharrajat July 20, 2023 14:49

Merge remote-tracking branch 'origin/main' into task-20690

7575f29

parasharrajat approved these changes Jul 20, 2023

View reviewed changes

melvin-bot bot requested a review from youssef-lr July 20, 2023 16:12

youssef-lr reviewed Jul 25, 2023

View reviewed changes

src/components/TextInput/index.js Outdated Show resolved Hide resolved

youssef-lr reviewed Jul 25, 2023

View reviewed changes

src/components/TextInput/index.js Outdated Show resolved Hide resolved

youssef-lr reviewed Jul 25, 2023

View reviewed changes

src/components/TextInput/index.js Outdated Show resolved Hide resolved

rename listener

6d08325

akinwale requested a review from youssef-lr July 25, 2023 10:36

youssef-lr approved these changes Jul 25, 2023

View reviewed changes

youssef-lr merged commit beebb67 into Expensify:main Jul 25, 2023
12 checks passed

OSBotify mentioned this pull request Jul 26, 2023

Deploy Checklist: New Expensify 2023-07-26 #23657

Closed

43 tasks

OSBotify mentioned this pull request Jul 27, 2023

Deploy Checklist: New Expensify 2023-07-27 #23765

Closed

79 tasks

tienifr mentioned this pull request Aug 1, 2023

Fix: Form validation runs on blur in New task details page #24011

Merged

57 tasks

parasharrajat mentioned this pull request Aug 3, 2023

[HOLD for payment 2023-08-16] [$1000] Web - Task - Error is shown as soon as app is put in background when creating a task #23552

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: refocus the input field on the login screen after returning to the tab #21656

fix: refocus the input field on the login screen after returning to the tab #21656

akinwale commented Jun 27, 2023

melvin-bot bot commented Jun 27, 2023

akinwale commented Jul 15, 2023 •

edited

Loading

parasharrajat Jul 15, 2023

akinwale Jul 15, 2023 •

edited

Loading

akinwale Jul 15, 2023 •

edited

Loading

youssef-lr Jul 18, 2023

akinwale commented Jul 18, 2023

parasharrajat commented Jul 18, 2023

parasharrajat left a comment

parasharrajat Jul 20, 2023

akinwale Jul 20, 2023

parasharrajat commented Jul 20, 2023

akinwale commented Jul 20, 2023

parasharrajat commented Jul 20, 2023

parasharrajat Jul 20, 2023

akinwale Jul 20, 2023

parasharrajat commented Jul 20, 2023 •

edited

Loading

parasharrajat Jul 20, 2023

parasharrajat commented Jul 20, 2023

akinwale commented Jul 20, 2023

parasharrajat left a comment

akinwale commented Jul 21, 2023

OSBotify commented Jul 25, 2023

OSBotify commented Jul 26, 2023

OSBotify commented Jul 27, 2023

OSBotify commented Jul 27, 2023

OSBotify commented Jul 31, 2023

fix: refocus the input field on the login screen after returning to the tab #21656

fix: refocus the input field on the login screen after returning to the tab #21656

Conversation

akinwale commented Jun 27, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jun 27, 2023

akinwale commented Jul 15, 2023 • edited Loading

parasharrajat Jul 15, 2023

Choose a reason for hiding this comment

akinwale Jul 15, 2023 • edited Loading

Choose a reason for hiding this comment

akinwale Jul 15, 2023 • edited Loading

Choose a reason for hiding this comment

youssef-lr Jul 18, 2023

Choose a reason for hiding this comment

akinwale commented Jul 18, 2023

parasharrajat commented Jul 18, 2023

parasharrajat left a comment

Choose a reason for hiding this comment

parasharrajat Jul 20, 2023

Choose a reason for hiding this comment

akinwale Jul 20, 2023

Choose a reason for hiding this comment

parasharrajat commented Jul 20, 2023

akinwale commented Jul 20, 2023

parasharrajat commented Jul 20, 2023

parasharrajat Jul 20, 2023

Choose a reason for hiding this comment

akinwale Jul 20, 2023

Choose a reason for hiding this comment

parasharrajat commented Jul 20, 2023 • edited Loading

Screenshots

🔲 iOS / native

🔲 iOS / Safari

🔲 MacOS / Desktop

🔲 MacOS / Chrome

🔲 Android / Chrome

🔲 Android / native

parasharrajat Jul 20, 2023

Choose a reason for hiding this comment

parasharrajat commented Jul 20, 2023

akinwale commented Jul 20, 2023

parasharrajat left a comment

Choose a reason for hiding this comment

Reviewer Checklist

akinwale commented Jul 21, 2023

OSBotify commented Jul 25, 2023

OSBotify commented Jul 26, 2023

OSBotify commented Jul 27, 2023

OSBotify commented Jul 27, 2023

OSBotify commented Jul 31, 2023

akinwale commented Jul 15, 2023 •

edited

Loading

akinwale Jul 15, 2023 •

edited

Loading

akinwale Jul 15, 2023 •

edited

Loading

parasharrajat commented Jul 20, 2023 •

edited

Loading