maxLength in TextField [170648072]

Fixed

Feature Request

Status Update

No update yet.

Description

si...@google.com

created issue #1

Oct 12, 2020 06:17PM

platform had issues with maxLength not set.
We should put a maxLength into TextField and set a default value.

Comments

si...@google.com <si...@google.com> Jun 16, 2021 03:42PM

Status: Won't Fix (Obsolete)

al...@lyft.com <al...@lyft.com> #2Jun 17, 2021 06:20PM

Project: platform/frameworks/support
Branch: androidx-master-dev

commit c60f33e229e31ab328ef6b59dab63b264954831c
Author: Alexandre Elias <aelias@google.com>
Date: Fri Jul 10 16:23:09 2020

Semantics no-op cleanups

Partly in response to lmr's broad code review, I did a pass of
superficial API/implementation cleanup. The main changes are:

- I changed each Boolean SemanticsProperty where false is equivalent to
not being present to take "Unit" instead. This is conceptually
clearer: it avoids questions like "can I cancel out a semantics from a
merged child by setting it to false?" Because "property = Unit" looks
weird, I also changed the style of these to "property()".

- I moved the Semantics id generator closer to where it's used, in
SemanticsModifierCore. I made it internal and an AtomicInt.
(Note that integer ids are heavily used in the Android
AccessibilityNodeInfo APIs so I can't simply remove them entirely.)

- I deleted dead code. Some examples include SemanticsHintOverrides,
a public API not connected to anything, and SemanticsPropertyKey
merge() open method which is never called. (In both cases I have
a different plan in mind for accessibility.)

Fixes: 145951226
Fixes: 145955412
Test: existing tests
Relnote: "Single-value semantics properties now use a calling style.
For example, 'semantics { hidden = true }' is now written as:
'semantics { hidden() }'."

Change-Id: Ic1afd12ea22c926babc9662f1804d80b33aa0cfc

M ui/integration-tests/benchmark/src/androidTest/java/androidx/ui/benchmark/test/LayoutNodeModifierBenchmark.kt
M ui/ui-core/api/0.1.0-dev15.txt
M ui/ui-core/api/current.txt
M ui/ui-core/api/public_plus_experimental_0.1.0-dev15.txt
M ui/ui-core/api/public_plus_experimental_current.txt
M ui/ui-core/api/restricted_0.1.0-dev15.txt
M ui/ui-core/api/restricted_current.txt
M ui/ui-core/src/androidAndroidTest/kotlin/androidx/ui/graphics/vector/VectorTest.kt
M ui/ui-core/src/androidAndroidTest/kotlin/androidx/ui/semantics/SemanticsTests.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidActuals.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidComposeView.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidComposeViewAccessibilityDelegateCompat.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidPopup.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/Expect.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsConfiguration.kt
D ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsHintOverrides.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsModifier.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsNode.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsOwner.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsWrapper.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/semantics/SemanticsProperties.kt
M ui/ui-foundation/api/0.1.0-dev15.txt
M ui/ui-foundation/api/current.txt
M ui/ui-foundation/api/public_plus_experimental_0.1.0-dev15.txt
M ui/ui-foundation/api/public_plus_experimental_current.txt
M ui/ui-foundation/api/restricted_0.1.0-dev15.txt
M ui/ui-foundation/api/restricted_current.txt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/Clickable.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/Dialog.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/Scroller.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/selection/Selectable.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/selection/Toggleable.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/semantics/FoundationSemanticsProperties.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/ButtonTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/CardTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/CheckboxScreenshotTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/RadioButtonScreenshotTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/ScaffoldTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/SnackbarTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/SurfaceTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/ripple/RippleIndicationTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/textfield/TextFieldScreenshotTest.kt
M ui/ui-material/src/main/java/androidx/ui/material/AppBar.kt
M ui/ui-material/src/main/java/androidx/ui/material/TextFieldImpl.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/AssertsTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/CallSemanticsActionTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/ErrorMessagesTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/FindersTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/PrintToStringTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/ScrollToTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/TextActionsTest.kt
M ui/ui-test/src/main/java/androidx/ui/test/Actions.kt
M ui/ui-test/src/main/java/androidx/ui/test/Filters.kt
M ui/ui-text/api/0.1.0-dev15.txt
M ui/ui-text/api/current.txt
M ui/ui-text/api/public_plus_experimental_0.1.0-dev15.txt
M ui/ui-text/api/public_plus_experimental_current.txt
M ui/ui-text/api/restricted_0.1.0-dev15.txt
M ui/ui-text/api/restricted_current.txt
M ui/ui-text/src/commonMain/kotlin/androidx/ui/text/CoreTextField.kt
M ui/ui-text/src/commonMain/kotlin/androidx/ui/text/TextSemanticsProperties.kt

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

si...@google.com <si...@google.com> #3Jun 18, 2021 03:56PM

Assigned to an...@google.com.

oh, i actually missed why I created the issue. maxLength is something that can be done via the TextField callback. however the issue was with providing a default text limit to TextField for mainly performance.

Thanks for the ping, I agree with you now.

al...@gmail.com <al...@gmail.com> #4Jun 19, 2021 09:40PM

Thanks! Yes, I agree that workaround works mostly fine (and it is what we are doing now in our own design system library). However, I think the workaround has one issue (aside from performance)... once the user reaches the max length, the workaround ensures that the display won't render any new characters. However, I believe those keystrokes are still being reported to the InputMethodService because I see the keyboard auto-suggestions briefly updating for a split second. Not completely sure the implications of this on keyboards but worth noting.

an...@gmail.com <an...@gmail.com> #5Dec 11, 2021 02:14PM

What's the workaround , I am having an issue where the text is cleared once i get to the max length

al...@gmail.com <al...@gmail.com> #6Apr 28, 2022 04:06PM

This issue is also important for accessibility. When the maximum length is reached, Talkback should automatically announce "Maximum length reached" like it does with views.

al...@gmail.com <al...@gmail.com> #7Feb 7, 2024 06:14PM

Have there been any recent updates with this?

ha...@google.com <ha...@google.com> #8Feb 8, 2024 01:44PM

BasicTextField2 introduces InputTransformation API that has a prefab maxLengthInChars and maxLengthInCodepoints factory functions. These will correctly update the IME whenever the max length is reached. Current BasicTextField holds 3 states including the hoisted one that does the filtering. Before filtering is committed in the next composition, IME for a brief period of time thinks that every key stroke is accepted by the editor. InputTransformation prevents this by executing the callback at the right time.

Also, thanks for pointing out the maxLength a11y node info property. We will take this into account.

ap...@google.com <ap...@google.com> #9Feb 14, 2024 12:32AM

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

commit fc0d3637cd2030cde12f4eb00c687d6f46dd97e7
Author: Halil Ozercan <halilibo@google.com>
Date: Fri Feb 09 14:53:31 2024

Add MaxTextLength to semantics for a11y

MaxTextLength is used by talkback to announce that the text field has reached its maximum length. Current TextField APIs fully hoist the filtering mechanism, so it's not possible to infer whether a max length filter is applied. Devs will need to explicitly add this info to their semantics.

A follow-up CL will address this requirement for the new BasicTextField(state).

Bug: 170648072
Test: gradle :compose:ui:ui:cAT
Relnote: "Add `maxTextLength` semantics property that should be set on text fields that filter the maximum allowed number of characters."
Change-Id: I24d9f6b2aa6f1e94b67847464314480dd80e8245

M compose/ui/ui/api/current.txt
M compose/ui/ui/api/restricted_current.txt
M compose/ui/ui/src/androidInstrumentedTest/kotlin/androidx/compose/ui/AndroidComposeViewAccessibilityDelegateCompatTest.kt
M compose/ui/ui/src/androidMain/kotlin/androidx/compose/ui/platform/AndroidComposeViewAccessibilityDelegateCompat.android.kt
M compose/ui/ui/src/commonMain/kotlin/androidx/compose/ui/semantics/SemanticsProperties.kt

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

ap...@google.com <ap...@google.com> #10Feb 28, 2024 06:49PM

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

commit 17ed60946fd0000d84dd81f318577b2d389951a9
Author: Halil Ozercan <halilibo@google.com>
Date: Fri Feb 09 15:27:14 2024

Semantics override for InputTransformation

With the addition of MaxTextLength semantics property, MaxLengthFilter should also be able to change the semantics of the `BasicTextField2` that it's attached to. Moreover, any custom `InputTransformation` may have different semantics implications. Rather than adding extra semantics modifiers to TextFields, `InputTransformation` should be able to influence the semantics organically.

Bug: 170648072
Test: gradle :compose:foundation:foundation:cAT
Relnote: "Add an optional `applySemantics` function to `InputTransformation` to influence the semantics of the `BasicTextField2` that it's applied to."
Change-Id: I74a2f4db178fe2660862749f10367bac57761ae9

M compose/foundation/foundation/api/current.txt
M compose/foundation/foundation/api/restricted_current.txt
M compose/foundation/foundation/src/androidInstrumentedTest/kotlin/androidx/compose/foundation/text/input/BasicTextFieldSemanticsTest.kt
M compose/foundation/foundation/src/androidUnitTest/kotlin/androidx/compose/foundation/text/input/InputTransformationTest.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/text/input/InputTransformation.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/text/input/internal/TextFieldDecoratorModifier.kt

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

ha...@google.com <ha...@google.com> #11Apr 12, 2024 04:22PM

Marked as fixed, reassigned to ha...@google.com.

I'm closing this issue since we now ship a prefab InputTransformation.maxLength that also applies MaxTextLength semantics.