Skip to content

docs(angular): Offline Support for the Angular UI Kit - #609

Draft
raj-dubey1 wants to merge 7 commits into
mainfrom
docs/uikit-offline-angular
Draft

raj-dubey1 wants to merge 7 commits into
mainfrom
docs/uikit-offline-angular

Conversation

@raj-dubey1

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

Copy link
Copy Markdown
Contributor

Update 19 Nov (ENG-57591)

Re-checked every claim against the Angular UI Kit 5.3.0 release candidate (ef1bdb85) and the JavaScript Chat SDK release candidate (57f98889), which include the 19 Nov fixes. Also added offline notes to the other Angular reference pages. Commits 72a7fe0e, 5a0e7819 and ae8a1db5.

Review round 1 (commits 624d5cd7, df2ebe00)

  • Search service reference pages: SearchConversationsService and SearchMessagesService are now documented as component-provided, not providedIn: 'root'. Add them to your component's providers (CometChatSearch provides its own). Fixed in the "Injected with" rows, both usage samples (added providers) and the services overview (api-reference/introduction.mdx).
  • Offline Support, Lists: the Reconnect bullet now says the components make no refresh fetch of their own, apart from the one-time reads listed above it.
  • Offline Support, Search errors: (searchError) fires only for a scope that failed for a real reason, not for a scope that failed only because it was offline.

Offline Support page (corrected)

  • Only text and custom messages are described as queued. Removed every claim that photos, videos or files picked offline are queued. Also removed the File too large to send offline string and the Media attachments bullet.
  • Jumping to a message keeps the messages on screen; a real error fires (error) once.
  • The Reaction List keeps its tabs and counts offline.
  • Available when online covers images, videos, audio and files. Media caching follows the SDK's mediaCaching (default AUTO).
  • A failed edit leaves edit mode and goes to the composer's (error). Edits, deletes and reactions are never queued.
  • The Search component reports through (searchError). Your emptyView, errorView and hideError take precedence over the offline states.
  • hideOfflineNotices covers every message list notice. The notice strings and their plural keys are listed.
  • The quiet ERROR_OFFLINE_MESSAGE_DISCARDED rejection is scoped to sendTextMessage() / sendCustomMessage(). hideDeleteMessageOption also hides Delete on unsent messages. Retry or Delete on a message the SDK no longer holds removes it from the screen.
  • The thread limitation is scoped to Chat SDK 4.3.0.
  • Removed the Angular version row from the requirements. The install line now uses ^5.3.0 / ^4.3.0.

Other Angular pages

  • Methods: setOfflineConfig() in the UIKitSettingsBuilder table and a new Offline Support section with an example. Logout deletes the offline cache and settles queued sends with ERROR_OFFLINE_MESSAGE_DISCARDED.
  • Integration and Quickstart: the optional .setOfflineConfig({ enabled: true }) line and its version requirements.
  • Events: ccMessageSendStateChanged, ccOfflineCacheReset, and group events that can come from catch-up.
  • Localization: a pointer to the offline text keys.
  • Core Features: the composer queues text messages only.
  • Conversations, Message List, Composer and Search: one-line offline notes with links. Added the hideOfflineNotices input rows and the retryOfflineRead() method row.
  • Search: fixed an existing broken anchor (accessibility#search).

Checks (19 Nov)

  • docs.json parses, and the Angular nav entries resolve.
  • Internal links and anchors in the 11 changed pages: 207 checked, 0 broken.
  • mint broken-links reports the same 3 links as on main (/llms.txt and /llms-full.txt in design-system.mdx and llms-index.mdx). None is in a changed file.

Needs confirmation (added)

  • Media picked offline. The kit's composer still hands picked files to the SDK's offline queue. The docs make no promise about it, to match Android.
  • Minimum SDK version. Thread caching and several 19 Nov fixes are in the next SDK release, not in 4.3.0. Should the minimum SDK be raised once that version is published?
  • Angular version range. integration.mdx and overview.mdx still say Angular 17–21, while the kit's peer range is >=18.0.0 <23.0.0. Those pages are not changed here.

What's added (original draft)

  • New page ui-kit/angular/offline-support.mdx (Offline Support), covering:
    • overview of what works offline and what needs a connection;
    • requirements;
    • enabling offline support with UIKitSettingsBuilder.setOfflineConfig();
    • how lists, search, the message list and threads, the composer, media, presence and logout behave offline;
    • the offline texts with their localization keys;
    • errors and callbacks: the (error) output rule, quiet ERROR_OFFLINE_MESSAGE_DISCARDED send rejections, ccMessageSendStateChanged / ccOfflineCacheReset, group events from catch-up, and the connectToSearch / searchFailed / reconnectSearchError$ service signals;
    • customization: hideOfflineNotices, custom error and empty views, retryOfflineRead(), the Retry/Delete option ids, and CSS variables;
    • behavior with offline support turned off;
    • limitations;
    • next steps.
  • Core Features: a new "Offline Support" section, and the feature added to the Quick Reference list.
  • Nav: docs.json, Angular v5 → Features → Chat, right after core-features.
  • llms-angular-v5.mdx: a link to the new page.

Links go to the existing JavaScript SDK pages (sdk/javascript/offline-*). The page doesn't repeat what those pages cover.

Source

Originally written against the Angular UI Kit at 8284a6df; re-checked at ef1bdb85 on 19 Nov (see the update above). Sources:

  • package version 5.3.0;
  • the draft release notes in docs/release-notes/5.3.0-offline.md;
  • the API report in api/cometchat-uikit.api.md;
  • projects/cometchat-uikit/src/public-api.ts.

This replaces the outdated Angular draft from closed PR #566.

Checks

  • python3 -m json.tool docs.json passes.
  • Every internal link and anchor in the changed pages resolves to an existing .mdx file and heading.
  • mint broken-links finds 3 broken links in 2 files: /llms.txt and /llms-full.txt in design-system.mdx and llms-index.mdx. All 3 are also on main, and none is in the changed files.

Needs confirmation

  • Release versions. The page says UI Kit 5.3.0 and Chat SDK 4.3.0. They come from the kit's package.json and the draft release notes, which are not released yet.
  • Search service API reference is out of date. Fixed in review round 1: both pages now say the services are component-provided.
  • MessageListService.retryOfflineRead(direction?) is public in the API report. The page doesn't document it, because each message list provides its own MessageListService internally. The page documents only the component method CometChatMessageListComponent.retryOfflineRead().
  • Notification Feed banner. The feed has an existing "You are offline. Showing cached notifications." banner (notifications_offline_banner). It isn't clear whether it belongs to this feature, so the page leaves it out.
  • initFromSettings offline parameter. CometChatUIKit.initFromSettings(settings, offlineConfig?) also takes an offline config, but it is marked @internal. The page leaves it out.

Update 19 Nov: Angular version range (a1476f7)

The release kit (5.3.0, uikit-angular @ ef1bdb85) declares @angular/core / @angular/common >=18.0.0 <23.0.0, which adds Angular 22 (uikit-angular #590). The docs said 17–21 and "Angular 22 is not supported yet". Published 5.2.3 had already dropped 17.

  • Overview, Integration, Quickstart: Angular 18–22 from UI Kit 5.3.0, 5.2.x up to Angular 21. New apps are scaffolded with @angular/cli@22. Node versions are listed per Angular major. The dompurify peer is ^3.4.17.
  • Pages with the AppComponent note: "Angular 18–19". Zoneless notes: "Angular 21+".

🤖 Generated with Claude Code

Agent-built with Claude Code, to be reviewed by Raj Dubey.

Add the Offline Support page for Angular UI Kit v5, an Offline Support
section in Core Features, the nav entry after core-features in the
Angular v5 Features > Chat group, and the page in llms-angular-v5.

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 19, 2026, 5:41 PM

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

raj-dubey1 and others added 3 commits November 19, 2026 16:52
…I Kit 5.3.0

- Offline Support page: match the kit and SDK as of the latest fixes. Jumps
  from messages on screen keep them, the reactions list keeps its counts,
  "Available when online" covers audio and files, the Search component
  reports through (searchError), your emptyView wins over Connect to search,
  hideOfflineNotices covers every message list notice, the notice strings
  and plural keys are listed, a failed edit leaves edit mode and reaches
  (error), and edits are never queued. Media picked offline is no longer
  promised. The thread limitation is scoped to Chat SDK 4.3.0.
- Methods: setOfflineConfig() next to the other init settings, with an
  example, and what logout does to the offline cache and open sends.
- Integration, Quickstart, Events, Localization, Core Features and the
  Conversations, Message List, Message Composer and Search pages: short
  offline notes and links, hideOfflineNotices and retryOfflineRead rows,
  and the offline events.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: multica-agent <github@multica.ai>
The queue-limit, send-promise, logout and hideOfflineNotices wording now
covers text and custom messages only, so no page promises that a photo,
video or file sent offline goes out on reconnect.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: multica-agent <github@multica.ai>
Listing "File too large to send offline" read as if smaller files could be
sent offline. The strings table and the hideOfflineNotices row no longer
name it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: multica-agent <github@multica.ai>
raj-dubey1 and others added 2 commits November 19, 2026 19:53
…ine reconnect and searchError wording

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

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: multica-agent <github@multica.ai>
The release kit (5.3.0, uikit-angular temp-release-offline-v5 @ ef1bdb85) declares
@angular/core and @angular/common ">=18.0.0 <23.0.0" (Angular 22 support, uikit-angular #590).
The docs still said 17-21 and "Angular 22 is not supported yet"; published 5.2.3 already
dropped 17 (">=18.0.0 <22.0.0").

- overview, integration, quickstart: Angular 18-22 from UI Kit 5.3.0, 5.2.x up to 21;
  scaffold with @angular/cli@22; Node versions per Angular major (Angular 22 engines:
  ^22.22.3 || ^24.15.0 || >=26.0.0); dompurify peer ^3.4.17.
- AppComponent note: "Angular 18-19" (17 is no longer supported).
- Zoneless notes: "Angular 21+".

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 — a1476f7c 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