Skip to content

docs(ENG-57590): Offline Support for the React UI Kit - #611

Draft
raj-dubey1 wants to merge 6 commits into
mainfrom
docs/uikit-offline-react
Draft

raj-dubey1 wants to merge 6 commits into
mainfrom
docs/uikit-offline-react

Conversation

@raj-dubey1

@raj-dubey1 raj-dubey1 commented Nov 16, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Adds an Offline Support page for React UI Kit v7 and updates the other React v7 pages to match it. Every claim was checked against the React UI Kit 7.3.0 and JavaScript Chat SDK source.

Ticket: ENG-57590
AI-DLC path: light (docs)
Base: main

Changes

  • New page ui-kit/react/offline-support.mdx:
    • what works offline and what needs a connection;
    • enabling it with setOfflineConfig();
    • per-component behaviour;
    • the offline texts and their localization keys;
    • send promises, events and customization.
  • docs.json and llms-react-v7.mdx: the new page is in React v7 → Features → Chat, after core-features, and in the LLM index.
  • core-features.mdx: an Offline Support section.
  • methods.mdx:
    • an "Enabling Offline Support" section with an example, next to storage mode;
    • logout clears the offline cache, and how to log out without a connection;
    • how the send methods' Promise behaves offline;
    • the send methods publish ui:message/sent while a CometChatProvider is mounted, so the old warning saying they don't is replaced.
  • localization.mdx: an offline texts table with every key and its en-US text. The addTranslation() example is fixed.
  • event-system.mdx:
    • adds the offline events (ui:message/send-state-changed, ui:offline/cache-reset);
    • lists the CometChatUIKit.send* methods as publishers of ui:message/sent.
  • Integration pages (React, Next.js, React Router, Astro), overview.mdx, cometchat-provider.mdx: one line on the offline setting, with a link.
  • Component pages: one offline line each, with a link: conversations, message list, message composer, message header, users, groups, group members, pinned and saved messages, search, reaction list, notification feed, and the image, video, file, audio and voice-note bubbles. Conversations and Message List also document hideOfflineNotices.

The PR touches 30 files, more than the 10-file guideline. The ticket asks for every React v7 page whose behaviour changes with offline on to mention it. Most files get one or two lines.

What is promised offline

  • Queued and sent on reconnect: text messages, stickers, custom messages and the group call message.
  • Attachments picked while offline are not promised. The page says they aren't guaranteed to send.
  • The "File too large to send offline" text is listed only as a notice for a refused send.

Checks run

Command Result
python3 -m json.tool docs.json pass
mint broken-links (mint 4.2.881) 3 broken links in 2 files, all already on main: /llms.txt in design-system.mdx; /llms.txt and /llms-full.txt in llms-index.mdx. None are in the changed files.
Anchor check on every #anchor link in the changed pages 0 broken
Source check Changed claims were traced to the React UI Kit 7.3.0 and JavaScript SDK source, with independent review passes.

Code samples were checked in shape against the UI Kit's exported API (UIKitSettingsBuilder.setOfflineConfig, CometChatLocalize.addTranslation, useCometChatEvents). This is a docs-only change, so there are no unit tests.

Risk and rollback

  • Risk: Low. Docs only, React v7 pages only.
  • Public API: none
  • Rollback: revert this PR
  • Release: publish together with React UI Kit 7.3.0.

Needs confirmation

  • Attachments sent offline: should the web docs describe queued attachment sends? The docs don't promise them for now.
  • SDK version floor: the pages say JavaScript Chat SDK 4.3.0 or later. Update this once the SDK release number for these fixes is settled.
  • Install version: overview.mdx still shows ^7.2.4 (latest). Bump it when 7.3.0 ships.
  • initFromSettings: not documented, because it is marked internal in the UI Kit.
  • Screenshots: none yet for the offline states.

Provenance

Agent-built with Claude Code for Raj Dubey. Agent review is in progress; human review is pending.

Known gaps

  • The branch name and its first two commits predate the ticket. The ticket asked to keep this PR, so they are not renamed. Later commits use docs(ENG-57590): ….
  • The branch is behind main and has not been rebased. GitHub reports no conflicts.

🤖 Generated with Claude Code

@mintlify

mintlify Bot commented Nov 16, 2026 •

Copy link
Copy Markdown

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

Project Status Preview Updated
cometchat 🟢 Ready View Preview Nov 19, 2026, 2:59 PM

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

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WEaVigCRBjkftm78T25MQA
raj-dubey1 and others added 3 commits November 19, 2026 16:57
Update the jump-to-unsaved-message, edit failure, send promise, presence,
reaction list and Retry/Delete behaviour to match the UI Kit, fix the
encryption default in the example and the addTranslation() call, drop the
Search context row (it exposes no offline flags), add the message list
context and the delete-failed text, and stop promising that media and
voice notes picked offline are queued.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: multica-agent <github@multica.ai>
Document setOfflineConfig() and logging out offline in Methods, the
hideOfflineNotices prop on Conversations and Message List, the offline
events in the event system, and the offline texts and keys in
Localization. Add a short note with a link on the integration, overview,
provider and affected component pages. Also fix the Methods note on the
send methods (they publish ui:message/sent) and the addTranslation()
example in Localization.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: multica-agent <github@multica.ai>
…te and presence

List the CometChatUIKit send methods as publishers of ui:message/sent,
say a cache reset rejects a send only when unsent messages were or may
have been lost, describe Retry and Delete on a message that was already
sent, and note that the typing indicator is hidden in group chat headers
too.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: multica-agent <github@multica.ai>
@raj-dubey1 raj-dubey1 changed the title docs(react): Offline Support for the React UI Kit docs(ENG-57590): Offline Support for the React UI Kit Nov 19, 2026
…line caveats

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: multica-agent <github@multica.ai>

This branch was successfully deployed

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