[API] SoftwareKeyboardController should be hosted state [168778053]

Fixed

Bug

Status Update

No update yet.

Description

js...@google.com

created issue #1

Sep 17, 2020 09:50AM

Specifically, a user wanted to "close the software keyboard in onClick on a button", and Fudge's workaround was to capture the SoftwareKeyboardController in the onTextInputStarted callback and write it into a field in the parent. var controller by remember { mutableStateOf<SoftwareKeyboardController?> { null } } Button("Close", onClick={controller!!.hideSoftwareKeyboard()}) // Pray this doesn't crash (NPE) TextField(value=..., onClick=..., onTextInputStarted={c -> controller = c})

A better pattern would be to have the user create a SoftwareKeyboardController as-if it were a hoisted state object and pass it into the TextField. val controller by remember { SoftwareKeyboardController() } Button("Close", onClick={controller.hideSoftwareKeyboard()}) TextField(value=..., onClick=..., controller=controller)

We realize/expect this requires playing a bit of a trick with the internal implementation of the SoftwareKeyboardController, to make the hideSoftwareKeyboard() function capable of operating as if it were the source of truth, even though the actual source of truth doesn't exist until later when the TextField is initialized by Android, which is probably one reason why it didn't occur to the original author of this widget. But it results in a much cleaner declarative API with less reasoning about the flow of information.

Discussion in API Council back in August, but I don't think a bug ever got filed for this.

Comments

si...@google.com <si...@google.com> #2Oct 8, 2020 01:30AM

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

commit 9082f62682f853ad5251a1c79dde9eccba7abdd9
Author: Max Alfonso-Ying <maxying@google.com>
Date: Thu Apr 18 00:34:40 2024

[M2 text field] Apply background to decoration box

...instead of to the BasicTextField, so changing the
backgroundColor will properly change the decoration
box's background color.

Fixes:

b/307694651

Test: added unit tests
Relnote: "Fix backgroundColor not applying to
TextFieldDecorationBox and OutlinedTextFieldDecorationBox.
Decoration boxes now accept a `shape` parameter."
Change-Id: I371c26718597cb36ac537e9412ce476532afb40d

M compose/material/material/api/current.txt
M compose/material/material/api/restricted_current.txt
M compose/material/material/integration-tests/material-demos/src/main/java/androidx/compose/material/demos/TextFieldDecorationBoxDemos.kt
M compose/material/material/src/androidInstrumentedTest/kotlin/androidx/compose/material/textfield/TextFieldDecorationBoxTest.kt
M compose/material/material/src/commonMain/kotlin/androidx/compose/material/OutlinedTextField.kt
M compose/material/material/src/commonMain/kotlin/androidx/compose/material/TextField.kt
M compose/material/material/src/commonMain/kotlin/androidx/compose/material/TextFieldDefaults.kt
M compose/material/material/src/commonMain/kotlin/androidx/compose/material/TextFieldImpl.kt

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

tc...@google.com <tc...@google.com> #3Jan 8, 2021 02:41AM

This feature is currently on the Compose Beta hotlist or one of its dependencies. Can you please confirm that you intend to complete it in time for Beta by adding it to one of the upcoming iterations or remove it from the hotlist? Thank you!

si...@google.com <si...@google.com> Jan 14, 2021 05:12PM

Reassigned to si...@google.com.

si...@google.com <si...@google.com> Jan 22, 2021 08:58PM

Reassigned to an...@google.com.

si...@google.com <si...@google.com> Jan 22, 2021 11:09PM

Reassigned to se...@google.com.

se...@google.com <se...@google.com> Jan 23, 2021 12:59AM

Accepted by se...@google.com.

ap...@google.com <ap...@google.com> #4Feb 11, 2021 09:14AM

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

commit d46aa1d604c3c3177e084652bdc234401dc60e74
Author: Sean McQuillan <seanmcq@google.com>
Date: Wed Feb 10 13:44:12 2021

Remove SoftwareKeyboardController

This change removes the callback APIs that were previously on
BasicTextField, and all Material TextField implementations. Calls to
control the keyboard are not possible via any high level APIs after this
commit.

A new API to control the keyboard will be added in another CL to follow.

Bug:

b/168778053

Relnote: "Removed SoftwareKeyboardController callback from all text
fields to be replaced by a new API shortly."
Test: Automated, manual, and demos

Change-Id: Iae869e91c48300f4ab926dac2578d2d759f5fd89

M compose/foundation/foundation/api/current.txt
M compose/foundation/foundation/api/public_plus_experimental_current.txt
M compose/foundation/foundation/api/restricted_current.txt
M compose/foundation/foundation/integration-tests/foundation-demos/src/main/java/androidx/compose/foundation/demos/text/CapitalizationAutoCorrectDemo.kt
M compose/foundation/foundation/integration-tests/foundation-demos/src/main/java/androidx/compose/foundation/demos/text/ComposeInputField.kt
M compose/foundation/foundation/integration-tests/foundation-demos/src/main/java/androidx/compose/foundation/demos/text/KeyboardSingleLineDemo.kt
D compose/foundation/foundation/src/androidAndroidTest/kotlin/androidx/compose/foundation/textfield/SoftwareKeyboardTest.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/text/BasicTextField.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/text/CoreTextField.kt
M compose/material/material/api/current.txt
M compose/material/material/api/public_plus_experimental_current.txt
M compose/material/material/api/restricted_current.txt
M compose/material/material/samples/src/main/java/androidx/compose/material/samples/TextFieldSamples.kt
M compose/material/material/src/androidAndroidTest/kotlin/androidx/compose/material/textfield/OutlinedTextFieldTest.kt
M compose/material/material/src/androidAndroidTest/kotlin/androidx/compose/material/textfield/TextFieldTest.kt
M compose/material/material/src/commonMain/kotlin/androidx/compose/material/OutlinedTextField.kt
M compose/material/material/src/commonMain/kotlin/androidx/compose/material/TextField.kt
M compose/material/material/src/commonMain/kotlin/androidx/compose/material/TextFieldImpl.kt
M compose/ui/ui-text/api/current.txt
M compose/ui/ui-text/api/public_plus_experimental_current.txt
M compose/ui/ui-text/api/restricted_current.txt
D compose/ui/ui-text/src/commonMain/kotlin/androidx/compose/ui/text/SoftwareKeyboardController.kt

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

se...@google.com <se...@google.com> Feb 11, 2021 07:23PM

Assigned to se...@google.com.

se...@google.com <se...@google.com> Feb 11, 2021 11:12PM

Accepted by se...@google.com.

ap...@google.com <ap...@google.com> #5Feb 12, 2021 07:20AM

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

commit 861a7056fe4240312c0664879406eb28e6742191
Author: Sean McQuillan <seanmcq@google.com>
Date: Thu Feb 11 16:53:46 2021

Add new SoftwareKeyboardController interface

Exposed via a composition local API LocalSoftwareKeyboardController.current.

This replaces the previous SoftwareKeyboardController interface
available on BasicTextField and other TextField variants.

Changes:
- Added a new demo SoftwareKeyboardControllerDemo
- New API for controlling SoftwareKeyboard externally to TextFields

Relnote: "Added new LocalSoftwareKeyboardController composition local
API to replace previous SoftwareKeyboardController interface on
TextField."
Test: Manual, automatic, demos
Bug:

b/168778053

Change-Id: I84472a517db4b15345302346c967e7c6b359109b

M compose/foundation/foundation/integration-tests/foundation-demos/src/main/java/androidx/compose/foundation/demos/text/CapitalizationAutoCorrectDemo.kt
M compose/foundation/foundation/integration-tests/foundation-demos/src/main/java/androidx/compose/foundation/demos/text/ComposeInputField.kt
M compose/foundation/foundation/integration-tests/foundation-demos/src/main/java/androidx/compose/foundation/demos/text/KeyboardSingleLineDemo.kt
M compose/material/material/samples/src/main/java/androidx/compose/material/samples/TextFieldSamples.kt
M compose/material/material/src/androidAndroidTest/kotlin/androidx/compose/material/textfield/TextFieldTest.kt
M compose/ui/ui/api/current.txt
M compose/ui/ui/api/public_plus_experimental_current.txt
M compose/ui/ui/api/restricted_current.txt
A compose/ui/ui/integration-tests/ui-demos/src/main/java/androidx/compose/ui/demos/SoftwareKeyboardControllerDemo.kt
M compose/ui/ui/integration-tests/ui-demos/src/main/java/androidx/compose/ui/demos/UiDemos.kt
A compose/ui/ui/src/androidAndroidTest/kotlin/androidx/compose/ui/platform/LocalSoftwareKeyboardControllerTest.kt
M compose/ui/ui/src/androidMain/kotlin/androidx/compose/ui/text/input/TextInputServiceAndroid.android.kt
A compose/ui/ui/src/commonMain/kotlin/androidx/compose/ui/platform/LocalSoftwareKeyboardController.kt
A compose/ui/ui/src/commonMain/kotlin/androidx/compose/ui/platform/SoftwareKeyboardController.kt

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

ap...@google.com <ap...@google.com> #6Feb 17, 2021 04:40PM

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

commit b11ae5ab95f5c9ccea1c46ab749d64fc28db4f04
Author: Sean McQuillan <seanmcq@google.com>
Date: Tue Feb 16 18:24:44 2021

Add SoftwareKeyboardController.

----
Revert "Revert "Add new SoftwareKeyboardController interface""

This reverts commit 070816bb482f21ce33955f845cccc99e7eab0630.

Reason for revert:

- Re-adding SoftwareKeyboardController after beta cut due to last minute revert.

Relnote: "Added new LocalSoftwareKeyboardController composition local
API to replace previous SoftwareKeyboardController interface on
TextField."
Test: Manual, automatic, demos
Bug:

b/168778053

Change-Id: I658b6bfc5c917db486c631312e3456469a615831

M compose/foundation/foundation/integration-tests/foundation-demos/src/main/java/androidx/compose/foundation/demos/text/CapitalizationAutoCorrectDemo.kt
M compose/foundation/foundation/integration-tests/foundation-demos/src/main/java/androidx/compose/foundation/demos/text/ComposeInputField.kt
M compose/foundation/foundation/integration-tests/foundation-demos/src/main/java/androidx/compose/foundation/demos/text/KeyboardSingleLineDemo.kt
M compose/material/material/samples/src/main/java/androidx/compose/material/samples/TextFieldSamples.kt
M compose/material/material/src/androidAndroidTest/kotlin/androidx/compose/material/textfield/TextFieldTest.kt
M compose/ui/ui/api/current.txt
M compose/ui/ui/api/public_plus_experimental_current.txt
M compose/ui/ui/api/restricted_current.txt
A compose/ui/ui/integration-tests/ui-demos/src/main/java/androidx/compose/ui/demos/SoftwareKeyboardControllerDemo.kt
M compose/ui/ui/integration-tests/ui-demos/src/main/java/androidx/compose/ui/demos/UiDemos.kt
A compose/ui/ui/samples/src/main/java/androidx/compose/ui/samples/SoftwareKeyboardControllerSample.kt
A compose/ui/ui/src/androidAndroidTest/kotlin/androidx/compose/ui/platform/LocalSoftwareKeyboardControllerTest.kt
M compose/ui/ui/src/androidMain/kotlin/androidx/compose/ui/text/input/TextInputServiceAndroid.android.kt
A compose/ui/ui/src/commonMain/kotlin/androidx/compose/ui/platform/LocalSoftwareKeyboardController.kt
A compose/ui/ui/src/commonMain/kotlin/androidx/compose/ui/platform/SoftwareKeyboardController.kt

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

ap...@google.com <ap...@google.com> #7Feb 23, 2021 12:23AM

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

commit 291aa6c357ee9c232a29e707f606a747d67ac9f4
Author: Sean McQuillan <seanmcq@google.com>
Date: Tue Feb 16 18:24:44 2021

Add SoftwareKeyboardController.

Relnote: "Added new LocalSoftwareKeyboardController composition local
API to replace previous SoftwareKeyboardController interface on
TextField."

Test: Manual, automatic, demos

Bug:

b/168778053

Change-Id: I5951e802fbec7c26862b976de64b78640accd1f7

M compose/foundation/foundation/integration-tests/foundation-demos/src/main/java/androidx/compose/foundation/demos/text/CapitalizationAutoCorrectDemo.kt
M compose/foundation/foundation/integration-tests/foundation-demos/src/main/java/androidx/compose/foundation/demos/text/ComposeInputField.kt
M compose/foundation/foundation/integration-tests/foundation-demos/src/main/java/androidx/compose/foundation/demos/text/KeyboardSingleLineDemo.kt
M compose/material/material/samples/src/main/java/androidx/compose/material/samples/TextFieldSamples.kt
M compose/material/material/src/androidAndroidTest/kotlin/androidx/compose/material/textfield/TextFieldTest.kt
M compose/ui/ui/api/1.0.0-beta02.txt
M compose/ui/ui/api/current.txt
M compose/ui/ui/api/public_plus_experimental_1.0.0-beta02.txt
M compose/ui/ui/api/public_plus_experimental_current.txt
M compose/ui/ui/api/restricted_1.0.0-beta02.txt
M compose/ui/ui/api/restricted_current.txt
A compose/ui/ui/integration-tests/ui-demos/src/main/java/androidx/compose/ui/demos/SoftwareKeyboardControllerDemo.kt
M compose/ui/ui/integration-tests/ui-demos/src/main/java/androidx/compose/ui/demos/UiDemos.kt
A compose/ui/ui/samples/src/main/java/androidx/compose/ui/samples/SoftwareKeyboardControllerSample.kt
A compose/ui/ui/src/androidAndroidTest/kotlin/androidx/compose/ui/platform/LocalSoftwareKeyboardControllerTest.kt
M compose/ui/ui/src/androidMain/kotlin/androidx/compose/ui/text/input/TextInputServiceAndroid.android.kt
A compose/ui/ui/src/commonMain/kotlin/androidx/compose/ui/platform/LocalSoftwareKeyboardController.kt
A compose/ui/ui/src/commonMain/kotlin/androidx/compose/ui/platform/SoftwareKeyboardController.kt

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

se...@google.com <se...@google.com> Feb 23, 2021 12:54AM

Marked as fixed.

Issue 168778053

Description

Issue summary

Comments

si...@google.com <si...@google.com> #2Oct 8, 2020 01:30AM

tc...@google.com <tc...@google.com> #3Jan 8, 2021 02:41AM

si...@google.com <si...@google.com> Jan 14, 2021 05:12PM

si...@google.com <si...@google.com> Jan 22, 2021 08:58PM

si...@google.com <si...@google.com> Jan 22, 2021 11:09PM

se...@google.com <se...@google.com> Jan 23, 2021 12:59AM

ap...@google.com <ap...@google.com> #4Feb 11, 2021 09:14AM

se...@google.com <se...@google.com> Feb 11, 2021 07:23PM

se...@google.com <se...@google.com> Feb 11, 2021 11:12PM

ap...@google.com <ap...@google.com> #5Feb 12, 2021 07:20AM

ap...@google.com <ap...@google.com> #6Feb 17, 2021 04:40PM

ap...@google.com <ap...@google.com> #7Feb 23, 2021 12:23AM

se...@google.com <se...@google.com> Feb 23, 2021 12:54AM

Add comment

Issue metadata