Skip to content

docs(ENG-57593): offline support for the iOS UI Kit - #612

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

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

Conversation

@raj-dubey1

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

Copy link
Copy Markdown
Contributor

Summary

Adds the iOS UI Kit Offline Support page and brings the rest of the iOS UI Kit v5 docs in line with it. The page was first written against an earlier UI Kit build. ENG-57593 rechecked every claim against the final offline sources, fixed what had changed, and added offline notes to the reference and component pages that never mentioned offline.

Ticket: ENG-57593
Parent: none
AI-DLC path: light (docs)
Base: main

Changes

First commit (8df54dac, 16 Nov)

  • New page ui-kit/ios/offline-support.mdx.
  • core-features.mdx: an Offline Support section.
  • docs.json: nav entry under iOS v5 → Features → Chat.
  • llms-ios-v5.mdx: link to the new page.

ENG-57593 update (19 Nov: 405c8ca2, a258495c, 525fef74, 3c7a6be7)

offline-support.mdx, corrected against the final UI Kit and Chat SDK sources:

  • Media. The page no longer promises that media is queued offline. Files picked in the attachment tray upload as soon as they're picked, so they need a connection. The page now says to send photos, videos, audio and documents while connected.
  • What queues. Text messages and voice notes queue. So do CometChatUIKit.sendTextMessage, sendCustomMessage, sendFormMessage, sendCardMessage and sendSchedulerMessage.
  • Failed edit, delete or reaction. The new notices are documented. A failed edit keeps the message's old text and calls onError. The standard composer keeps the edit; the compact composer leaves edit mode when you tap Send.
  • Unsent rows.
    • "Not sent yet" shows under a queued message.
    • VoiceOver reads the hint "Retry".
    • Tapping the clock of a queued message retries it.
    • Retry and Delete remove a message the SDK no longer holds.
  • Reaction list. It keeps its tabs while offline.
  • Presence. Presence is hidden while the SDK is connecting.
  • Logout and user switch. These delete the SDK's offline cache and the UI Kit's saved avatars. Avatars are kept up to 250 MB.
  • Notices table. The "where it appears" column is corrected.
  • Offline events. The wording is corrected.
  • Catch-up delay. Missed messages can take "up to about 10 s" to appear after a quick reconnect (was 15 s). This matches the SDK's sync interval.
  • Removed. The "queue-full refusal can show as pending first" limitation; the final SDK fixed it.
  • Added. The offline-off change for local media links: a file:// or absolute-path link in another user's message is never opened, shown or shared, and bubble downloads move to Documents/cc_media/.
  • SDK minimum. The requirement now reads: UI Kit 5.3.0, the first version with offline support, needs Chat SDK 4.2.1 or later.

methods.mdx:

  • A setOfflineConfig(_:) row in the UIKitSettings table.
  • A new "Enable offline support" section with a Swift example.
  • A quick-reference line.
  • A logout note (the offline cache is cleared and waiting sends are discarded with ERROR_OFFLINE_MESSAGE_DISCARDED).
  • A note on which send methods queue.

Other pages:

  • getting-started.mdx: an offline row in the quick reference, scoped to UI Kit 5.3.0+, and a tip in Step 4.
  • search.mdx: with offline on, CometChatSearch has set(onError:). The page used to say it had no onError.
  • events.mdx: ccMessageSendStateChanged and ccOfflineCacheReset.
  • localize.mdx: a link to the offline texts table.
  • message-list.mdx and conversations.mdx: the hideOfflineNotices property.
  • message-composer.mdx and compact-message-composer.mdx: "Sending while offline".
  • threaded-messages-header.mdx, message-bubble-styling.mdx and core-features.mdx: one line each.
  • guide-threaded-messages.mdx: the "Offline mode" edge-case row now matches the offline page.

Checks run

Command Result
node -e "JSON.parse(require('fs').readFileSync('docs.json'))" pass
mint broken-links, compared with the same run on the branch before this update no new broken links. 3 failures already on main remain: /llms.txt and /llms-full.txt in design-system.mdx and llms-index.mdx
Resolver for links and anchors on added lines 41 links checked, 0 broken
Swift shape check: every symbol, signature and localization key used on the changed pages, grepped in the UI Kit (2162bd47) and Chat SDK (c158761a) sources pass
Independent claim check against the same sources pass

Tests

  • Docs only, so there are no unit tests.
  • Swift snippets were checked against the source signatures, not compiled.

Risk and rollback

  • Risk: Low. Docs only, but customers see it as soon as it merges, so it should merge only when UI Kit 5.3.0 is released.
  • Public API: none.
  • Rollback: revert this PR.

Release notes

Version: n/a (docs)

  • New: iOS UI Kit Offline Support page
  • Enhancements: offline notes across the iOS UI Kit reference and component pages
  • Fixes: None

QA notes

  • Preview with mint dev and open /ui-kit/ios/offline-support, /ui-kit/ios/methods#enable-offline-support and /ui-kit/ios/search.
  • E2E specs: none.

Provenance

Agent-built with Claude Code for Raj Dubey. A human review is still needed before merge.

Needs confirmation / known gaps

  • Chat SDK minimum. The docs say UI Kit 5.3.0 needs Chat SDK 4.2.1 or later. The UI Kit's Package.swift still declares from: "4.2.0", but the UI Kit calls initFromSettings(offlineConfig:), which 4.2.0 doesn't have. Confirm the final UI Kit and Chat SDK versions before merge. Other pages still describe 5.2.x with Chat SDK 4.1.10+; that is a release-day update.
  • Programmatic sendMediaMessage. In the source it goes through the offline queue, but the docs deliberately don't promise queued media (no platform queues media picked offline). Confirm this wording.
  • Compact composer. A failed edit leaves the compact composer out of edit mode, while the standard composer keeps the edit. The docs describe both as they are in the code.
  • Branch name. The branch is docs/uikit-offline-ios (the existing PR branch), not docs/ENG-57593-…. The first commit (8df54dac) has no ticket ID. It was not rewritten, to avoid a force-push.
  • File count. 16 files, over the usual 10, because the ticket asks for offline mentions across the iOS UI Kit pages.
  • Still open from the first version:
    • CocoaPods (the page gives no pod line).
    • notSentYetTextColor and notSentYetTextFont are now used for the "Not sent yet" text (CometChatMessageList+Offline.swift:116-117), so they stay on the page.
    • CometChatUIKit.initFromSettings(offlineConfig:completion:) stays undocumented (:nodoc:).
  • Problems found on these pages but not fixed (out of scope):
    • search.mdx documents onBack, which CometChatSearch doesn't have.
    • localize.mdx says 17 languages; the UI Kit ships 19.
    • The methods.mdx UIKitSettings table uses method names that don't match the UI Kit (setAIFeatures, setExtensions, setAutoEstablishSocketConnection).
    • Two anchors don't resolve: core-features.mdx → message-bubble-styling#file-bubble, and search.mdx → message-list#itemview.

Update 20 Nov: checked against the iOS UI Kit (140b048f)

Every claim on the changed pages was checked against the iOS UI Kit at temp-release-offline-v5 d4d643870 (about 100 claims: APIs, settings, strings in all 19 locales, list states, events, styles, snippets and links). One gap was fixed: "media picked offline is not queued" is true only for the attachment tray (the default). With enableMultipleAttachments = false, or through CometChatUIKit.sendMediaMessage, a media message is queued like a voice note (MessageComposerBuilder.swift:50-53, CometChatUIKit.swift:579). The pages now say so. Two wordings were also tightened: the initFromSettings(offlineConfig:…) sentence, and "Saved rows show first" became "Rows cached on the device show first".

🤖 Generated with Claude Code

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 20, 2026, 9:47 AM

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

raj-dubey1 and others added 4 commits November 19, 2026 16:46
…5.3.0

Files picked in the attachment tray upload at once and are not queued;
only text, voice notes and single-file sends queue. Failed edits,
reactions and deletes now show a notice; the compact composer leaves
edit mode on Send. Adds "Not sent yet" under queued messages, Retry and
Delete removing a message the SDK no longer holds, the reaction list's
tabs, the avatar cache, the logout cache wipe, the media-link and
cc_media change, and corrects the notices table, presence, the event
wording and the catch-up delay (10 s in the SDK).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Methods documents UIKitSettings.setOfflineConfig(_:) with an example,
and what logout and the send methods do with offline on. Integration,
events, localize, search, message list, conversations, both composers,
the thread header and bubble styling get one line each with a link to
the offline page. Search no longer says it has no onError.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Photos, videos, audio files and documents are to be sent while
connected; the pages no longer say a picked file is queued. The methods
note now covers sendTextMessage and sendCustomMessage only and links to
the send-completions section for form, card and scheduler messages. The
threaded-messages guide's offline row now matches the offline page: the
composer stays enabled, text replies and voice notes queue, and edits,
deletes and reactions need a connection.

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

The offline page, methods, core features and integration now say that
UI Kit 5.3.0, the first version with offline support, needs Chat SDK
4.2.1 or later, so they no longer disagree with the 5.2.x numbers on
the other pages. The integration quick reference marks its offline row
as applying from 5.3.0. The offline page and methods now list
sendFormMessage, sendCardMessage and sendSchedulerMessage beside
sendTextMessage and sendCustomMessage as sends that queue offline.

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(ios): Offline Support for the iOS UI Kit docs(ENG-57593): offline support for the iOS UI Kit Nov 19, 2026
Checked against the iOS UI Kit at temp-release-offline-v5 d4d643870:
- Only files picked in the attachment tray (enableMultipleAttachments,
  the default) need a connection. With enableMultipleAttachments = false
  a pick is sent through sendSingleMedia -> MessageComposerBuilder
  .mediaMessage -> OfflineSend.send and is queued like a voice note
  (MessageComposerBuilder.swift:50-53; same in the compact composer).
- CometChatUIKit.sendMediaMessage also queues offline (CometChatUIKit
  .swift:579), so methods.mdx lists it and drops "send media while
  connected".
- initFromSettings(offlineConfig:...) is used by the kit's own
  initFromSettings, not by every init: reworded.
- "Saved rows show first" read as the Saved Messages component's rows:
  now "Rows cached on the device show first".

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XbguTt1cqFxTDQyroF6wHx

This branch was successfully deployed

1 active deployment
staging — 140b048f Deployed Nov 20, 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