Skip to content

docs(react-native): Offline Support for the React Native UI Kit - #610

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

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

Conversation

@raj-dubey1

Copy link
Copy Markdown
Contributor

What's added

  • New page ui-kit/react-native/offline-support.mdx ("Offline Support"), covering:
    • Requirements: the native peers, the native rebuild, Android compileSdk/media3, and Expo.
    • Enable: UIKitSettings.offline, initFromSettings, and CometChat.isOfflineEnabled().
    • Per-component offline behavior: lists, search, message list and threads, sending, media, edits/deletes/reactions, presence, Pinned/Saved/Reactions/Notifications, and logout.
    • A table of the offline texts with their localization keys.
    • Errors and callbacks: the onError matrix, the send* promise contract (ERROR_OFFLINE_MESSAGE_DISCARDED), and OfflineMessageEvents.
    • Customization: hideOfflineNotices, custom views, messageListStyles.offlineStyles, and translations.
    • Behavior with offline turned off, limitations and known issues, and next steps.
  • core-features.mdx: a short "Offline Support" section with a component table and a link to the new page.
  • Nav: docs.json, RN v5 → Features → Chat, right after core-features.
  • llms-react-native-v5.mdx: the new page is listed under Core & configuration.

Links go to the merged RN SDK pages (sdk/react-native/offline-*); SDK content is not repeated here.

Source

Written against cometchat/cometchat-uikit-react-native, branch feature/offline-support-v3 at ab58c2291, package packages/ChatUiKit (@cometchat/chat-uikit-react-native 5.6.0), and its draft release notes docs/release-notes/5.6.0-offline.md. Every API name, prop, style token, event, type and string key was checked in the kit source at that commit.

Checks

  • python3 -m json.tool docs.json: valid.
  • Every internal link and anchor in the changed files resolves to an existing .mdx file and heading (checked by script).
  • mint broken-links: 3 broken links repo-wide, all pre-existing in design-system.mdx and llms-index.mdx (/llms.txt, /llms-full.txt). None are in this PR's files.

Needs confirmation

  • Release versions. The page says UI Kit 5.6.0 (from package.json and the release-notes draft) and Chat SDK 4.2.0. Please confirm these are the final versions.
  • Native code. The release-notes draft says "The kit adds no native code", but the branch adds native file-copy code to FileManager.java, SafeFileName.java and ios/FileManager.m (commits c878074cf and 3b1fa3512). The page follows the code and says a native rebuild is needed. Please update the release notes, or tell me if the page should change.
  • Android file-open known issue. The release notes say a file the SDK cached but the kit never downloaded can't be opened offline on Android. c878074cf later made Download and Share use the saved file. The page keeps the known issue, worded as "may not open". Please confirm it still holds.
  • media3 / compileSdk. The media3 1.8.0 dependency and the RNVideo_media3Version override (android/build.gradle:76-79) already shipped in 5.5.4; they are not new in 5.6.0. The page documents them because a rebuild for offline support runs into them. The example override value 1.4.1 comes from the kit's own build.gradle comment.
  • Expo. The kit's release notes don't mention Expo. The note "dev build / expo prebuild, not Expo Go" comes from the RN SDK offline page and the existing Expo Integration page, which already says the kit needs native modules.
  • hideOfflineNotices scope. The list of notices it hides comes from the prop's doc comments. I did not trace whether the "Sending… try again in a moment" and "File too large to send offline" notices are also hidden.

🤖 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.

This branch was successfully deployed

1 active deployment
staging — ac2cd8c5 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