Skip to content

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

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

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

Conversation

@raj-dubey1

Copy link
Copy Markdown
Contributor

What's added

  • New page ui-kit/react/offline-support.mdx ("Offline Support"):
    • overview and requirements;
    • enabling it with UIKitSettingsBuilder.setOfflineConfig();
    • how each component behaves offline: lists, search, message list and threads, composer, media, edits/deletes/reactions, presence, logout and cache reset;
    • a table of offline texts with their localization keys;
    • onError rules, the send* promise and ERROR_OFFLINE_MESSAGE_DISCARDED;
    • the ui:message/send-state-changed and ui:offline/cache-reset events;
    • customization: hideOfflineNotices, custom errorView/emptyView with the connectToLoad/connectToSearch context fields, and 16 CSS variables;
    • what changes with offline off, and known issues.
  • Core features: an "Offline Support" section in ui-kit/react/core-features.mdx, in the same table format as the other features, linking to the new page. It is also added to the page's quick-reference feature list.
  • Navigation: docs.json gets the new page in React v7 → Features → Chat, right after core-features. The v6 and older tabs are unchanged.
  • LLM index: the new page is listed in ui-kit/react/llms-react-v7.mdx under "Core & configuration".

It links to the JavaScript SDK offline pages (sdk/javascript/offline-*) for config options, the outbox, sync, media caching and encryption, and does not repeat them.

Written against

  • @cometchat/chat-uikit-react 7.3.0 (package.json), branch feature/offline-rework at 046de6c9c, plus its release-notes draft docs/release-notes/7.3.0-offline.md.
  • Every API, prop, event, CSS variable and localization key on the page was checked against the kit source at that commit.
  • This replaces the outdated React page in closed PR docs(offline): Offline Support for the JavaScript SDK, React UI Kit and Angular UI Kit #566. Changes from that draft:
    • the "no retry" statement is gone (the kit now has Retry and Delete);
    • the "initFromSettings doesn't enable it" statement is gone;
    • the "TypeError on an older SDK" statement is gone (the kit now feature-detects the SDK);
    • the link to /sdk/javascript/offline-support, which no longer exists, now points to the current SDK pages.

Checks

  • python3 -m json.tool docs.json: valid.
  • Every internal link and #anchor in the three changed pages resolves to an existing .mdx file and heading.
  • mint broken-links (mint 4.2.881): 3 broken links in 2 files, all already on main (/llms.txt and /llms-full.txt in design-system.mdx and llms-index.mdx). None are in the changed files.

Needs confirmation

  • Release versions. React UI Kit 7.3.0 (from package.json; the release notes are still marked "draft") and JavaScript Chat SDK 4.3.0 as the minimum for offline. The kit's peer range stays ^4.2.0.
  • Edits, deletes and reactions offline. The page says they are not queued: they fail, reactions roll back, and onError is called. This matches the kit code (useMessageListActions.ts, useCometChatMessageComposer.ts) and the SDK page "Edits, Deletes, and Reactions Need a Connection". Please confirm this is the intended product message for 7.3.0.
  • initFromSettings not documented. It also accepts an offline config, but it is marked @internal in the kit, so the page leaves it out.
  • Unused string left out. notifications_offline_banner ("You are offline. Showing cached notifications.") exists in the locale files but no component uses it, so it is not documented.
  • Search screen. The page gives a short summary of when the Search screen shows "Connect to search", "No results" or the error view, taken from the release notes. Please confirm the summary is enough.
  • Screenshots. The new page has none, and none exist yet for the offline states.

🤖 Generated with Claude Code

https://claude.ai/code/session_01WEaVigCRBjkftm78T25MQA

@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 17, 2026, 7:21 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

This branch was successfully deployed

1 active deployment
staging — 64b01095 Deployed Nov 17, 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