Skip to content

EditableText should not allow horizontal scrolling on iOS#162841

Merged
auto-submit[bot] merged 7 commits intoflutter:masterfrom
Renzo-Olivares:cupertino-editable-horizontal-scrolling
Apr 23, 2025
Merged

EditableText should not allow horizontal scrolling on iOS#162841
auto-submit[bot] merged 7 commits intoflutter:masterfrom
Renzo-Olivares:cupertino-editable-horizontal-scrolling

Conversation

@Renzo-Olivares
Copy link
Contributor

@Renzo-Olivares Renzo-Olivares commented Feb 6, 2025 •
edited
Loading

Fixes #25553

On iOS single-line TextFields are not scrollable with user input, for example a pan gesture to move the viewport. They can still be scrolled when the user drags the selection handles. Scrolling remains the same for multi-line TextFields. A user can override this by providing CupertinoTextField/TextField/EditableText with a custom scrollPhysics.

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].
  • I followed the [breaking change policy] and added [Data Driven Fixes] where supported.
  • All existing and new tests are passing.

@github-actions 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. and removed f: material design flutter/packages/flutter/material repository. labels Feb 6, 2025
justinmc
justinmc approved these changes Feb 18, 2025
View reviewed changes
Copy link
Contributor

@justinmc justinmc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍 . Solid simple fix, we should have done something like this a long time ago.

packages/flutter/lib/src/widgets/editable_text.dart Outdated
}

class _NeverUserScrollableScrollPhysics extends ScrollPhysics {
/// Creates scroll physics that does not let the user scroll, but allows for programatic scrolling.
Copy link
Contributor

@justinmc justinmc Feb 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: Maybe say that it does not let the user scroll "by dragging" or "by panning" to be more specific? Or maybe I'm being too pedantic.

packages/flutter/test/widgets/editable_text_test.dart Outdated
);

testWidgets(
'single-line field cannot be scroll with touch on iOS',
Copy link
Contributor

@justinmc justinmc Feb 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit "be scroll" => "be scrolled"

packages/flutter/lib/src/widgets/editable_text.dart
physics: widget.scrollPhysics,
// On iOS a single-line TextField should not scroll.
physics:
widget.scrollPhysics ??
Copy link
Contributor

@justinmc justinmc Feb 18, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm glad this is overridable if the developer still wants to enable scrolling 👍

packages/flutter/lib/src/widgets/editable_text.dart
axisDirection: _isMultiline ? AxisDirection.down : AxisDirection.right,
controller: _scrollController,
physics: widget.scrollPhysics,
// On iOS a single-line TextField should not scroll.
Copy link
Contributor

@justinmc justinmc Feb 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good call explaining this.

@flutter-dashboard
Copy link

flutter-dashboard bot commented Mar 10, 2025

This pull request executed golden file tests, but it has not been updated in a while (20+ days). Test results from Gold expire after as many days, so this pull request will need to be updated with a fresh commit in order to get results from Gold.

For more guidance, visit Writing a golden file test for package:flutter.

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

@Renzo-Olivares Renzo-Olivares force-pushed the cupertino-editable-horizontal-scrolling branch from 46c1177 to 85567c7 Compare April 15, 2025 00:12
@Renzo-Olivares Renzo-Olivares force-pushed the cupertino-editable-horizontal-scrolling branch from d6112dd to 6d69ced Compare April 15, 2025 21:51
@github-actions github-actions bot added the f: material design flutter/packages/flutter/material repository. label Apr 15, 2025
@Renzo-Olivares Renzo-Olivares added the autosubmit Merge PR when tree becomes green via auto submit App label Apr 23, 2025
@auto-submit auto-submit bot added this pull request to the merge queue Apr 23, 2025
Merged via the queue into flutter:master with commit 03b7c23 Apr 23, 2025
75 checks passed
@flutter-dashboard flutter-dashboard bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Apr 23, 2025
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Apr 24, 2025
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Apr 24, 2025
@engine-flutter-autoroll
03b7c23 EditableText should not allow horizontal scrolling on iOS (fl…
7dc83f7 
…utter/flutter#162841)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Apr 24, 2025
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Apr 24, 2025
@engine-flutter-autoroll
03b7c23 EditableText should not allow horizontal scrolling on iOS (fl…
6cd83e6 
…utter/flutter#162841)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Apr 24, 2025
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Apr 24, 2025
@engine-flutter-autoroll
03b7c23 EditableText should not allow horizontal scrolling on iOS (fl…
a38ea80 
…utter/flutter#162841)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Apr 24, 2025
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Apr 24, 2025
@engine-flutter-autoroll
03b7c23 EditableText should not allow horizontal scrolling on iOS (fl…
881e1a0 
…utter/flutter#162841)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Apr 24, 2025
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Apr 29, 2025
@engine-flutter-autoroll
03b7c23 EditableText should not allow horizontal scrolling on iOS (fl…
5ddf2bd 
…utter/flutter#162841)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Apr 30, 2025
@engine-flutter-autoroll
03b7c23 EditableText should not allow horizontal scrolling on iOS (fl…
3c0081e 
…utter/flutter#162841)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Apr 30, 2025
@engine-flutter-autoroll
03b7c23 EditableText should not allow horizontal scrolling on iOS (fl…
6b34cf2 
…utter/flutter#162841)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 1, 2025
@engine-flutter-autoroll
03b7c23 EditableText should not allow horizontal scrolling on iOS (fl…
ffb6857 
…utter/flutter#162841)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 1, 2025
@engine-flutter-autoroll
03b7c23 EditableText should not allow horizontal scrolling on iOS (fl…
2d45f71 
…utter/flutter#162841)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 1, 2025
@engine-flutter-autoroll
03b7c23 EditableText should not allow horizontal scrolling on iOS (fl…
499450c 
…utter/flutter#162841)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 1, 2025
@engine-flutter-autoroll
03b7c23 EditableText should not allow horizontal scrolling on iOS (fl…
552ee18 
…utter/flutter#162841)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 1, 2025
@engine-flutter-autoroll
03b7c23 EditableText should not allow horizontal scrolling on iOS (fl…
ea4a3aa 
…utter/flutter#162841)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 1, 2025
@engine-flutter-autoroll
03b7c23 EditableText should not allow horizontal scrolling on iOS (fl…
da175d0 
…utter/flutter#162841)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 1, 2025
@engine-flutter-autoroll
03b7c23 EditableText should not allow horizontal scrolling on iOS (fl…
a7eef7c 
…utter/flutter#162841)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 2, 2025
@engine-flutter-autoroll
03b7c23 EditableText should not allow horizontal scrolling on iOS (fl…
2ed9cf0 
…utter/flutter#162841)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 2, 2025
@engine-flutter-autoroll
03b7c23 EditableText should not allow horizontal scrolling on iOS (fl…
cbe44a2 
…utter/flutter#162841)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 2, 2025
@engine-flutter-autoroll
03b7c23 EditableText should not allow horizontal scrolling on iOS (fl…
4755243 
…utter/flutter#162841)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 2, 2025
@engine-flutter-autoroll
03b7c23 EditableText should not allow horizontal scrolling on iOS (fl…
a5a7e24 
…utter/flutter#162841)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 2, 2025
@engine-flutter-autoroll
03b7c23 EditableText should not allow horizontal scrolling on iOS (fl…
2d46f54 
…utter/flutter#162841)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 3, 2025
@engine-flutter-autoroll
03b7c23 EditableText should not allow horizontal scrolling on iOS (fl…
d95f046 
…utter/flutter#162841)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 3, 2025
@engine-flutter-autoroll
03b7c23 EditableText should not allow horizontal scrolling on iOS (fl…
ecfc3a3 
…utter/flutter#162841)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 4, 2025
@engine-flutter-autoroll
03b7c23 EditableText should not allow horizontal scrolling on iOS (fl…
ca76f64 
…utter/flutter#162841)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 5, 2025
@engine-flutter-autoroll
03b7c23 EditableText should not allow horizontal scrolling on iOS (fl…
5172c9d 
…utter/flutter#162841)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 5, 2025
@engine-flutter-autoroll
03b7c23 EditableText should not allow horizontal scrolling on iOS (fl…
3d5a77a 
…utter/flutter#162841)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 5, 2025
@engine-flutter-autoroll
03b7c23 EditableText should not allow horizontal scrolling on iOS (fl…
fd6d2e1 
…utter/flutter#162841)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 5, 2025
@engine-flutter-autoroll
03b7c23 EditableText should not allow horizontal scrolling on iOS (fl…
f326230 
…utter/flutter#162841)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 5, 2025
@engine-flutter-autoroll
03b7c23 EditableText should not allow horizontal scrolling on iOS (fl…
6001b6d 
…utter/flutter#162841)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 5, 2025
@engine-flutter-autoroll
03b7c23 EditableText should not allow horizontal scrolling on iOS (fl…
b67a0e3 
…utter/flutter#162841)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 5, 2025
@engine-flutter-autoroll
03b7c23 EditableText should not allow horizontal scrolling on iOS (fl…
fc5d447 
…utter/flutter#162841)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 5, 2025
@engine-flutter-autoroll
03b7c23 EditableText should not allow horizontal scrolling on iOS (fl…
06e511f 
…utter/flutter#162841)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 6, 2025
@engine-flutter-autoroll
03b7c23 EditableText should not allow horizontal scrolling on iOS (fl…
9c23536 
…utter/flutter#162841)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 6, 2025
@engine-flutter-autoroll
03b7c23 EditableText should not allow horizontal scrolling on iOS (fl…
09d1515 
…utter/flutter#162841)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 6, 2025
@engine-flutter-autoroll
03b7c23 EditableText should not allow horizontal scrolling on iOS (fl…
6af44c4 
…utter/flutter#162841)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 6, 2025
@engine-flutter-autoroll
03b7c23 EditableText should not allow horizontal scrolling on iOS (fl…
f65d720 
…utter/flutter#162841)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@justinmc justinmc justinmc approved these changes

Assignees

No one assigned

Labels

a: text input Entering text in a text field or keyboard related problems f: material design flutter/packages/flutter/material repository. framework flutter/packages/flutter repository. See also f: labels.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

CupertinoTextField should not allow horizontal scrolling

2 participants

@Renzo-Olivares @justinmc