Skip to content

docs(flutter): add RTL Support for the Flutter UI Kit - #622

Open
DhruvKushvaha2004 wants to merge 1 commit into
mainfrom
docs/flutter-uikit-rtl-support
Open

DhruvKushvaha2004 wants to merge 1 commit into
mainfrom
docs/flutter-uikit-rtl-support

Conversation

@DhruvKushvaha2004

Copy link
Copy Markdown
Contributor

Description

Adds RTL (right-to-left) support documentation for the Flutter UI Kit v6.

New page : RTL Support (sidebar: Theming, after Localize):

  • Layout direction vs language, and how auto follows the app's locale
  • Turning RTL on: UIKitSettingsBuilder..layoutDirection, and changing it at runtime with CometChatUIKit.setLayoutDirection
  • The per-component layoutDirection parameter, with the list of components that take it
  • Which setting wins when they disagree
  • Keeping the app's own screens in the same direction (MaterialApp.builder)
  • What changes in RTL: layout, icon rules per platform, what stays left to right (audio/video players, AI code blocks), message text, digits and dates
  • Custom views in RTL (EdgeInsetsDirectional, AlignmentDirectional, TextAlign.start)
  • Other RTL languages (Hebrew, Persian, Urdu) via Localize

Updated pages:

  • 15 component pages (Conversations, Users, Groups, Group Members, Message Header, Message List, Message Composer, Threaded Messages Header, Call Buttons, Call Logs, Outgoing Call, Search, Pinned Messages, Saved Messages, Notification Feed): a layoutDirection row in the props table, a short "Layout Direction" section with an example, and the prop count in the quick reference. Message Composer also explains how the text field follows the cursor's line.
  • Methods: layoutDirection in the init settings, plus a Layout Direction section.
  • Localize: a note that language and layout direction are separate settings.
  • Message Template: what BubbleAlignment.left / right mean in RTL.
  • View Slots: using direction-aware values in custom views.
  • Troubleshooting: a new RTL section.
  • docs.json: page added to the sidebar. llms-flutter-v6.mdx: page and an RTL note added to the LLM index.

All Dart examples were compile-checked against the UI Kit's rtl-support branch.

Related Issue(s)

No GitHub issue. Tracked on Multica:

Type of Change

  • Documentation correction/update
  • New documentation
  • Improvement to existing documentation
  • Typo fix
  • Other (please specify)

Checklist

  • I have read the CONTRIBUTING document
  • My branch name follows the naming convention
  • My changes follow the documentation style guide
  • I have checked for spelling and grammar errors
  • All links in my changes are valid and working
  • My changes are accurately described in this pull request

Additional Information

  • Merge timing: release this with the UI Kit version that ships layoutDirection. The setting isn't in the current published UI Kit yet.
  • Checks: mint broken-links reports no broken links in the changed pages, and all changed pages were checked in a local mint dev preview.

Screenshots (if applicable)

N/A. Text-only changes; RTL screenshots will follow in a separate update.

Adds an RTL Support page under Theming, after Localize. It covers the
layoutDirection setting (auto, ltr, rtl) for the whole UI Kit and per
component, changing it at runtime, which setting wins, keeping the app's
own screens in step, what mirrors and what stays left to right, message
text, custom views in RTL, and other RTL languages.

Each component page that takes layoutDirection gets a props-table row and
a short Layout Direction section. The Message Composer page explains how
the text field follows the cursor's line. Methods, Localize, Message
Template, View Slots and Troubleshooting get RTL notes, and the page is
added to the sidebar and the LLM index.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Nov 18, 2026 •

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
cometchat 🟢 Ready View Preview Nov 18, 2026, 10:44 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

This branch was successfully deployed

1 active deployment
staging — 1068ff96 Deployed Nov 18, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant