Keyboard type changes very quickly during focus request [187746439]

Fixed

Bug

Status Update

No update yet.

Description

ng...@gmail.com

created issue #1

May 11, 2021 01:41PM

Jetpack Compose release version: 1.0.0-beta06

Android Studio Build: Android Studio Arctic Fox | 2020.3.1 Canary 15 Build #AI-203.7717.56.2031.7321754, built on April 28, 2021 Runtime version: 11.0.10+0-b96-7281165 x86_64 VM: OpenJDK 64-Bit Server VM by JetBrains s.r.o. macOS 11.2.3 GC: G1 Young Generation, G1 Old Generation Memory: 2048M Cores: 16 Registry: external.system.auto.import.disabled=true Non-Bundled Plugins: idea.plugin.protoeditor, org.jetbrains.kotlin, org.intellij.plugins.markdown

I’m facing a strange behavior with focus + keyboard type… All the TextFields are numeric and when I move the focus to the previous TextField, the keyboard type changes very quickly to the alpha numeric and then changes back again to the numeric…

Here’s my code:

@Composable
fun NumberPadScreen() {
    val passcodeLength = 5
    val focusRequesters = remember {
        (0 until passcodeLength).map { FocusRequester() }
    }
    val digits = remember {
        mutableStateListOf(
            *((0 until passcodeLength).map { "" }.toTypedArray())
        )
    }
    Box(Modifier.fillMaxSize()) {
        Row(Modifier.align(Alignment.Center)) {
            for (i in 0 until passcodeLength) {
                TextField(
                    value = digits[i],
                    onValueChange = {
                        if (it.isDigitsOnly()) {
                            digits[i] = it.lastOrNull()?.toString() ?: ""
                            if (digits[i].isBlank() && i > 0) {
                                focusRequesters[i - 1].requestFocus()
                            } else if (i < passcodeLength - 1) {
                                focusRequesters[i + 1].requestFocus()
                            }
                        }
                    },
                    modifier = Modifier
                        .padding(2.dp)
                        .width(50.dp)
                        .focusOrder(focusRequesters[i])
                        .onKeyEvent { event ->
                            if (event.type == KeyEventType.KeyUp
                                && event.key == Key.Backspace
                                && digits[i].isEmpty()
                                && i > 0
                            ) {
                                focusRequesters[i - 1].requestFocus()
                                digits[i - 1] = ""
                                true
                            } else {
                                false
                            }
                        },
                    keyboardOptions = KeyboardOptions(
                        autoCorrect = false,
                        imeAction = ImeAction.Done,
                        keyboardType = KeyboardType.Number
                    ),
                    textStyle = TextStyle(fontSize = 24.sp)
                )
            }
        }
    }
}

Please see the attached GIF which demonstrate the scenario. This is happening both on emulator and real device.

2021-05-11 10.02.26.gif

126 KB

View

Download

Comments

si...@google.com <si...@google.com> May 11, 2021 04:29PM

Assigned to an...@google.com.

ng...@gmail.com <ng...@gmail.com> #2Sep 6, 2021 01:48PM

First of all thanks for this detailed issue.

This issue had been investigated thoroughly when it was first reported internally. The surprising detail in this report is that the issue is not reproducible before 1.7. I will look into this.

The main problem with POBox is the fact that it is deprecated. Since 2021 Sony has been shipping new Xperia devices with Gboard pre-installed. Although we are aware that there is still a considerable amount of users still using POBox, the described behavior is caused by POBox's noncompliant behavior with InputConnection and InputMethodManager documentation. However, this is understandable since TextView implementation was also not respecting the behavior that is expected from Editors.

Ultimately we have decided to enforce the documented behavior with specifically regards to when editors should call InputMethodManager.updateSelection. Also, although unconfirmed, there were traces of possible custom code being included in Sony OEM images that changed how InputMethodManager was notified from TextView. If POBox also depended on something like this, it would be impossible for Compose code to replicate the same unknown behavior.

op...@gmail.com <op...@gmail.com> #3Sep 13, 2021 02:31PM

If the investigation takes time, would it be possible to revert the surrounding implementation to 1.6.x equivalent?

Or is that option not available?

Even if the root cause is POBox, from the perspective of the app's customers, it looks like an app bug, so this issue is a blocker against updating Jetpack Compose.

na...@gmail.com <na...@gmail.com> #4Sep 23, 2021 07:02AM

Just to be sure, it is dangerous to replace Compose TextField with Android View EditText as a workaround for this issue.

Compose 1.7 has a bug that causes ANR when the focus is on EditText. https://issuetracker.google.com/issues/369354336

Another View-related bug in Compose 1.7 is that an Android View is focused by calling FocusManager.clearFocus(). https://issuetracker.google.com/issues/374031296

Perhaps there is a lack of testing of Compose 1.7 in combination with Android View. There is also a possibility that there are other fatal bugs related to View.

In other words, the only options for apps targeting the Japanese market that require POBox support are to continue using Compose 1.6 or to use EditText in combination with various workarounds.

Message last modified on Sep 23, 2021 08:18AM

[Deleted User] <[Deleted User]> #5Oct 8, 2021 08:15AM

Project: platform/frameworks/support
Branch: androidx-main
Author: Halil Ozercan <halilibo@google.com>
Link: https://android-review.googlesource.com/3317256

Fix POBox keyboard issue

Expand for full commit details

Fix POBox keyboard issue 
 
Fix: 373743376 
Fix: 329209241 
Test: NullableInputConnectionWrapperTest 
Change-Id: I94e0e598274fb88b255f977f9fbd50dfbbb1ecb1

Files:

M compose/ui/ui/src/androidInstrumentedTest/kotlin/androidx/compose/ui/text/input/NullableInputConnectionWrapperTest.kt
M compose/ui/ui/src/androidMain/kotlin/androidx/compose/ui/text/input/NullableInputConnectionWrapper.android.kt

Hash: 57f58c4b80d5d8470b2aca325dfdcd55f235231e
Date: Thu Oct 24 01:25:20 2024

zo...@gmail.com <zo...@gmail.com> #6Oct 8, 2021 08:19AM

Many thanks again for this report. Especially for giving us a huge clue in terms of what could be going wrong. The fix is now merged and I will ask for a cherry-pick into a stable release.

r....@gmail.com <r....@gmail.com> #7Oct 18, 2021 08:23PM

Thank you for fixing the issue, I confirmed the fix was released in version 1.8.0-alpha05.
Do you have any concrete plan to cherry-pick the fix into current stable version (1.7.x)? We are currently waiting it.

ch...@gmail.com <ch...@gmail.com> #8Oct 28, 2021 09:03AM

Yes, this fix is planned to be included in a future 1.7.x release.

kl...@google.com <kl...@google.com> Oct 28, 2021 05:29PM

Reassigned to kl...@google.com.

gb...@appolica.com <gb...@appolica.com> #9Nov 10, 2021 05:16PM

Thanks for the fix. Sorry to follow up on this. is it possible for you to share specific release version/date for the stable version? We are waiting on this to decide on our direction.

ja...@gmail.com <ja...@gmail.com> #10Nov 10, 2021 09:27PM

Same issue

[Deleted User] <[Deleted User]> #11Nov 11, 2021 11:57AM

Same issue

al...@deliverymuch.com.br <al...@deliverymuch.com.br> #12Nov 11, 2021 12:36PM

Same issue

ch...@gmail.com <ch...@gmail.com> #13Nov 12, 2021 07:33AM

I have created an article on a possible workaround, hope it helps.

https://chetangupta.net/keyboard-switch-bug/

mi...@gmail.com <mi...@gmail.com> #14Nov 12, 2021 01:09PM

This hack only viable for pin/otp stuff. It won't fix an issue when you have a regular form

iv...@gmail.com <iv...@gmail.com> #15Nov 15, 2021 12:25PM

Faced with the same issue.
Hope google will pay its attention on this bug someday :D

ha...@gmail.com <ha...@gmail.com> #16Nov 17, 2021 02:17PM

Also facing the same issue

jo...@gmail.com <jo...@gmail.com> #17Nov 24, 2021 05:46PM

Same Issue

sc...@gmail.com <sc...@gmail.com> #18Nov 24, 2021 06:35PM

That flickers for me too

mi...@gmail.com <mi...@gmail.com> #19Nov 26, 2021 07:38PM

This issue still exists on version 1.05. We actually have users complaining about it in the reviews....

br...@gmail.com <br...@gmail.com> #20Dec 8, 2021 08:48PM

Probably the same bug, but I've noticed just using the backspace button in a single text field can also cause this to happen, it's like the keyboard/IME is being reloaded with every backspace!

Video attached. Seems like a pretty big issue, might delay are move to Compose over this.

Message last modified on Dec 8, 2021 08:49PM

screen-20211208-231710 (1).mp4

6.3 MB

Download

la...@gmail.com <la...@gmail.com> #21Dec 12, 2021 06:35AM

Any solution. To this issues??
Perhaps a walk around ?

ch...@hotstar.com <ch...@hotstar.com> #22Dec 24, 2021 11:27AM

Guys any update on this ticket?

ja...@gmail.com <ja...@gmail.com> #23Jan 10, 2022 07:36AM

same issue here

6o...@gmail.com <6o...@gmail.com> #24Jan 10, 2022 11:45PM

same issue

ko...@gmail.com <ko...@gmail.com> #25Jan 13, 2022 10:30AM

same issue

mu...@gmail.com <mu...@gmail.com> #26Jan 14, 2022 10:05AM

same issue

kl...@google.com <kl...@google.com> #27Jan 16, 2022 10:00PM

Accepted by kl...@google.com.

Started a doc to discuss fixes (it's internal-only, at least for now).

Message last modified on Jan 16, 2022 10:00PM

kl...@google.com <kl...@google.com> #28Jan 17, 2022 02:04AM

Probably the same bug, but I've noticed just using the backspace button in a single text field can also cause this to happen, it's like the keyboard/IME is being reloaded with every backspace!

Can you share repro code? I can definitely reproduced the issue with the code in the original issue description, but I haven't been able to reproduce with just backspace in a single field.

th...@gmail.com <th...@gmail.com> #29Jan 18, 2022 05:16AM

Is there any workaround available for this issue?

ct...@gmail.com <ct...@gmail.com> #30Jan 21, 2022 11:22AM

As mentioned above, this solution is possible workaround. BTW, works for me as expected!

https://chetangupta.net/keyboard-switch-bug/

kl...@google.com <kl...@google.com> #31Jan 22, 2022 12:37AM

The fix is up and ready for review: https://android-review.googlesource.com/c/platform/frameworks/support/+/1954101

ap...@google.com <ap...@google.com> #32Jan 24, 2022 11:59PM

Marked as fixed.

Project: platform/frameworks/support
Branch: androidx-main

commit 3f9688cc817a0620544193538d92d40ed730a195
Author: Zach Klippenstein <klippenstein@google.com>
Date: Sun Jan 16 18:12:45 2022

Debounce restart input commands in TextInputServiceAndroid.

In Compose, we hide the soft keyboard and close the input connection every time the text field loses focus.

Android, as far as I can tell, only does this cleanup when focus is being truly cleared and not moving to another view, which only happens after the window is detached.

This means that when focus is moved between multiple Android TextViews, each one starts a new input session without closing the old one, in a single (atomic-ish) step, and if the IME options are the same then the keyboard doesn’t change. This bug happens in Compose because we first close the connection before opening another one, and so the keyboard will reset to its default state before the IME options from the new field are applied from its new session.

The fix is to debounce restartInput operations on the IME in the same way
that we already debounce show/hide operations.

See this doc for more discussion about what caused this bug and how
it's fixed:

https://docs.google.com/document/d/1o-y3NkfFPCBhfDekdVEEl41tqtjjqs8jOss6txNgqaw/edit?usp=sharing&resourcekey=0-o728aLn51uXXnA4Pkpe88Q

Fixes:

b/187746439

Test: Manual testing to verify the issue described in

b/187746439

.
Test: Unit tests for the new TextInputServiceAndroid debouncing:
./gradlew :compose:ui:ui:test
Test: Additional integration test that text fields are calling the right
PlatformTextInputService methods when focus changes.
Relnote: "The soft keyboard input type no longer flickers when changing
focus between text fields."
Change-Id: I1bf50cacddd8e20f9bd3d5124f277e5fef467ac0

M compose/foundation/foundation/src/androidAndroidTest/kotlin/androidx/compose/foundation/text/CoreTextFieldInputServiceIntegrationTest.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/text/TextFieldDelegate.kt
M compose/ui/ui/src/androidMain/kotlin/androidx/compose/ui/platform/AndroidComposeView.android.kt
M compose/foundation/foundation/src/test/kotlin/androidx/compose/foundation/text/TextFieldDelegateTest.kt
A compose/foundation/foundation/integration-tests/foundation-demos/src/main/java/androidx/compose/foundation/demos/text/TextFieldFocusKeyboardInteraction.kt
A compose/ui/ui/src/test/kotlin/androidx/compose/ui/text/input/TextInputServiceAndroidCommandDebouncingTest.kt
M compose/foundation/foundation/integration-tests/foundation-demos/src/main/java/androidx/compose/foundation/demos/text/TextDemos.kt
M compose/ui/ui/src/androidMain/kotlin/androidx/compose/ui/text/input/TextInputServiceAndroid.android.kt
M compose/ui/ui/src/androidAndroidTest/kotlin/androidx/compose/ui/platform/LocalSoftwareKeyboardControllerTest.kt

https://android-review.googlesource.com/1954101

mo...@gmail.com <mo...@gmail.com> #33Jun 27, 2022 10:37PM

How do I know - In which version of Compose this issue is fixed?

kl...@google.com <kl...@google.com> #34Jun 27, 2022 11:04PM

That fix went out in 1.2.0-alpha03.

di...@gmail.com <di...@gmail.com> #35Dec 29, 2022 09:37AM

Hi, I am still facing this issue on 1.3.0-rc01 and also on the latest(i.e. 1.4.0-alpha03, where is even worse, the keyboard does not flicker, it is hidden on every pass to the next field).

sh...@gmail.com <sh...@gmail.com> #36Feb 20, 2023 09:54PM

Hello, I'm also facing exact same issue that the keyboard gets hidden when BasicTextField is placed at bottom of LazyColumn. Do let me know if someone has a fix for this. thanks in advance!
Note: It occurs only when windowSoftInputMode is set to 'adjustResize'.

Message last modified on Feb 20, 2023 09:57PM

jo...@langlive.com <jo...@langlive.com> #37May 10, 2023 04:50AM

still facing this issue on 1.4.0

si...@sentbe.com <si...@sentbe.com> #38Apr 22, 2024 03:36AM

While the text field is focused, try opening the modal bottom sheet through some operation(e.g. pressing a button).

When the bottom sheet is opened, the keyboard closes. After closing the bottom sheet, if you press the text field again to raise the keyboard, the keyboard option changes to Default.

but, if you remove the focus of the text field and open the bottom sheet, keyboard option will not change.

I think the system is causing an unexpected (bottom sheet) behavior that kills the keyboard and overrides the ime option.

I want to keep the keyboard options regardless of focus.

Message last modified on Apr 22, 2024 07:00AM

sy...@gmail.com <sy...@gmail.com> #39Apr 22, 2024 11:56AM

Seeing the same thing as

https://issuetracker.google.com/issues/187746439#comment38 in androidx.compose.material3:material3:1.3.0-alpha04

Message last modified on Apr 22, 2024 11:56AM

kl...@google.com <kl...@google.com> #40May 8, 2024 07:11PM

The comments on this issue since it's been closed seem to be discussing multiple different bugs. Please file new bugs for these.

Issue 187746439

Description

Issue summary

Comments

si...@google.com <si...@google.com> May 11, 2021 04:29PM

ng...@gmail.com <ng...@gmail.com> #2Sep 6, 2021 01:48PM

op...@gmail.com <op...@gmail.com> #3Sep 13, 2021 02:31PM

na...@gmail.com <na...@gmail.com> #4Sep 23, 2021 07:02AM

[Deleted User] <[Deleted User]> #5Oct 8, 2021 08:15AM

zo...@gmail.com <zo...@gmail.com> #6Oct 8, 2021 08:19AM

r....@gmail.com <r....@gmail.com> #7Oct 18, 2021 08:23PM

ch...@gmail.com <ch...@gmail.com> #8Oct 28, 2021 09:03AM

kl...@google.com <kl...@google.com> Oct 28, 2021 05:29PM

gb...@appolica.com <gb...@appolica.com> #9Nov 10, 2021 05:16PM

ja...@gmail.com <ja...@gmail.com> #10Nov 10, 2021 09:27PM

[Deleted User] <[Deleted User]> #11Nov 11, 2021 11:57AM

al...@deliverymuch.com.br <al...@deliverymuch.com.br> #12Nov 11, 2021 12:36PM

ch...@gmail.com <ch...@gmail.com> #13Nov 12, 2021 07:33AM

mi...@gmail.com <mi...@gmail.com> #14Nov 12, 2021 01:09PM

iv...@gmail.com <iv...@gmail.com> #15Nov 15, 2021 12:25PM

ha...@gmail.com <ha...@gmail.com> #16Nov 17, 2021 02:17PM

jo...@gmail.com <jo...@gmail.com> #17Nov 24, 2021 05:46PM

sc...@gmail.com <sc...@gmail.com> #18Nov 24, 2021 06:35PM

mi...@gmail.com <mi...@gmail.com> #19Nov 26, 2021 07:38PM

br...@gmail.com <br...@gmail.com> #20Dec 8, 2021 08:48PM

la...@gmail.com <la...@gmail.com> #21Dec 12, 2021 06:35AM

ch...@hotstar.com <ch...@hotstar.com> #22Dec 24, 2021 11:27AM

ja...@gmail.com <ja...@gmail.com> #23Jan 10, 2022 07:36AM

6o...@gmail.com <6o...@gmail.com> #24Jan 10, 2022 11:45PM

ko...@gmail.com <ko...@gmail.com> #25Jan 13, 2022 10:30AM

mu...@gmail.com <mu...@gmail.com> #26Jan 14, 2022 10:05AM

kl...@google.com <kl...@google.com> #27Jan 16, 2022 10:00PM

kl...@google.com <kl...@google.com> #28Jan 17, 2022 02:04AM

th...@gmail.com <th...@gmail.com> #29Jan 18, 2022 05:16AM

ct...@gmail.com <ct...@gmail.com> #30Jan 21, 2022 11:22AM

kl...@google.com <kl...@google.com> #31Jan 22, 2022 12:37AM

ap...@google.com <ap...@google.com> #32Jan 24, 2022 11:59PM

mo...@gmail.com <mo...@gmail.com> #33Jun 27, 2022 10:37PM

kl...@google.com <kl...@google.com> #34Jun 27, 2022 11:04PM

di...@gmail.com <di...@gmail.com> #35Dec 29, 2022 09:37AM

sh...@gmail.com <sh...@gmail.com> #36Feb 20, 2023 09:54PM

jo...@langlive.com <jo...@langlive.com> #37May 10, 2023 04:50AM

si...@sentbe.com <si...@sentbe.com> #38Apr 22, 2024 03:36AM

sy...@gmail.com <sy...@gmail.com> #39Apr 22, 2024 11:56AM

kl...@google.com <kl...@google.com> #40May 8, 2024 07:11PM

Add comment

Issue metadata