Skip to content

Add migration guide for WidgetSpan ordering in RTL text - #13988

Open
meg4cyberc4t wants to merge 4 commits into
flutter:mainfrom
meg4cyberc4t:docs/widgetspan-rtl-bidi-order
Open

meg4cyberc4t wants to merge 4 commits into
flutter:mainfrom
meg4cyberc4t:docs/widgetspan-rtl-bidi-order

Conversation

@meg4cyberc4t

Copy link
Copy Markdown

Documents the corrected WidgetSpan order in RTL and mixed-direction text.
Apps that compensated for the old source-order layout can now position
widgets incorrectly; the guide explains which workarounds to remove.

Includes before-and-after screenshots and an entry under
"Not yet released to stable". The fix landed in Flutter 3.50.0-0.1.pre.

Related issue: flutter/flutter#54400
Related change: https://skia-review.googlesource.com/c/skia/+/1366676

The fix has already landed.

@meg4cyberc4t
meg4cyberc4t marked this pull request as ready for review October 17, 2026 21:02
@meg4cyberc4t
meg4cyberc4t requested review from a team and sfshaza2 as code owners October 17, 2026 21:02

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request adds documentation for a breaking change where WidgetSpans in right-to-left (RTL) and mixed-direction text now follow the bidirectional visual order determined by the Unicode bidirectional algorithm. It introduces a new markdown file detailing the background, migration steps (such as removing coordinate mirroring or manual translation workarounds), and timeline, and registers this new document in the breaking changes index. I have no feedback to provide as the changes are complete and well-written.

@conooi conooi left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@meg4cyberc4t Thanks for fixing this issue and contributing the migration guide! I left a few small suggestions for clarity, style, and converting the screenshots to WebP format.

Comment thread sites/docs/src/content/release/breaking-changes/widgetspan-rtl-bidi-order.md Outdated
Comment thread sites/docs/src/content/release/breaking-changes/widgetspan-rtl-bidi-order.md Outdated
Comment thread sites/docs/web/assets/images/docs/breaking-changes/widgetspan-rtl-before.png Outdated
Comment thread sites/docs/web/assets/images/docs/breaking-changes/widgetspan-rtl-after.png Outdated
Comment thread sites/docs/src/content/release/breaking-changes/widgetspan-rtl-bidi-order.md Outdated
meg4cyberc4t and others added 3 commits October 20, 2026 01:03
Document the corrected visual order of WidgetSpans in RTL and
mixed-direction text, including how to remove compensating workarounds.

Add before-and-after screenshots and an entry in the unreleased
breaking change index.

Related to flutter/flutter#54400.
Co-authored-by: Connie Ooi  <connieooi@google.com>
@meg4cyberc4t
meg4cyberc4t force-pushed the docs/widgetspan-rtl-bidi-order branch from 60bd84a to 6000378 Compare October 19, 2026 21:03
@meg4cyberc4t

meg4cyberc4t commented Oct 19, 2026 •

Copy link
Copy Markdown
Author

@conooi Hi! Thanks for the help!

@conooi

conooi commented Oct 20, 2026

Copy link
Copy Markdown
Contributor

/gcbrun

@flutter-website-bot

Copy link
Copy Markdown
Collaborator

Staged preview of the updated docs.flutter.dev site (updated for commit f7e0ae4):

https://flutter-docs-prod--docs-pr13988-docs-widgetspan-rtl-bi-0eecpnb4.web.app

@conooi
conooi requested a review from Renzo-Olivares October 20, 2026 16:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants