Skip to content

Deprecate TextInputConnection.setStyle #13016

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

Open
koji-1009 wants to merge 8 commits into
base: main
Choose a base branch
from
+77 −0
Open

Deprecate TextInputConnection.setStyle #13016

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
8d23cb3
Deprecate TextInputConnection.setStyle
koji-1009 Feb 3, 2026
09d5e24
Update src/content/release/breaking-changes/deprecate-text-input-conn…
koji-1009 Feb 3, 2026
2a641e5
Fix sort order in breaking changes index
koji-1009 Feb 3, 2026
6156a0e
Update src/content/release/breaking-changes/deprecate-text-input-conn…
koji-1009 Feb 3, 2026
4541978
Merge branch 'main' into text_input_connection
parlough Feb 4, 2026
ea82970
Merge branch 'main' into text_input_connection
sfshaza2 Feb 4, 2026
ca77bbd
Revert "Fix sort order in breaking changes index"
koji-1009 Feb 4, 2026
9d7215e
Sort my breaking change in index page
koji-1009 Feb 4, 2026
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
75 changes: 75 additions & 0 deletions src/content/release/breaking-changes/deprecate-text-input-connection-set-style.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
title: Deprecate `TextInputConnection.setStyle`
description: >-
The `TextInputConnection.setStyle` method has been deprecated in favor
of the `TextInputConnection.updateStyle` method.
---

{% render "docs/breaking-changes.md" %}

## Summary

`TextInputConnection.setStyle` is deprecated in favor of
`TextInputConnection.updateStyle`, which supports synchronizing
`letterSpacing`, `wordSpacing`, and `lineHeight` to the engine.

## Context

The previous `setStyle` method did not support `letterSpacing`, `wordSpacing`,
or `lineHeight`. This caused visual misalignment of the selection highlight
and IME caret when these properties were used.

The replacement `updateStyle` method (via `TextInputStyle`) supports these
properties, ensuring the system input is synchronized with the rendered text.

## Migration guide

Authors of custom text input clients should replace calls to
`TextInputConnection.setStyle` with `TextInputConnection.updateStyle`.

### Code before migration:

```dart
connection.setStyle(
fontFamily: 'Roboto',
fontSize: 14.0,
fontWeight: FontWeight.normal,
textDirection: TextDirection.ltr,
textAlign: TextAlign.start,
);
```

### Code after migration:

```dart
connection.updateStyle(
TextInputStyle(
fontFamily: 'Roboto',
fontSize: 14.0,
fontWeight: FontWeight.normal,
textDirection: TextDirection.ltr,
textAlign: TextAlign.start,
letterSpacing: 1.2,
wordSpacing: 1.0,
lineHeight: 1.5,
),
);
```

## Timeline

Landed in version: TBD<br>
In stable release: Not yet

## References

Relevant PR:

* [PR 180436][]

Relevant issues:

* [Issue 161592][]

<!-- Stable channel link: -->
[PR 180436]: {{site.repo.flutter}}/pull/180436
[Issue 161592]: {{site.repo.flutter}}/issues/161592
2 changes: 2 additions & 0 deletions src/content/release/breaking-changes/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ They're sorted by release and listed in alphabetical order:
* [`FontWeight` also controls the weight attribute of variable fonts][]
* [Deprecate `containsSemantics` in favor of `isSemantics`][]
* [Deprecate `findChildIndexCallback` in favor of `findItemIndexCallback` in `ListView` and `SliverList` separated constructors][]
* [Deprecate `TextInputConnection.setStyle`][]
* [Migrating Flutter Android app to Android Gradle Plugin 9.0.0][]
* [Material 3 tokens update][]
* [Page transition builders reorganization][]
Expand All @@ -51,6 +52,7 @@ They're sorted by release and listed in alphabetical order:
[`FontWeight` also controls the weight attribute of variable fonts]: /release/breaking-changes/font-weight-variation
[Deprecate `containsSemantics` in favor of `isSemantics`]: /release/breaking-changes/deprecate-contains-semantics
[Deprecate `findChildIndexCallback` in favor of `findItemIndexCallback` in `ListView` and `SliverList` separated constructors]: /release/breaking-changes/separated-builder-find-child-index-callback
[Deprecate `TextInputConnection.setStyle`]: /release/breaking-changes/deprecate-text-input-connection-set-style
[Migrating Flutter Android app to Android Gradle Plugin 9.0.0]: /release/breaking-changes/migrate-to-agp-9
[Material 3 tokens update]: /release/breaking-changes/material-color-utilities

Expand Down