Feat: TextField can scroll when disabled #140922

bryanoli · 2024-01-03T22:15:36Z

This PR is adding a flag parameter to the TextField widget. This flag controls whether the TextField ignores pointers. The flag takes priority over other TextField behaviors such as enabled, so it can be useful when trying to have a disabled TextField that can be scrolled (behavior observed using TextArea on the web).

Adding a flag parameter to TextField helps with more customization and flexibility to the widget which can improve user experience. I am open to other ideas.

Fixes issue #140147

Before:

localhost_52348.-.Google.Chrome.2024-01-03.14-10-29.mp4

After:

localhost_52348.-.Google.Chrome.2024-01-03.14-03-39.mp4

Usage:

child: TextField(
  ignorePointer: false,
  enabled: false,
),

Pre-launch Checklist

I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
I read the [Tree Hygiene] wiki page, which explains my responsibilities.
I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement].
I signed the [CLA].
I listed at least one issue that this PR fixes in the description above.
I updated/added relevant documentation (doc comments with ///).
I added new tests to check the change I am making, or this PR is [test-exempt].
All existing and new tests are passing.

Renzo-Olivares · 2024-01-05T00:46:44Z

packages/flutter/test/material/text_field_test.dart

@@ -24,6 +24,7 @@ import 'package:flutter/rendering.dart';
 import 'package:flutter/services.dart';
 import 'package:flutter_test/flutter_test.dart';

+import '../cupertino/text_field_restoration_test.dart';


nit: I don't think this line is needed.

Renzo-Olivares · 2024-01-05T00:54:47Z

packages/flutter/lib/src/material/text_field.dart

@@ -604,6 +605,10 @@ class TextField extends StatefulWidget {
  /// [InputDecoration.enabled] property.
  final bool? enabled;

+  /// If false the text field is "disabled" but still scrollable.
+  /// However, if [enabled] is true, then the text field is "active" and still scrollable.
+  final bool? ignorePointer;


Maybe instead of discussing the specific scrollable use-case this parameter is solving, you could talk about what it does in general. i.e. ignorePointer decides whether the widget will handle pointer events.

+1, especially since this parameter doesn't actually cause the field to be disabled like enabled does.

Renzo-Olivares · 2024-01-05T00:57:27Z

packages/flutter/lib/src/material/text_field.dart

@@ -291,6 +291,7 @@ class TextField extends StatefulWidget {
    this.onAppPrivateCommand,
    this.inputFormatters,
    this.enabled,
+    this.ignorePointer,


nit: maybe ignoresPointers?

justinmc

The approach looks good, thanks for the PR! I'm on board with adding this parameter since it seems that we can't match textarea's behavior without it.

justinmc · 2024-01-05T20:31:25Z

packages/flutter/lib/src/material/text_field.dart

@@ -604,6 +605,10 @@ class TextField extends StatefulWidget {
  /// [InputDecoration.enabled] property.
  final bool? enabled;

+  /// If false the text field is "disabled" but still scrollable.
+  /// However, if [enabled] is true, then the text field is "active" and still scrollable.
+  final bool? ignorePointer;


+1, especially since this parameter doesn't actually cause the field to be disabled like enabled does.

justinmc · 2024-01-05T20:33:18Z

packages/flutter/lib/src/material/text_field.dart

@@ -985,7 +990,7 @@ class _TextFieldState extends State<TextField> with RestorationMixin implements
  final GlobalKey<EditableTextState> editableTextKey = GlobalKey<EditableTextState>();

  @override
-  bool get selectionEnabled => widget.selectionEnabled;
+  bool get selectionEnabled => widget.selectionEnabled && _isEnabled;


Why was this change needed?

This change was made because the text selection menu (copy, paste, etc...) opens up when right-clicking on the textfield when disabled (and ignorePointers set to false). So the selectionEnabled should take into account for _isEnabled to prevent selection in all cases when the widget is disabled.

Ah makes sense, thanks for the explanation.

justinmc · 2024-01-05T20:38:44Z

packages/flutter/test/material/text_field_test.dart

+    await gesture.moveBy(const Offset(0.0, -1000.0));
+    await tester.pump(const Duration(seconds: 1));
+    // Wait and drag again to trigger https://github.com/flutter/flutter/issues/6329
+    // (No idea why this is necessary, but the bug wouldn't repro without it.)


Hmm we need to figure that out. Maybe try pumpAndSettle for the previous one on line 6573?

justinmc · 2024-01-05T20:39:12Z

packages/flutter/test/material/text_field_test.dart

+    final Offset newFirstPos = textOffsetToPosition(tester, kMoreThanFourLines.indexOf('First'));
+    final Offset newFourthPos = textOffsetToPosition(tester, kMoreThanFourLines.indexOf('Fourth'));


Maybe finalFirstPos etc.

Renzo-Olivares

LGTM

justinmc

The only thing that I think should be changed is the tester.pump(const Duration(seconds: 1));, mentioned below. Otherwise this looks good.

justinmc · 2024-01-23T21:21:38Z

packages/flutter/lib/src/material/text_field.dart

+  ///
+  /// If true, this widget does not respond to pointer events,
+  /// If false this widget responds to all pointer events.
+  final bool? ignorePointers;


+1 to this suggestion.

justinmc · 2024-01-23T21:23:23Z

packages/flutter/test/material/text_field_test.dart

+    await gesture.moveBy(const Offset(0.0, -1000.0));
+    await tester.pumpAndSettle();
+    await gesture.moveBy(const Offset(0.0, -1000.0));
+    await tester.pump(const Duration(seconds: 1));


Does this work with pumpAndSettle instead? Same question for the similar pump a few lines below.

Yes, using pumpAndSettle does work.

justinmc

LGTM 👍 . Thanks for the fixes!

One last nit: don't forget this comment asking for a small change to the docs there.

justinmc · 2024-01-25T21:26:28Z

packages/flutter/test/material/text_field_test.dart

+    await gesture.moveBy(const Offset(0.0, -1000.0));
+    await tester.pumpAndSettle();
+    await gesture.up();
+    await tester.pump();


This pump is probably unnecessary.

… well

…40922)

…6013) Manual roll Flutter from 2f6fdf2650d4 to ace9181172b6 (57 revisions) Manual roll requested by stuartmorgan@google.com flutter/flutter@2f6fdf2...ace9181 2024-01-29 engine-flutter-autoroll@skia.org Roll Flutter Engine from 9c3ebf67b5da to bedafa8794b6 (4 revisions) (flutter/flutter#142478) 2024-01-29 jmccandless@google.com onNavigationNotification for *App.router (flutter/flutter#142190) 2024-01-29 fluttergithubbot@gmail.com Marks Mac_x64 framework_tests_misc to be unflaky (flutter/flutter#142118) 2024-01-29 engine-flutter-autoroll@skia.org Roll Flutter Engine from 3e2b8975bd5b to 9c3ebf67b5da (1 revision) (flutter/flutter#142472) 2024-01-29 66151079+bryanoli@users.noreply.github.com Feat: TextField can scroll when disabled (flutter/flutter#140922) 2024-01-29 engine-flutter-autoroll@skia.org Roll Flutter Engine from 436f91f3b06b to 3e2b8975bd5b (2 revisions) (flutter/flutter#142466) 2024-01-29 fluttergithubbot@gmail.com Marks Mac_arm64 framework_tests_misc to be unflaky (flutter/flutter#142119) 2024-01-29 goderbauer@google.com Fix InputDecorationTheme copyWith fallback for iconColor (flutter/flutter#142462) 2024-01-29 mbfakourii@gmail.com Add `SingleChildScrollView` for `NavigationRail` (flutter/flutter#137415) 2024-01-29 737941+loic-sharma@users.noreply.github.com [Windows Arm64] Run plugin test post-submit (flutter/flutter#141987) 2024-01-29 andrewrkolos@gmail.com Catch file system exceptions when trying to parse user-provided asset file paths (flutter/flutter#142214) 2024-01-29 nathan.wilson1232@gmail.com Implementing `switch` expressions in `foundation/` and `material/` (flutter/flutter#142279) 2024-01-29 engine-flutter-autoroll@skia.org Roll Flutter Engine from bff1e46c0d65 to 436f91f3b06b (1 revision) (flutter/flutter#142455) 2024-01-29 polinach@google.com Opt out test from leak tracking. (flutter/flutter#142417) 2024-01-29 zanderso@users.noreply.github.com Update Android minSdkVersion to 21 (flutter/flutter#142267) 2024-01-29 engine-flutter-autoroll@skia.org Roll Flutter Engine from 3d87470655b1 to bff1e46c0d65 (1 revision) (flutter/flutter#142446) 2024-01-29 engine-flutter-autoroll@skia.org Roll Packages from cbe8100 to 516648a (3 revisions) (flutter/flutter#142445) 2024-01-29 engine-flutter-autoroll@skia.org Roll Flutter Engine from 1405cb7b6e74 to 3d87470655b1 (1 revision) (flutter/flutter#142444) 2024-01-29 engine-flutter-autoroll@skia.org Roll Flutter Engine from 3e65f1720a6f to 1405cb7b6e74 (1 revision) (flutter/flutter#142432) 2024-01-29 engine-flutter-autoroll@skia.org Roll Flutter Engine from 210ed1dfb8cf to 3e65f1720a6f (1 revision) (flutter/flutter#142429) 2024-01-29 engine-flutter-autoroll@skia.org Roll Flutter Engine from f15cb86d31c3 to 210ed1dfb8cf (1 revision) (flutter/flutter#142426) 2024-01-29 engine-flutter-autoroll@skia.org Roll Flutter Engine from f3d48be76630 to f15cb86d31c3 (11 revisions) (flutter/flutter#142425) 2024-01-27 engine-flutter-autoroll@skia.org Roll Flutter Engine from 95e9a15fd909 to f3d48be76630 (1 revision) (flutter/flutter#142370) 2024-01-27 zanderso@users.noreply.github.com Add no-shuffle to language_version_test.dart (flutter/flutter#142378) 2024-01-27 engine-flutter-autoroll@skia.org Roll Flutter Engine from 2687ddb2655c to 95e9a15fd909 (8 revisions) (flutter/flutter#142369) 2024-01-27 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Roll Flutter Engine from 2687ddb2655c to 2adad88a39f4 (4 revisions)" (flutter/flutter#142366) 2024-01-27 engine-flutter-autoroll@skia.org Roll Flutter Engine from 2687ddb2655c to 2adad88a39f4 (4 revisions) (flutter/flutter#142362) 2024-01-27 engine-flutter-autoroll@skia.org Roll Flutter Engine from 45c06c22d5c7 to 2687ddb2655c (1 revision) (flutter/flutter#142359) 2024-01-27 31859944+LongCatIsLooong@users.noreply.github.com Remove suspicious constant from input decorator layout (flutter/flutter#142342) 2024-01-27 engine-flutter-autoroll@skia.org Roll Flutter Engine from 2e32acf4c31a to 45c06c22d5c7 (2 revisions) (flutter/flutter#142353) 2024-01-27 engine-flutter-autoroll@skia.org Roll Flutter Engine from a65a1b55e06a to 2e32acf4c31a (1 revision) (flutter/flutter#142351) 2024-01-26 engine-flutter-autoroll@skia.org Roll Flutter Engine from 525bd7dcf7f3 to a65a1b55e06a (11 revisions) (flutter/flutter#142347) 2024-01-26 goderbauer@google.com Relands "Add runWidget to bootstrap a widget tree without a default View" (flutter/flutter#142344) 2024-01-26 amirpanahandeh@yahoo.com Fix assertion failure when reordering two dimensional children (flutter/flutter#141504) 2024-01-26 magder@google.com Limit `fuchsia_precache` in presubmit to engine rolls (flutter/flutter#142333) 2024-01-26 49699333+dependabot[bot]@users.noreply.github.com Bump github/codeql-action from 3.23.1 to 3.23.2 (flutter/flutter#142345) 2024-01-26 andrewrkolos@gmail.com refactor asset bundle code to not depend on the global Cache.flutterRoot (flutter/flutter#142277) 2024-01-26 christopherfujino@gmail.com [flutter_tools] remove await runZonedGuarded() in tests (flutter/flutter#142336) 2024-01-26 15619084+vashworth@users.noreply.github.com Only use iOS 17 physical devices in staging tests (flutter/flutter#142323) 2024-01-26 dacoharkes@google.com Roll deps from dart-lang/native in templates (flutter/flutter#142322) 2024-01-26 andrewrkolos@gmail.com Remove duplicate global declaration of `UserMessages` (flutter/flutter#142281) 2024-01-26 magder@google.com Redistribute iOS TESTOWNERS (flutter/flutter#142315) 2024-01-26 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Add runWidget to bootstrap a widget tree without a default View" (flutter/flutter#142339) 2024-01-26 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Roll Flutter Engine from 525bd7dcf7f3 to 65d1291c3add (1 revision)" (flutter/flutter#142332) ...

github-actions bot added a: text input Entering text in a text field or keyboard related problems framework flutter/packages/flutter repository. See also f: labels. f: material design flutter/packages/flutter/material repository. labels Jan 3, 2024

Renzo-Olivares self-requested a review January 3, 2024 22:16

justinmc mentioned this pull request Jan 4, 2024

TextFormField is not scrollable when disabled #140147

Closed

2 tasks

justinmc self-requested a review January 4, 2024 23:23

Renzo-Olivares reviewed Jan 5, 2024

View reviewed changes

justinmc reviewed Jan 5, 2024

View reviewed changes

bryanoli requested review from jmagman and christopherfujino as code owners January 9, 2024 03:01

bryanoli force-pushed the bryanoli-textfield-scroll-disable-140147 branch from 7502f2f to ec56971 Compare January 9, 2024 04:41

jmagman removed their request for review January 9, 2024 18:53

christopherfujino removed their request for review January 9, 2024 20:14

bryanoli force-pushed the bryanoli-textfield-scroll-disable-140147 branch from d682ea8 to f405eae Compare January 23, 2024 20:21

bryanoli requested review from Renzo-Olivares and justinmc January 23, 2024 20:38

Renzo-Olivares approved these changes Jan 23, 2024

View reviewed changes

justinmc reviewed Jan 23, 2024

View reviewed changes

bryanoli force-pushed the bryanoli-textfield-scroll-disable-140147 branch from ce769e4 to 9cad5ae Compare January 24, 2024 23:23

justinmc approved these changes Jan 25, 2024

View reviewed changes

bryanoli added 10 commits January 26, 2024 09:09

Added flag for IgnorePointer

528bc1f

Added flag parameter for TextField and TextFormField. Created test as…

cbb26a1

… well

Fixed changes and documentation

b7ad6bc

Deleted unused package

bb48ab1

Added space and no trailing

0aa7e98

corrected documentation

609538d

Fixed documentation

a2de128

Added documentation

0dc1b8e

Changed tester.pump to pumpAndSettle

67b9c18

Added documentation when null, and remove test.pump

1743a58

bryanoli force-pushed the bryanoli-textfield-scroll-disable-140147 branch from 4b7c5fe to 1743a58 Compare January 26, 2024 17:10

Renzo-Olivares added the autosubmit Merge PR when tree becomes green via auto submit App label Jan 29, 2024

auto-submit bot merged commit 1d5c2c5 into flutter:master Jan 29, 2024
66 checks passed

engine-flutter-autoroll mentioned this pull request Jan 30, 2024

Manual roll Flutter from 2f6fdf2650d4 to ace9181172b6 (57 revisions) flutter/packages#6013

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 30, 2024

1d5c2c511 Feat: TextField can scroll when disabled (flutter/flutter#1…

4d4c66b

…40922)

engine-flutter-autoroll mentioned this pull request Jan 30, 2024

Roll Flutter from 2f6fdf2650d4 to ccb2b4439a43 (68 revisions) flutter/packages#6014

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 30, 2024

1d5c2c511 Feat: TextField can scroll when disabled (flutter/flutter#1…

4a31400

…40922)

engine-flutter-autoroll mentioned this pull request Jan 30, 2024

Roll Flutter from 2f6fdf2650d4 to 72dc162ff052 (69 revisions) flutter/packages#6015

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 30, 2024

1d5c2c511 Feat: TextField can scroll when disabled (flutter/flutter#1…

d12cb14

…40922)

HansMuller mentioned this pull request Feb 2, 2024

Flutter Framework Team: Notable Commits #121415

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat: TextField can scroll when disabled #140922

Feat: TextField can scroll when disabled #140922

bryanoli commented Jan 3, 2024 •

edited

Renzo-Olivares Jan 5, 2024

Renzo-Olivares Jan 5, 2024

justinmc Jan 5, 2024

Renzo-Olivares Jan 5, 2024

justinmc left a comment

justinmc Jan 5, 2024

justinmc Jan 5, 2024

bryanoli Jan 9, 2024

justinmc Jan 9, 2024

justinmc Jan 5, 2024

justinmc Jan 5, 2024

Renzo-Olivares left a comment

justinmc left a comment •

edited

justinmc Jan 23, 2024

justinmc Jan 23, 2024

bryanoli Jan 24, 2024

justinmc left a comment

justinmc Jan 25, 2024

		final Offset newFirstPos = textOffsetToPosition(tester, kMoreThanFourLines.indexOf('First'));
		final Offset newFourthPos = textOffsetToPosition(tester, kMoreThanFourLines.indexOf('Fourth'));

Feat: TextField can scroll when disabled #140922

Feat: TextField can scroll when disabled #140922

Conversation

bryanoli commented Jan 3, 2024 • edited

Pre-launch Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

justinmc left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Renzo-Olivares left a comment

Choose a reason for hiding this comment

justinmc left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

justinmc left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bryanoli commented Jan 3, 2024 •

edited

justinmc left a comment •

edited