Skip to content

Add EditableText scroll into view breaking change note #8916

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sfshaza2 merged 10 commits into from
Jun 27, 2023
Merged

Add EditableText scroll into view breaking change note #8916

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
93900ef
Add EditableText scroll into view breaking change note
tgucio Jun 20, 2023
6845d89
Update PR link
tgucio Jun 20, 2023
0f9c466
Merge branch 'main' into scroll-into-view
tgucio Jun 20, 2023
7b0efb1
Update src/release/breaking-changes/editable-text-scroll-into-view.md
tgucio Jun 21, 2023
7159780
TBD stable release
tgucio Jun 21, 2023
8c79c6a
Update context
tgucio Jun 21, 2023
653d669
Update Description of change
tgucio Jun 21, 2023
e841f7e
Merge branch 'main' into scroll-into-view
atsansone Jun 23, 2023
ea563ef
Merge branch 'main' into scroll-into-view
atsansone Jun 26, 2023
f678c76
Merge branch 'main' into scroll-into-view
tgucio Jun 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions src/release/breaking-changes/editable-text-scroll-into-view.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: Updated EditableText scroll into view behavior
description: >
Improve EditableText selection scroll into view behavior to always
use the current selection extent.
---

## Summary

`Editable.onCaretChanged` callback is removed and with this change,
`EditableText` behavior with regard to scrolling the selection into view
changes.

## Context

To date, `EditableText` has used multiple mechanisms ensuring the selection
extent or caret is scrolled into view on updates.
Copy link
Contributor

@sfshaza2 sfshaza2 Jun 21, 2023

Choose a reason for hiding this comment

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

Not sure what you mean by "on updates".

Suggested change
To date, `EditableText` has used multiple mechanisms ensuring the selection
extent or caret is scrolled into view on updates.
Previously, `EditableText` used multiple mechanisms to determine the
extent of the selection, or to ensure that the caret is scrolled into view.

Copy link
Contributor Author

@tgucio tgucio Jun 21, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Thanks for the edits. Yes, this is a bit convoluted: what I meant were the mechanisms used on scrolling into view (which happens on user updates) to determine either of:

  • selection extent (non-collapsed selection)
  • caret position (collapsed selection).

Let me reword as:

Previously, upon scrolling into view to show user updates, EditableText used multiple mechanisms to determine the extent of the selection or the caret location.


## Description of change

By removing the `Editable.onCaretChanged` callback, `EditableText` will always
use the most up to selection extent location when scrolling to show it.
Specifically this results in improved scroll into view behavior after
changing selection from collapsed to non-collapsed via
`userUpdateTextEditingValue()`.
Copy link
Contributor

@sfshaza2 sfshaza2 Jun 21, 2023

Choose a reason for hiding this comment

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

What does "use the most up to selection extent location" mean?
I've made some tweaks, but would do more once I understand this phrase.

Suggested change
By removing the `Editable.onCaretChanged` callback, `EditableText` will always
use the most up to selection extent location when scrolling to show it.
Specifically this results in improved scroll into view behavior after
changing selection from collapsed to non-collapsed via
`userUpdateTextEditingValue()`.
By removing the `Editable.onCaretChanged` callback, `EditableText` will always
use the most up to selection extent location when scrolling to show it.
Specifically, this improves scroll into view behavior after
changing selection from collapsed to non-collapsed using
`userUpdateTextEditingValue()`.

Copy link
Contributor Author

@tgucio tgucio Jun 21, 2023

Choose a reason for hiding this comment

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

The underlying issue had to do with using multiple sources of truth where one wasn't necessarily up to date (could be one frame behind).

What is clearly missing is "date" as in "up to date" :). Correcting this.


## Timeline

Landed in version: 3.12.0-4.0.pre<br>
In stable release: 3.13.0
Copy link
Contributor

@sfshaza2 sfshaza2 Jun 21, 2023

Choose a reason for hiding this comment

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

The 3.13 release? It's probably best to just say "TBD" for now.


## References

API documentation:

* [`EditableText`]({{site.api}}/flutter/widgets/EditableText-class.html)

Relevant PRs:

* [109114: Remove Editable.onCaretChanged callback]({{site.repo.flutter}}/pull/109114)
2 changes: 2 additions & 0 deletions src/release/breaking-changes/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,14 @@ release, and listed in alphabetical order:
* [Removed `ignoringSemantics`][] properties
* [Deprecated `RouteInformation.location`][] and its related APIs
* [Customize tabs alignment using the new `TabBar.tabAlignment` property][]
* [Updated EditableText scroll into view behavior][]

[Added AppLifecycleState.hidden]: {{site.url}}/release/breaking-changes/add-applifecyclestate-hidden
[Moved ReorderableListView's localized strings]: {{site.url}}/release/breaking-changes/material-localized-strings
[Removed `ignoringSemantics`]: {{site.url}}/release/breaking-changes/ignoringsemantics-migration
[Deprecated `RouteInformation.location`]: {{site.url}}/release/breaking-changes/route-information-uri
[Customize tabs alignment using the new `TabBar.tabAlignment` property]: {{site.url}}/release/breaking-changes/tab-alignment
[Updated EditableText scroll into view behavior]: {{site.url}}/release/breaking-changes/editable-text-scroll-into-view

### Released in Flutter 3.10

Expand Down