Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .claude/launch.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"version": "0.0.1",
"configurations": [
{
"name": "mintlify-docs",
"runtimeExecutable": "mint",
"runtimeArgs": ["dev", "--port", "3333"],
"port": 3333
}
]
}
23 changes: 16 additions & 7 deletions ui-kit/ios/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@
| Field | Value |
| --- | --- |
| Package | `CometChatUIKitSwift` |
| Version | `5.1.9` |
| Version | `5.1.18` |
| Requirements | Xcode 16+, iOS 13.0+, Swift 5.0+ |

Check warning on line 13 in ui-kit/ios/getting-started.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/ios/getting-started.mdx#L13

Did you really mean 'Xcode'?
| Init | `CometChatUIKit.init(uiKitSettings:)` — must complete before `login()` |
| Login | `CometChatUIKit.login(uid:)` — must complete before rendering components |
| Order | `init()` → `login()` → render. Breaking this order = blank screen |
| Auth Key | Dev/testing only. Use Auth Token in production |
| Calling | Optional. Install `CometChatCallsSDK 4.2.2` to enable |
| Dependencies | `CometChatSDK 4.1.0` (installed automatically) |
| Calling | Optional. Install `CometChatCallsSDK 4.2.3` to enable |
| Dependencies | `CometChatSDK 4.1.7` (installed automatically) |
| AI Skills | `npx @cometchat/skills add` — [GitHub](https://github.com/cometchat/cometchat-skills) |

</Accordion>
Expand Down Expand Up @@ -45,11 +45,11 @@
/cometchat add chat to my app
```

The skill detects your iOS project structure, navigation pattern (UIKit or SwiftUI), and existing auth system. It onboards you to CometChat directly in the terminal — signup, login, and app creation all via the CLI. It reads your view controllers, navigation, and components before proposing a placement, shows the plan, and waits for your approval before writing code. Credentials are saved via `Secrets.swift` or `.xcconfig`.

Check warning on line 48 in ui-kit/ios/getting-started.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/ios/getting-started.mdx#L48

Did you really mean 'UIKit'?

Check warning on line 48 in ui-kit/ios/getting-started.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/ios/getting-started.mdx#L48

Did you really mean 'onboards'?

Check warning on line 48 in ui-kit/ios/getting-started.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/ios/getting-started.mdx#L48

Did you really mean 'signup'?

After the first integration, re-run `/cometchat` to access the iteration menu: theme presets, 40+ features, component customization, production auth, user management, and diagnostics.

Works with Claude Code, Cursor, Codex, VS Code Copilot, Windsurf, Cline, Kiro, and [30+ more agents](https://github.com/cometchat/cometchat-skills).

Check warning on line 52 in ui-kit/ios/getting-started.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/ios/getting-started.mdx#L52

Did you really mean 'Kiro'?

---

Expand All @@ -64,7 +64,7 @@
| Region | Dashboard → Your App → Credentials (e.g. `us`, `eu`, `in`) |

You also need:
- Xcode 16 or later

Check warning on line 67 in ui-kit/ios/getting-started.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/ios/getting-started.mdx#L67

Did you really mean 'Xcode'?
- iOS device or simulator running iOS 13.0+
- Swift 5.0+
- macOS
Expand All @@ -77,7 +77,7 @@

## Step 1 — Create an iOS Project

Open Xcode and create a new project:

Check warning on line 80 in ui-kit/ios/getting-started.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/ios/getting-started.mdx#L80

Did you really mean 'Xcode'?

1. Select **iOS App** in the template picker and click Next
2. Enter your project name and bundle identifier
Expand All @@ -90,23 +90,23 @@

<Tabs>
<Tab title="CocoaPods">
1. Create a Podfile in your project root:

Check warning on line 93 in ui-kit/ios/getting-started.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/ios/getting-started.mdx#L93

Did you really mean 'Podfile'?

```bash
pod init
```

2. Add CometChat to your Podfile:

Check warning on line 99 in ui-kit/ios/getting-started.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/ios/getting-started.mdx#L99

Did you really mean 'Podfile'?

```ruby title="Podfile"
platform :ios, '13.0'
use_frameworks!

target 'YourApp' do
pod 'CometChatUIKitSwift', '5.1.9'
pod 'CometChatUIKitSwift', '5.1.18'

# Optional: Voice/Video Calling
pod 'CometChatCallsSDK', '4.2.2'
pod 'CometChatCallsSDK', '4.2.3'
end
```

Expand Down Expand Up @@ -135,7 +135,7 @@
3. Select **Up to Exact Version** and enter:

```
5.1.9
5.1.18
```

4. Add the Chat SDK separately using:
Expand All @@ -144,10 +144,19 @@
https://github.com/cometchat/chat-sdk-ios
```

Exact Version: `4.1.0`
Exact Version: `4.1.7`
</Tab>
</Tabs>

<Warning>
**Pin the Chat SDK to the exact version the UI Kit requires.** `CometChatUIKitSwift` ships as a prebuilt binary compiled against one specific `CometChatSDK` version — for UI Kit `5.1.18` that is `CometChatSDK 4.1.7` (see the version table at the top of this page).

- **CocoaPods** installs the matching `CometChatSDK` automatically when you run `pod install`. Don't add your own `CometChatSDK` pod pinned to a different version.
- **Swift Package Manager** does not resolve it for you — add `chat-sdk-ios` with **Up to Exact Version** set to the version the UI Kit depends on. Forcing a newer or older Chat SDK (an SPM override) is unsupported and typically fails to build or crashes at runtime.

To adopt a newer Chat SDK release, upgrade to a UI Kit version that depends on it rather than overriding the SDK version directly. The full list of Chat SDK releases is on [GitHub](https://github.com/cometchat/chat-sdk-ios/releases).
</Warning>

---

## Step 3 — Configure Permissions
Expand All @@ -172,12 +181,12 @@
<img src="/images/e736dfc8-app_permissions-6c9e93e30fb31f4e1427f6b72f94a58b.png" />
</Frame>

Also disable **User Script Sandboxing** in Build Settings to ensure WebView can load scripts for collaborative tools:

Check warning on line 184 in ui-kit/ios/getting-started.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/ios/getting-started.mdx#L184

Did you really mean 'Sandboxing'?

1. Select your project in the Navigator
2. Select your app target
3. Go to **Build Settings** tab
4. Search for "User Script Sandboxing"

Check warning on line 189 in ui-kit/ios/getting-started.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/ios/getting-started.mdx#L189

Did you really mean 'Sandboxing'?
5. Set it to **No**

<Frame>
Expand Down Expand Up @@ -251,7 +260,7 @@
}
```

For development, use one of the pre-created test UIDs:

Check warning on line 263 in ui-kit/ios/getting-started.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/ios/getting-started.mdx#L263

Did you really mean 'UIDs'?

`cometchat-uid-1` · `cometchat-uid-2` · `cometchat-uid-3` · `cometchat-uid-4` · `cometchat-uid-5`

Expand Down Expand Up @@ -284,7 +293,7 @@

### Conversation List + Message View

Two-panel layout — conversation list with push navigation to messages. Think iMessage or WhatsApp.

Check warning on line 296 in ui-kit/ios/getting-started.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/ios/getting-started.mdx#L296

Did you really mean 'iMessage'?

- Push-based navigation between conversations and messages
- Supports one-to-one and group chats
Expand Down
Loading