Repository navigation
docs(angular): Offline Support for the Angular UI Kit - #609
Draft
raj-dubey1 wants to merge 7 commits into
Draft
raj-dubey1 wants to merge 7 commits into
raj-dubey1 wants to merge 7 commits into
Conversation
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
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
raj-dubey1
marked this pull request as draft
November 16, 2026 14:02
7 of 11 tasks
…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>
…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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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. Commits72a7fe0e,5a0e7819andae8a1db5.Review round 1 (commits
624d5cd7,df2ebe00)SearchConversationsServiceandSearchMessagesServiceare now documented as component-provided, notprovidedIn: 'root'. Add them to your component'sproviders(CometChatSearchprovides its own). Fixed in the "Injected with" rows, both usage samples (addedproviders) and the services overview (api-reference/introduction.mdx).(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)
(error)once.mediaCaching(defaultAUTO).(error). Edits, deletes and reactions are never queued.(searchError). YouremptyView,errorViewandhideErrortake precedence over the offline states.hideOfflineNoticescovers every message list notice. The notice strings and their plural keys are listed.ERROR_OFFLINE_MESSAGE_DISCARDEDrejection is scoped tosendTextMessage()/sendCustomMessage().hideDeleteMessageOptionalso hides Delete on unsent messages. Retry or Delete on a message the SDK no longer holds removes it from the screen.^5.3.0/^4.3.0.Other Angular pages
setOfflineConfig()in theUIKitSettingsBuildertable and a new Offline Support section with an example. Logout deletes the offline cache and settles queued sends withERROR_OFFLINE_MESSAGE_DISCARDED..setOfflineConfig({ enabled: true })line and its version requirements.ccMessageSendStateChanged,ccOfflineCacheReset, and group events that can come from catch-up.hideOfflineNoticesinput rows and theretryOfflineRead()method row.accessibility#search).Checks (19 Nov)
docs.jsonparses, and the Angular nav entries resolve.mint broken-linksreports the same 3 links as onmain(/llms.txtand/llms-full.txtindesign-system.mdxandllms-index.mdx). None is in a changed file.Needs confirmation (added)
integration.mdxandoverview.mdxstill 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)
ui-kit/angular/offline-support.mdx(Offline Support), covering:UIKitSettingsBuilder.setOfflineConfig();(error)output rule, quietERROR_OFFLINE_MESSAGE_DISCARDEDsend rejections,ccMessageSendStateChanged/ccOfflineCacheReset, group events from catch-up, and theconnectToSearch/searchFailed/reconnectSearchError$service signals;hideOfflineNotices, custom error and empty views,retryOfflineRead(), the Retry/Delete option ids, and CSS variables;docs.json, Angular v5 → Features → Chat, right aftercore-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 atef1bdb85on 19 Nov (see the update above). Sources:5.3.0;docs/release-notes/5.3.0-offline.md;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.jsonpasses..mdxfile and heading.mint broken-linksfinds 3 broken links in 2 files:/llms.txtand/llms-full.txtindesign-system.mdxandllms-index.mdx. All 3 are also onmain, and none is in the changed files.Needs confirmation
package.jsonand 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 ownMessageListServiceinternally. The page documents only the component methodCometChatMessageListComponent.retryOfflineRead().notifications_offline_banner). It isn't clear whether it belongs to this feature, so the page leaves it out.initFromSettingsoffline 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.@angular/cli@22. Node versions are listed per Angular major. Thedompurifypeer is^3.4.17.AppComponentnote: "Angular 18–19". Zoneless notes: "Angular 21+".🤖 Generated with Claude Code
Agent-built with Claude Code, to be reviewed by Raj Dubey.