Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion design-system.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Chat experience blueprint & design system"
sidebarTitle: "Design System"
description: "The cross-platform design system and experience blueprint CometChat's AI skills (and any AI coding agent) follow to build production-grade, best-in-class chat UIs end-to-end — for every UI Kit and SDK, on the customer's own brand: discovery and requirements, cloning an existing app detail by detail, when to use a UI Kit component vs build your own, design tokens, motion, responsiveness, component map, and per-app-type recipes."

Check warning on line 4 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L4

Did you really mean 'UIs'?
canonical: "https://www.cometchat.com/docs/design-system"
---

Expand All @@ -9,8 +9,8 @@
CometChat — not a bare component drop, but an app with the polish of the messengers people use every
day, on the **customer's own brand**. It is **platform-generic**: the same
principles, tokens, motion, and recipes apply to **every CometChat UI Kit and SDK** — React, Angular,
React Native, iOS, Android (Kotlin XML views and Jetpack Compose), and Flutter, plus the headless

Check warning on line 12 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L12

Did you really mean 'Jetpack'?
Chat/Calls SDKs for fully custom UI. (The Vue UI Kit is on an older generation, v4: the process and

Check warning on line 13 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L13

Did you really mean 'SDKs'?
design rules apply, but check its docs for what it supports before relying on any component named
here.) Process, design, and behavior rules are shared; the platform-specific parts — theming
mechanics, layout, navigation, and gotchas — are in [Per-platform notes](#per-platform-notes).
Expand All @@ -28,7 +28,7 @@
## Before you start (prerequisites)

Confirm these first — the same steps apply to **every** platform (React, Angular, React Native, iOS,
Android, Flutter, and Vue v4) and to the headless Chat/Calls SDKs:

Check warning on line 31 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L31

Did you really mean 'SDKs'?

- **A CometChat app + credentials in place.** App ID, Region, and Auth Key (dev) — read from the
app's env or config; production uses **server-minted auth tokens**. Never
Expand All @@ -43,7 +43,7 @@
a **consumer 1:1 + group messenger**.
- **The customer's brand.** Logo, app name, and palette — these replace the brand tokens; CometChat is
the engine, not the identity.
- **Fresh build vs retrofit.** Fresh: a working app shell + the family's toolchain. Retrofit: the app

Check warning on line 46 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L46

Did you really mean 'toolchain'?
**builds today**, a **clean git branch**, and an inventory of the current chat/UI, routing, state,
and auth so the swap stays non-breaking.
- **Docs access.** The family's scoped LLM index plus the Docs MCP (or the docs site), so every prop
Expand Down Expand Up @@ -103,7 +103,7 @@
2. **Decide, per item, kit component or your own UI.** Use the UI Kit wherever it can reach the
target's behavior and look; build your own where it can't. Record the decision and the reason for
every item. See [Kit component or your own UI?](#kit-component-or-your-own-ui-decide-per-item).
3. **Build the auth/session gate first** — a real login screen and session, never a hardcoded UID. See

Check warning on line 106 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L106

Did you really mean 'hardcoded'?
[Auth and session](#auth-and-session). Logged-out shows login; logged-in shows the app; logout works.
4. **Wire the complete screen set** — not just a list + a message pane. Chats, chat, **contact/group
details, search, new chat, calls, settings** must all exist and navigate, and each opens **where
Expand All @@ -111,7 +111,7 @@
[Navigation and screens](#navigation-and-screens). **Every control the UI shows must open a working
screen — a dead button (search/details/attach/call that does nothing) or a half-wired pane is a bug,
not "done."**
5. **Get the layout right** — fill the viewport, the message list scrolls *internally*, the composer is

Check warning on line 114 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L114

Did you really mean 'viewport'?
pinned, there is **no empty gap and no over-scroll**, and it's keyboard-safe on mobile. See
[Layout correctness](#layout-correctness).
6. **Apply the design tokens** via the family's real theming API — not the flat defaults. See
Expand Down Expand Up @@ -201,7 +201,7 @@
family's scoped LLM index + the Docs MCP) for what the kit/SDK actually supports, and study the target
experience the user named for the behaviors and screens it implies. Produce a concrete list — every
screen, message type, interaction, animation, **and parity detail** in scope. Go down to the details
that make it feel like the target, e.g.: does it show read receipts or not; how are channels vs DMs

Check warning on line 204 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L204

Did you really mean 'DMs'?
labelled (`#` / lock / avatar); are threads first-class; which mention types; how is the composer laid
out; empty/loading/error states; density and dark palette. These are exactly the things that reveal a
"themed default" instead of the real app, so they belong in the plan — not discovered later by the user.
Expand Down Expand Up @@ -274,7 +274,7 @@

### Sources, best first

1. **What the user gives you:** screenshots, screen recordings, a Figma file, or access to the real

Check warning on line 277 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L277

Did you really mean 'Figma'?
app. Ask for them if the target matters and you have none; a few screenshots of the main screens,
in light and dark, settle more questions than any description.
2. **The real app**, if you can open it (a web app in the browser tool), observed directly — click
Expand All @@ -294,7 +294,7 @@
changes on web.
- **Entry point → container → close, for every feature.** Where it starts (button, field, menu item,
keyboard shortcut, gesture), what it opens in (**centered dialog**, popover, dropdown, side panel,
bottom sheet, new page, inline expansion), and how it closes (Esc, click outside, back, close button,

Check warning on line 297 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L297

Did you really mean 'Esc'?
after an action). This is the detail most clones get wrong: the same feature opening in a different
place makes the whole app feel different.
- **Lists and rows.** Grouping and section headers (collapsible? ordering?), what each row shows
Expand Down Expand Up @@ -326,7 +326,7 @@
spacing, radii, borders vs shadows, icon set style (outline / filled, stroke width), avatar shapes and
sizes, density, light and dark palettes. See [Design sync](#design-sync-kit-components-and-your-own-ui-as-one-design).
- **Secondary surfaces.** Not only the main screens: the thread panel and its header, message info
(read by), the reactions list, emoji and sticker pickers, context and hover menus, confirm dialogs,

Check warning on line 329 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L329

Did you really mean 'dialogs'?
toasts, the image / video viewer, the forward picker and call screens. Each one is its own row with
the target's design. Users judge a clone by these, and the kit opens several of them by itself
(the hover toolbar opens message info; a reply count opens the thread). Theme each one to the
Expand All @@ -336,7 +336,7 @@
indicator. Each entry is a row with a level. Animated emoji art the target owns is
**not natively possible**; use an open set or say it's static.
- **Responsive behavior.** What collapses, hides, or becomes a separate screen at each width.
- **Accessibility.** Keyboard reachability, focus rings, screen-reader labels the target exposes.

Check warning on line 339 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L339

Did you really mean 'reachability'?

Put every item in the requirements table with its observed behavior in the *Target behavior* column.
A detail you didn't research doesn't go in as a default — it goes in as **unverified** with a question
Expand All @@ -363,7 +363,7 @@
| --- | --- | --- |
| **L0 — kit as-is** | The kit component with default behavior | The target behaves like the kit default |
| **L1 — kit + config** | Props, feature flags, Dashboard settings, theme tokens | Only options, visibility, or colors differ |
| **L2 — kit + slots** | The kit's custom views / templates / formatters for parts of the component (row, header, bubble, empty state, menu items) | The structure matches but parts look or read differently |

Check warning on line 366 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L366

Did you really mean 'formatters'?
| **L3 — kit in your container** | The kit component rendered inside your own dialog, popover, side panel, sheet, or route | The component's content fits but the target opens it somewhere else (e.g. search or a channel directory in a centered dialog, a thread in a side panel) |
| **L4 — your UI on the SDK** | Your own component using the Chat/Calls SDK for data and real-time events, styled with the shared tokens | The interaction model or layout can't be reached through config, slots, or a container (e.g. results grouped in a way the kit doesn't render, a custom quick switcher) |
| **L5 — third-party** | A library for something neither the kit nor the SDK provides (only under the agreed package policy) | e.g. animated emoji, charts, a rich-text editor |
Expand All @@ -390,7 +390,7 @@
own component must not fetch the same list again: take the selection from the kit's callbacks and
pass objects down. When you replace a kit component, remove it rather than running both. Initialize
and log in once (guard against React StrictMode's double effects), register each real-time listener
once with a unique ID and remove it on unmount, and never poll what a listener delivers.

Check warning on line 393 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L393

Did you really mean 'unmount'?
- **Every L4 piece uses the same tokens** as the themed kit, so users can't tell which parts are kit
and which are yours (see [Design sync](#design-sync-kit-components-and-your-own-ui-as-one-design)).
- **Verify the API before choosing the level.** Whether a slot, prop, or SDK method exists comes from
Expand Down Expand Up @@ -432,7 +432,7 @@

## Auth and session

A production app has a **session**, not a hardcoded user. Build this even for a demo:

Check warning on line 435 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L435

Did you really mean 'hardcoded'?

- **Gate the app on auth state.** While the SDK initializes, show a splash/skeleton; if no user is
logged in, show a **login screen**; once logged in, show the app; on logout, return to login. Never
Expand Down Expand Up @@ -469,7 +469,7 @@
## Navigation and screens

A real messaging app is **many screens**, not one list + one message pane. Wire all of these and make
every affordance open a real screen (no dead buttons). The table says *what* must exist; *where and how

Check warning on line 472 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L472

Did you really mean 'affordance'?
each one opens* comes from the target (see [Cloning an existing app](#cloning-an-existing-app-research-every-detail))
or, with no target, from the archetype's [interaction patterns](#app-archetypes-recipes):

Expand Down Expand Up @@ -507,7 +507,7 @@
- **Message grouping.** Consecutive messages from the same sender within a short window are grouped
(one avatar, tight spacing); a new sender or time gap starts a new group. **Date separators** and an
**unread divider** ("New messages") are shown.
- **Smooth scrolling.** Auto-scroll to newest when at the bottom; a **scroll-to-bottom** affordance

Check warning on line 510 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L510

Did you really mean 'affordance'?
with an unread count when scrolled up; preserve position when loading older pages.
- **Rich media done right.** Thumbnails with aspect ratio and loading/upload progress; tap to expand;
audio/voice notes with waveform + scrubber; file cards with type/size; link previews.
Expand All @@ -518,7 +518,7 @@
- **Actions.** Long-press (mobile) / hover (web) message menu; swipe-to-reply on mobile.
- **Empty, loading, error, offline states** for every surface — never a blank screen; skeletons while
loading; a clear reconnecting state.
- **Notifications.** Push when backgrounded; in-app unread badges on conversations and app icon/tab.

Check warning on line 521 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L521

Did you really mean 'backgrounded'?
- **Accessibility & i18n.** Keyboard navigation, focus states, screen-reader labels, dynamic type,
full **dark mode**, and **RTL** for RTL locales.

Expand Down Expand Up @@ -605,7 +605,7 @@

The CSS variable names above are the web UI Kit's; on native, set the same things through the
family's theme and the component style objects (see [Per-platform notes](#per-platform-notes)). Pull
the exact recolorable tokens/classes from the family's **theming** and **message-bubble styling**

Check warning on line 608 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L608

Did you really mean 'recolorable'?
docs. The point is to spend the polish (wallpaper, tails, shadows, ticks, badges), not stop at the
primary color.

Expand All @@ -622,17 +622,17 @@
(and `html`) **and** `.cometchat`. Tokens set only on `.cometchat` leave the root-read values on the
kit default.
- **Win the cascade on purpose.** The kit ships its own rules on `.cometchat` / `[data-theme]`.
- **React v7** declares them inside `@layer cometchat`, so any unlayered rule of yours already wins,

Check warning on line 625 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L625

Did you really mean 'unlayered'?
whatever the stylesheet load order. If your own CSS is layered (for example Tailwind's `@layer`),
extra specificity won't help: declare the order with your layer last
(`@layer cometchat, app;`) or put the token overrides outside any layer.
- **Angular** ships unlayered CSS, so raise specificity deliberately: the doubled-class

Check warning on line 629 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L629

Did you really mean 'unlayered'?
`.cometchat.cometchat { … }` for tokens, and the same-element `.cometchat[data-theme="dark"] { … }`
(not a descendant selector) for the dark set.

Either way, define every token in the base rule, then redefine only what changes under dark.
- **Some icons are a CSS `filter`, not a token — so you override the filter.** The composer /
attachment / emoji icons are `<img>` assets recolored by a **hardcoded** CSS `filter`

Check warning on line 635 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L635

Did you really mean 'hardcoded'?
(`brightness(0) … hue-rotate(…deg) …`) that no `--cometchat-*` variable touches. Brand them by
overriding that `filter` on the specific rules that carry it, and **solve the filter numerically**
rather than guessing: draw the icon to a `<canvas>` with a candidate `ctx.filter`, read the average
Expand All @@ -655,7 +655,7 @@
2. **One token source.** Put the measured values in one place (CSS custom properties on web; a theme
object on native) and derive everything from it. Never hard-code a color or size in a component.
3. **Theme the kit from those tokens** through the family's theming API, including the parts that are
easy to miss: menus and context menus, dialogs, the emoji keyboard and pickers, reaction chips,

Check warning on line 658 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L658

Did you really mean 'dialogs'?
date separators, unread dividers, empty and error states, avatars, badges, and the icons recolored
by a filter (see [Theming contract](#theming-contract-where-tokens-live-and-how-the-cascade-resolves)).
4. **Build your own UI from the same tokens** — the same colors, type scale, spacing, radii, icon set,
Expand All @@ -681,7 +681,7 @@

| Interaction | Motion | Duration / easing |
| --- | --- | --- |
| Message send | New bubble fades + rises a few px into place; status ticks cross-fade pending→sent | 150–200ms ease-out |

Check warning on line 684 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L684

Did you really mean 'px'?
| Message receive | Fade/slide in from the incoming side; subtle list shift | 150–200ms ease-out |
| Typing indicator | Three dots looping (scale/opacity) | ~1.2s loop |
| Reaction | Emoji pops with a slight overshoot (spring) | 180–260ms spring |
Expand Down Expand Up @@ -715,14 +715,14 @@

## Layout and responsiveness

| Breakpoint | Layout |

Check warning on line 718 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L718

Did you really mean 'Breakpoint'?
| --- | --- |
| Mobile `< 600px` | **Single pane**: conversation list → push-navigate to the chat; full-screen chat; bottom tab bar for sections; sticky composer with keyboard-avoidance; respect safe-area insets. |
| Tablet `600–1024px` | **Two pane**: list (left) + active chat (right). |
| Desktop `> 1024px` | **Three pane**: nav rail / conversation list / chat pane, with a collapsible **details** drawer (profile, group members, shared media, search). |

Rules: the chat pane always shows a header, a scrollable message list, and a pinned composer. The list

Check warning on line 724 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L724

Did you really mean 'scrollable'?
column keeps search + new-chat affordances. Never let the body scroll horizontally; media and the

Check warning on line 725 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L725

Did you really mean 'affordances'?
message list scroll within their own containers.

### Layout correctness
Expand All @@ -736,7 +736,7 @@
the composer floating — is flex/height mistakes. Follow these exactly:

- **Full-viewport root.** `html, body, #root { height: 100%; margin: 0 }`; the app shell uses
**`height: 100dvh`** (dynamic viewport height — accounts for mobile browser chrome, so there is no

Check warning on line 739 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L739

Did you really mean 'viewport'?
empty strip at the bottom). Reset the starter's `#root` (`max-width: none; padding: 0; width: 100%`).
- **The chat column is a flex column that fills its parent and clips:** `display: flex;
flex-direction: column; height: 100%; min-height: 0; overflow: hidden`.
Expand Down Expand Up @@ -768,7 +768,7 @@
| Calls (voice/video) | **IncomingCall**, **OutgoingCall**, **CallButtons**, **CallLogs**, call bubbles |
| Pinned / saved / message info | **PinnedMessages**, **SavedMessages**, **MessageInformation** |
| AI assistant surface | **AIAssistantChat** |
| Moderation affordance | **FlagMessageDialog** |

Check warning on line 771 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L771

Did you really mean 'affordance'?

When a design needs a layout the prebuilt components don't cover, first check whether hosting the
component in your own container or using its custom views reaches it; if not, build the custom UI on
Expand Down Expand Up @@ -815,9 +815,9 @@
- **Interaction patterns:** double-tap or long-press a bubble for quick reactions anchored to it;
details from the header; few visible controls, most actions behind long-press.

### Team workspace (channels + DMs)

Check warning on line 818 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L818

Did you really mean 'DMs'?
- Workspaces → channels + DMs; **threads-first**; rich composer (formatting, code, attachments);
mentions; left sidebar (channels/DMs), desktop 3-pane, compact density.

Check warning on line 820 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L820

Did you really mean 'DMs'?
- **Interaction patterns:** a **quick switcher** opened by a keyboard shortcut (Ctrl/Cmd+K) in a
centered dialog to jump to any channel or person; **global search** in a centered dialog or a
top-bar field with results grouped by type (messages, channels, people, files) and filters; a
Expand All @@ -827,7 +827,7 @@
on messages (react, reply in thread, more); flat messages (avatar + name + time, no bubbles) grouped
by sender; channel header with name, topic, and member count opening a details dialog; Up arrow to
edit your last message; Enter sends, Shift+Enter adds a line; avatar and name on **every** message
run, including your own and in DMs; **huddles** (a live audio session in a channel that others see

Check warning on line 830 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L830

Did you really mean 'DMs'?
and join, without ringing) docked at the bottom of the sidebar and expandable into a window, built
with the [huddle steps](#calls-and-huddles). On mobile see
[Mobile equivalents](#mobile-equivalents-of-desktop-patterns).
Expand All @@ -848,8 +848,8 @@
and estimated wait; end-chat confirmation and rating in the same panel.

### Community / social
- Feeds + DMs; large public groups; moderation (flag/ban), roles; discovery/search.

Check warning on line 851 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L851

Did you really mean 'DMs'?
- **Interaction patterns:** DMs reached from an inbox icon in the app's main navigation; a group

Check warning on line 852 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L852

Did you really mean 'DMs'?
directory with search and join; report and block from message and profile menus.

### Marketplace / dating
Expand Down Expand Up @@ -922,7 +922,7 @@
[Per-platform notes](#per-platform-notes).

- **Off-brand icons that no token fixes (web).** The composer / attachment / emoji icons are `<img>`
data-URIs recolored by a hardcoded CSS `filter` (`… hue-rotate(235deg) …` = the kit's default

Check warning on line 925 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L925

Did you really mean 'hardcoded'?
accent), **not** a `--cometchat-*` token — so brand tokens leave them the default color, most visibly
in **dark mode**. Idle composer icons use a neutral grey filter; the accent filter applies on
**hover and active** states. **Fix:** override the `filter` on the rules that carry the accent.
Expand All @@ -940,7 +940,7 @@
your brand color by canvas-sampling (see [Theming contract](#theming-contract-where-tokens-live-and-how-the-cascade-resolves)).
Worked example (a teal; solve your own brand the same way):
`brightness(0) saturate(1) invert(.4) sepia(.6) saturate(6) hue-rotate(120deg) brightness(.85) contrast(1)`
(measured rgb ≈ 1,125,104).

Check warning on line 943 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L943

Did you really mean 'rgb'?
- **Search needs the Search feature enabled on the app's plan.** `CometChatSearch` (conversation +
message search) returns an error (HTTP 402) until **Search is enabled on the app's plan**
(dashboard), and the component itself shows no message about it. Correctly wired search still returns nothing until then. **Fix:** always pass
Expand Down Expand Up @@ -982,8 +982,8 @@
| **React Native** | Wrap the app in `CometChatThemeProvider`; pass `light` / `dark` color overrides and per-component style objects through its `theme` prop | Colors as hex values; values deep-merge with defaults, so set both light and dark |
| **iOS** | Global `CometChatTheme` colors and `CometChatTypography`, plus each component's style | Set the theme **before** `CometChatUIKit.init()`; provide dynamic colors for light and dark |
| **Android (Kotlin XML views)** | A theme extending `CometChatTheme.DayNight` in `themes.xml` with `cometchat*` attributes, or `CometChatTheme.set*()` in code | Dark mode via `values-night/themes.xml`; programmatic overrides beat activity and application themes |
| **Android (Jetpack Compose)** | Wrap content in the `CometChatTheme { }` composable with a `CometChatColorScheme`, typography, and shapes | Provide a dark color scheme based on `isSystemInDarkTheme()` |

Check warning on line 985 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L985

Did you really mean 'Jetpack'?

Check warning on line 985 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L985

Did you really mean 'composable'?
| **Flutter** | Register `CometChatColorPalette`, `CometChatTypography`, and `CometChatSpacing` in `ThemeData.extensions` | Register on **both** the light and dark `ThemeData`, or one mode keeps kit defaults; assigning `extensions` replaces the ancestor's, so use `CometChatTheme.mergeThemeExtensions`; widget backgrounds need each widget's own style |

Check warning on line 986 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L986

Did you really mean 'widget's'?

On native there is no CSS cascade and no icon `filter`: the kit's icons are tinted through the theme
and component styles. If the theme doesn't reach an icon, pass your own icon through the component's
Expand All @@ -993,15 +993,15 @@

| Platform | Keyboard and safe areas | Navigation |
| --- | --- | --- |
| **Web (React, Angular)** | [Layout correctness](#layout-correctness): `100dvh`, flex with `min-height: 0`, internal scrolling | A router (URL per conversation) or explicit screen state; dialogs and side panels for desktop patterns |

Check warning on line 996 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L996

Did you really mean 'dialogs'?
| **React Native** | `react-native-safe-area-context` for insets; keyboard avoidance around the composer (check the kit docs for what the message composer already handles before adding your own) | React Navigation (stack for list → chat → details; tabs for sections; modal presentation for dialogs and sheets) |

Check warning on line 997 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L997

Did you really mean 'dialogs'?
| **iOS** | Respect the safe area; keep the composer above the keyboard (keyboard layout guide or the kit's own handling) | A navigation stack for push screens; sheets for dialog-style features; tab bar for sections; split view on iPad |
| **Android** | Edge-to-edge with window insets; resize for the keyboard so the composer stays visible | Activities/Fragments with the Navigation component, or Compose Navigation; bottom sheets for menus |
| **Flutter** | `SafeArea`; `Scaffold` resizing for the keyboard | `Navigator` or a router package; `showModalBottomSheet` / dialogs for sheet- and dialog-style features |

Check warning on line 1000 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L1000

Did you really mean 'dialogs'?

On every platform: the message list scrolls on its own, the composer stays visible with the keyboard
open, nothing sits under the notch, status bar, or home indicator, and back (gesture, hardware button,
or Esc on web) closes the top-most screen, sheet, or dialog first.

Check warning on line 1004 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L1004

Did you really mean 'Esc'?

### Mobile equivalents of desktop patterns

Expand All @@ -1019,7 +1019,7 @@
| Thread in a right side panel | Thread as its own pushed screen, with the parent message on top |
| Details dialog or right drawer | A pushed details screen (or a sheet on iPad / large screens) |
| Collapsible sidebar sections | Sections in the home list (collapsible if the target has it), or tabs |
| Hover states and tooltips | Pressed states; labels shown in menus instead of tooltips |

Check warning on line 1022 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L1022

Did you really mean 'tooltips'?

Check warning on line 1022 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L1022

Did you really mean 'tooltips'?
| Enter to send, Shift+Enter for a new line | A send button; the return key adds a line unless the target sends on return |
| Drag-and-drop files | The attachment button and the system share sheet |
| Swipe actions (mobile-only) | Hover icons or a context menu on desktop |
Expand Down Expand Up @@ -1055,7 +1055,7 @@
Ship only when all pass:

- **Login works:** logged-out shows a login screen; logging in enters the app; logout returns to login;
refresh stays signed in. No hardcoded UID, no Auth Key in a public production build.

Check warning on line 1058 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L1058

Did you really mean 'hardcoded'?
- **No layout bugs:** the message list fills the space and scrolls **internally**; the composer is
pinned; **no empty gap under the messages and no whole-page/over-scroll**; correct with the mobile
keyboard open (`100dvh`).
Expand All @@ -1068,13 +1068,13 @@
- **Clone parity (when the user named an app):** every item in the requirements table is built at its
agreed level or explicitly left out; every feature opens in the same place, through the same entry
points and shortcuts, and closes the same way as in the target; side-by-side screenshots of each
screen and state (light + dark, mobile + desktop) show no unagreed difference; kit components and

Check warning on line 1071 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L1071

Did you really mean 'unagreed'?
your own UI share the same tokens with no visible seam; no unverified detail was shipped as a guess.
- **Message details match:** open a 1:1 chat and a group and compare your own and others' messages
with the target: avatar, name, alignment, grouping, timestamps, receipts.
- **Live calls show in the target's container:** docked, mini window or full screen, as recorded.
- **Secondary surfaces match:** open each one (thread, message info, reactions list, pickers, menus,
dialogs, viewer, call screens) and compare it with the target; none is left in the kit's default look.

Check warning on line 1077 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L1077

Did you really mean 'dialogs'?
- **Motion actually moves:** for every motion row, two frames about 300 ms apart differ; a static
fallback counts as not done.
- **Sending is one visual change:** a sent message appears once and only its status icon changes
Expand All @@ -1092,7 +1092,7 @@
gesture / hardware back closes the top-most sheet or screen; desktop patterns use their
[mobile equivalents](#mobile-equivalents-of-desktop-patterns); checked on a real device or emulator.
- Full dark mode — including **on-brand icons** in the composer / attachment menu / emoji keyboard
(these are recolored by a hardcoded filter, not a token; see [Known UI Kit gotchas](#known-ui-kit-gotchas));

Check warning on line 1095 in design-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

design-system.mdx#L1095

Did you really mean 'hardcoded'?
RTL for RTL locales; `prefers-reduced-motion` respected.
- Customer brand + logo applied; no CometChat branding as the app identity.
- Push + unread badges; calls (if in scope) ring and connect **between two different users on two
Expand All @@ -1117,7 +1117,7 @@
This blueprint is the *what* and *how it feels*; get the exact *how* from the live docs:

- **Per-product LLM indexes** — the scoped routing indexes for each UI Kit / SDK (append `.md` to any
docs URL for its clean twin), and the site-wide [llms.txt](/llms.txt).
docs URL for its clean twin), and the site-wide [llms.txt](https://www.cometchat.com/docs/llms.txt).
- **Theming** — your family's theming guide for the real theme keys these token roles map to:
[React](/ui-kit/react/theming), [Angular](/ui-kit/angular/customization/theming),
[React Native](/ui-kit/react-native/theme), [iOS](/ui-kit/ios/theme-introduction),
Expand Down
2 changes: 1 addition & 1 deletion llms-index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
> Directory of the product-scoped LLM docs indexes for AI coding agents. Each entry below links a
> single product's current-version docs; on any of those pages, **append `.md`** to a URL for the
> clean Markdown twin. For everything at once instead of one product, use the site-wide
> [/docs/llms.txt](/llms.txt) (index) or [/docs/llms-full.txt](/llms-full.txt) (full corpus).
> [/docs/llms.txt](https://www.cometchat.com/docs/llms.txt) (index) or [/docs/llms-full.txt](https://www.cometchat.com/docs/llms-full.txt) (full corpus).

## UI Kits
- [React UI Kit v7](/ui-kit/react/llms-react-v7)
Expand All @@ -26,7 +26,7 @@
- [Android UI Kit v6](/ui-kit/android/llms-android-v6)
- [Flutter UI Kit v6](/ui-kit/flutter/llms-flutter-v6)

## Chat SDKs

Check warning on line 29 in llms-index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

llms-index.mdx#L29

Did you really mean 'SDKs'?
- [JavaScript Chat SDK v4](/sdk/javascript/llms-javascript-v4)
- [React Native Chat SDK v4](/sdk/react-native/llms-react-native-v4)
- [iOS Chat SDK v4](/sdk/ios/llms-ios-v4)
Expand Down
Loading