> ## Documentation Index
> Fetch the complete documentation index at: https://cometchat-22654f5b-docs-skills-v5-temp.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# iOS UI Kit v5 — LLM docs index

> Machine-readable, iOS-v5-scoped index of every UI Kit page as a clean .md twin. Built for AI coding agents; kept out of the human sidebar.

# iOS UI Kit v5 — LLM docs index (Latest)

> Stateful, drop-in Swift/UIKit chat and calling UI. Package `CometChatUIKitSwift@5` +
> `CometChatSDK@4` + `CometChatCallsSDK@5`. This page is an **iOS-v5-only** routing index for AI
> agents — a scoped alternative to the site-wide `/docs/llms.txt`.

## How to use this index

Each link points to the docs page; **append `.md`** to its URL to fetch the clean Markdown twin
(verbatim code + an "AI Integration Quick Reference" block with names, types, and defaults). Pick
the page for the intent, then read the API there.

* Convention: any docs page URL + `.md` → raw Markdown.
* Fallback: if a `.md` twin 404s, fetch the same URL **without** `.md` (HTML). Never read the
  framework's `.swiftinterface` for behaviour, and never answer an API from memory.
* iOS specifics: components are `UIView`/`UIViewController` subclasses configured through
  **chainable `set(...)` methods** (`set(user:)`, `set(onItemClick:)`), not React-style props.
  Some surfaces are settable **properties** instead (`hideNavigationBar`, `style`) — check the
  component page rather than assuming a setter exists.

## Install facts an agent must not guess

* **SPM is the supported path.** CocoaPods distribution is winding down; `Podfile`/`.xcworkspace`
  remain valid *detection* signals for an existing project, but new integration uses SPM.
* **All three packages are required, even for a chat-only app.** The UI Kit ships as a prebuilt
  binary whose public `.swiftinterface` imports both `CometChatSDK` and `CometChatCallsSDK`, so
  the module fails to resolve unless every one is declared and linked:
  `cometchat-uikit-ios` · `chat-sdk-ios` · `calls-sdk-ios`.
* **Pin exact versions, not floors.** The UI Kit binary is compiled against one specific Chat SDK
  version and SPM will not resolve that transitively; a floating `from:` can drift into a
  mismatch on the next SDK publish.
* **Deployment target is iOS 15.1**, set by the package itself — not iOS 13.
* Credentials: `.xcconfig` → matching `$(VAR)` entries in **Info.plist** → read via
  `Bundle.main.object(forInfoDictionaryKey:)`. The Info.plist step is mandatory and is the most
  common cause of a nil App ID at runtime.

## Hot path — usually no fetch needed

For a plain "add chat" the install, `init → login → render` ordering, and the core drop-in
composition are stable; a well-built agent skill bakes them. Fetch below only for exhaustive
APIs, long-tail components, theming tokens, or feature enablement.

* Setup: [iOS Integration](/ui-kit/ios/getting-started) · [Overview](/ui-kit/ios/overview)
* **There is no composite chat component.** No `CometChatMessages`,
  `CometChatConversationsWithMessages`, `CometChatUsersWithMessages` or
  `CometChatGroupsWithMessages` exists in v5 — those are v4. A message screen is **host-composed**
  from header + list + composer inside your own view controller. See
  [Conversation List + Message View](/ui-kit/ios/ios-conversation).
* Core drop-ins: [Conversations](/ui-kit/ios/conversations) ·
  [Message Header](/ui-kit/ios/message-header) · [Message List](/ui-kit/ios/message-list) ·
  [Message Composer](/ui-kit/ios/message-composer)
* In SwiftUI hosts, qualify the SDK types — `conversation.conversationWith as? CometChatSDK.User`
  / `as? CometChatSDK.Group`. SwiftUI declares its own `Group`, so the bare cast is ambiguous and
  will not compile.

## Getting started / integration

* [CometChat UI Kit For iOS](/ui-kit/ios/overview)
* [iOS Integration](/ui-kit/ios/getting-started)
* [Components Overview](/ui-kit/ios/components-overview)
* [Core Features](/ui-kit/ios/core-features)
* [Methods](/ui-kit/ios/methods)
* [Events](/ui-kit/ios/events)
* [Upgrading from V4 to V5](/ui-kit/ios/upgrading-from-v4)
* [Troubleshooting](/ui-kit/ios/troubleshooting)

## Task guides (recipes)

End-to-end, buildable walkthroughs. **Build FROM the guide** for a whole feature, then apply
component-level corrections from the component pages on top.

* [Overview](/ui-kit/ios/guide-overview)
* [Conversation List + Message View](/ui-kit/ios/ios-conversation)
* [One-to-One / Group Chat](/ui-kit/ios/ios-one-to-one-chat)
* [Tab-Based Chat](/ui-kit/ios/ios-tab-based-chat)
* [Create Conversation](/ui-kit/ios/guide-new-chat)
* [Group Details](/ui-kit/ios/guide-group-chat)
* [Transfer Group Ownership](/ui-kit/ios/guide-group-ownership)
* [Threaded Messages](/ui-kit/ios/guide-threaded-messages)
* [Message Privately](/ui-kit/ios/guide-message-privately)
* [Block/Unblock User](/ui-kit/ios/guide-block-unblock-user)
* [AI Agent Integration](/ui-kit/ios/guide-ai-agent)
* [Call Log Details](/ui-kit/ios/guide-call-log-details)

## Components — lists

* [Conversations](/ui-kit/ios/conversations)
* [Users](/ui-kit/ios/users)
* [Groups](/ui-kit/ios/groups)
* [Group Members](/ui-kit/ios/group-members)
* [Search](/ui-kit/ios/search)
* [Notification Feed](/ui-kit/ios/notification-feed)

## Components — messaging

* [Message Header](/ui-kit/ios/message-header)
* [Message List](/ui-kit/ios/message-list)
* [Message Composer](/ui-kit/ios/message-composer)
* [Compact Message Composer](/ui-kit/ios/compact-message-composer)
* [Message Template](/ui-kit/ios/message-template)
* [Threaded Messages Header](/ui-kit/ios/threaded-messages-header)
* [Mentions Formatter](/ui-kit/ios/mentions-formatter-guide)
* [ShortCut Formatter](/ui-kit/ios/shortcut-formatter-guide)

## Calling

* [Calling Integration](/ui-kit/ios/calling-integration)
* [Calling Features](/ui-kit/ios/call-features)
* [Call Buttons](/ui-kit/ios/call-buttons)
* [Call Logs](/ui-kit/ios/call-logs)
* [Incoming Call](/ui-kit/ios/incoming-call)
* [Outgoing Call](/ui-kit/ios/outgoing-call)
* [Ongoing Call](/ui-kit/ios/ongoing-call)

## AI

* [AI Features](/ui-kit/ios/ai-features)
* [AI Assistant Chat History](/ui-kit/ios/ai-assistant-chat-history)

## Theming and styling

* [Introduction](/ui-kit/ios/theme-introduction)
* [Component Styling](/ui-kit/ios/component-styling)
* [Message Bubble Styling](/ui-kit/ios/message-bubble-styling)
* [Color Resources](/ui-kit/ios/color-resources)

## Features and extras

* [Extensions](/ui-kit/ios/extensions)
* [Campaigns](/ui-kit/ios/campaigns)
* [Localize](/ui-kit/ios/localize)
* [Sound Manager](/ui-kit/ios/sound-manager)

## When the UI Kit has no component

Some capabilities ship no UI Kit component — AI agents, campaigns, moderation, adding group
members, transient messages, low-level presence, webhooks. For those, **drop to the Chat SDK** and
call the method directly; it is already linked under the kit. Start at the scoped SDK index:
[iOS SDK v4 — LLM docs index](/sdk/ios/llms-ios-v4).
