Skip to content

docs(ios): Offline Support for the iOS UI Kit - #612

Draft
raj-dubey1 wants to merge 1 commit into
mainfrom
docs/uikit-offline-ios
Draft

raj-dubey1 wants to merge 1 commit into
mainfrom
docs/uikit-offline-ios

Conversation

@raj-dubey1

Copy link
Copy Markdown
Contributor

What's added

  • New page ui-kit/ios/offline-support.mdx ("Offline Support"): overview, requirements, enabling offline (UIKitSettings.setOfflineConfig(_:)), how each component behaves offline, a table of offline texts with their localization keys, errors and callbacks (onError rules, ERROR_OFFLINE_MESSAGE_DISCARDED on sendFormMessage / sendCardMessage / sendSchedulerMessage, the ccMessageSendStateChanged / ccOfflineCacheReset events), customization (CometChatOfflineStyle, hideOfflineNotices, custom empty/error views), offline-off changes, known issues, and next steps linking to the sdk/ios/offline-* pages.
  • ui-kit/ios/core-features.mdx: an offlineSupport entry in the AI quick-reference JSON and a short "Offline Support" section after Search, linking to the new page.
  • docs.json: nav entry under iOS v5 → Features → Chat, right after core-features.
  • ui-kit/ios/llms-ios-v5.mdx: link under "Features and extras".

Written against

  • iOS UI Kit feature/offline-rework at ece3075cd (MARKETING_VERSION / UIKitConstants.version = 5.3.0), with docs/release-notes/5.3.0-offline.md (draft).
  • Every API, property, default, event and localization key on the page was checked against the source at that commit.

Needs confirmation

  • Chat SDK minimum. The page says CometChatSDK 4.2.1 or later. The kit's Package.swift still says from: "4.2.0". The release notes say the pin must move to the Chat SDK release that has CometChat.initFromSettings(offlineConfig:onSuccess:onError:), because the kit doesn't compile against 4.2.0. Please confirm the final version number. The SDK offline pages (sdk/ios/offline-enable.mdx) say 4.2.0 for the SDK on its own, and the new page explains the difference.
  • UI Kit version 5.3.0. The release notes are still a draft, and Package.swift still points its binary at 5.1.22. Please confirm the release version and the SPM "Up to Next Major Version" value.
  • CocoaPods. The existing iOS pages ship through SPM only (CocoaPods stops at 5.1.18), so the page repeats that warning and gives no pod line.
  • notSentYetTextColor / notSentYetTextFont are public on CometChatOfflineStyle, but nothing in the kit reads them yet: a queued row shows the clock, and "Not sent yet" is only its VoiceOver label. They're documented as "where shown as text". Please confirm whether to keep them on the page.
  • CometChatUIKit.initFromSettings(offlineConfig:completion:) is public but marked :nodoc: and "for AI agent skills, not documented for developers", so it's deliberately left out.
  • Pre-existing, not changed here: core-features.mdx links to /ui-kit/ios/message-bubble-styling#file-bubble, which has no matching heading. mint broken-links also reports /llms.txt and /llms-full.txt in design-system.mdx and llms-index.mdx.

🤖 Generated with Claude Code

https://claude.ai/code/session_01WEaVigCRBjkftm78T25MQA

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: 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 16, 2026, 12:36 PM

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

This branch was successfully deployed

1 active deployment
staging — 8df54dac Deployed Nov 16, 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