Skip to content

docs(android): add RTL Support for the Android UI Kit - #627

Open
hritika-cometchat wants to merge 1 commit into
mainfrom
docs/android-uikit-rtl-support
Open

hritika-cometchat wants to merge 1 commit into
mainfrom
docs/android-uikit-rtl-support

Conversation

@hritika-cometchat

Copy link
Copy Markdown
Contributor

Right-to-left (RTL) docs for the Android UI Kit v6 (Kotlin XML Views and Jetpack Compose), matching uikit-android PR #984 @ a4b44a10c and the RTL developer-experience doc (D-RTL-2). Task: ENG-41248 (X1, one RTL page per UI Kit). The other kits: #618 (React, Angular), #622 (Flutter), #623 (iOS).

New page

ui-kit/android/rtl-support, under Theming after Localize. Same outline as the Flutter page:

  • layout direction vs language, and the android:supportsRtl requirement;
  • the global setting (UIKitSettingsBuilder.setLayoutDirection, CometChatUIKit.setLayoutDirection);
  • the per-component setting: Compose layoutDirection, Views setCometChatLayoutDirection / app:cometchatLayoutDirection, and the components that take it;
  • base components (they follow their parent, or the global setting on their own);
  • which setting wins, and common scenarios;
  • what the kit does for you: overlays, viewers, snackbars;
  • what mirrors and what doesn't, and text, digits and dates;
  • custom views and your own overlays;
  • upgrading notes.

Updated pages

  • 18 component pages: a Functionality row and a "Layout Direction" section (XML element, Views setter, Compose parameter).
  • Localize: setLocale changes the language only; isRtl is removed from the API table.
  • Methods: setLayoutDirection in the UIKitSettings table, and a Layout Direction section.
  • Troubleshooting: a new RTL section.
  • View Slots: start/end values in RTL.
  • llms index: an entry for the new page.
  • Kit behaviour wording: "toast" → "snackbar" on 7 pages (the kit now shows snackbars that follow the component's direction). Toasts in sample app code are unchanged.

Checks

  • Every API name, class path and default checked against uikit-android a4b44a10c.
  • mint broken-links: no broken links. All new anchors resolve.

Not in this PR

  • Screenshots of the components in RTL.
  • Release notes for the UI Kit version that ships RTL.

🤖 Generated with Claude Code

New page ui-kit/android/rtl-support: layout direction vs language,
android:supportsRtl, the global setting (UIKitSettingsBuilder /
CometChatUIKit.setLayoutDirection) and the per-component setting (Compose
layoutDirection, Views setCometChatLayoutDirection / app:cometchatLayoutDirection),
which setting wins, base components, what mirrors and what doesn't, digits
and dates, custom views and overlays, and upgrading notes.

Also: a Layout Direction section and Functionality row on 18 component pages;
Localize (setLocale is language-only, isRtl removed), Methods, Troubleshooting,
View Slots and the llms index; kit "toast" wording changed to snackbar;
nav entry after Localize. Matches uikit-android PR #984 @ a4b44a10c.

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

mintlify Bot commented Nov 20, 2026 •

Copy link
Copy Markdown

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

Project Status Preview Updated
cometchat 🟢 Ready View Preview Nov 20, 2026, 10:35 AM

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

This branch was successfully deployed

1 active deployment
staging — 1f96a83f Deployed Nov 20, 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