Skip to content

added docs for @all feature and updated ios uikit version #176

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dawinder-cc wants to merge 1 commit into
base: main
Choose a base branch
from
Open

added docs for @all feature and updated ios uikit version #176

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions ui-kit/ios/conversations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -479,6 +479,8 @@ Below is a list of customizations along with corresponding code snippets
| hideDeleteConversationOption | Hides the option to delete a conversation. | `hideDeleteConversationOption = true` |
| hideUserStatus | Hides the online/offline status of users. | `hideUserStatus = true` |
| hideGroupType | Hides the group type (private/public). | `hideGroupType = true` |
| setDisableMentionAll | Controls whether group mentions like @all appear in suggestions. | `.setDisableMentionAll(true)` |
| setMentionAllLabel | Allows setting a custom alias label for group mentions (@channel, @everyone, etc.). | `.setMentionAllLabel("Id", "Label")` |

### Advanced

Expand Down
1 change: 1 addition & 0 deletions ui-kit/ios/core-features.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@ In the example, tapping on this element (depicted as "+2" in the provided image)
## Mentions

Mentions is a robust feature provided by CometChat that enhances the interactivity and clarity of group or 1-1 chats by allowing users to directly address or refer to specific individuals in a conversation.
The feature also supports group mentions like `@all`, enabling users to quickly notify all members in a group chat simultaneously.

<Frame>
<img src="/images/d91c31fc-mentions-27827fc4e5059d5917addbe0f2eab85f.png" />
Expand Down
4 changes: 2 additions & 2 deletions ui-kit/ios/getting-started.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ use_frameworks!

target 'YourApp' do
# CometChat UI Kit for Swift
pod 'CometChatUIKitSwift', '5.1.3'
pod 'CometChatUIKitSwift', '5.1.4'

# Optional: Include if you're using Audio/Video Calling
pod 'CometChatCallsSDK', '4.2.0'
Expand Down Expand Up @@ -163,7 +163,7 @@ https://github.com/cometchat/cometchat-uikit-ios
Exact Version:

```
5.1.3
5.1.4
```

4. Add `CometChatSDK` repeating the above steps for following link and exact version:
Expand Down
2 changes: 2 additions & 0 deletions ui-kit/ios/message-composer.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -354,6 +354,8 @@ Below is a list of customizations along with corresponding code snippets message
| setMaxLine | Sets the maximum number of lines for the composer input. | `set(maxLine: 3)` |
| setCustomSoundForMessages | Sets a custom sound for sending messages. | `set(customSoundForMessages: URL?)` |
| disableSoundForMessages | Disables sound while sending messages. | `disableSoundForMessages = true` |
| setDisableMentionAll | Controls whether group mentions like @all appear in suggestions. | `.setDisableMentionAll(true)` |
| setMentionAllLabel | Allows setting a custom alias label for group mentions (@channel, @everyone, etc.). | `.setMentionAllLabel("Id", "Label")` |

***

Expand Down
3 changes: 2 additions & 1 deletion ui-kit/ios/message-list.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,8 @@ Below is a list of customizations along with corresponding code snippets
| hideSuggestedMessages | Hides the suggested message replies. | `hideSuggestedMessages = true` |
| set(emptyChatGreetingView:) | Custom view displayed when the AI assistant chat is empty. | `emptyChatGreetingView = { /* custom view */ }` |
| set(streamingSpeed:) | Sets the speed of streaming for AI assistant messages. | `streamingSpeed = 50` |

| setDisableMentionAll | Controls whether group mentions like @all appear in suggestions. | `.setDisableMentionAll(true)` |
| setMentionAllLabel | Allows setting a custom alias label for group mentions (@channel, @everyone, etc.). | `.setMentionAllLabel("Id", "Label")` |
***

### Advance
Expand Down
2 changes: 2 additions & 0 deletions ui-kit/ios/search.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,8 @@ Below is a list of customizations along with corresponding code snippets
| **loadingStateView** | Custom loader | `search.set(loadingStateView: spinner)` |
| **emptyStateView** | Custom empty result view | `search.set(emptyStateView: emptyView)` |
| **errorStateView** | Custom error UI | `search.set(errorStateView: errorView)` |
| setDisableMentionAll | Controls whether group mentions like @all appear in suggestions. | `.setDisableMentionAll(true)` |
| setMentionAllLabel | Allows setting a custom alias label for group mentions (@channel, @everyone, etc.). | `.setMentionAllLabel("Id", "Label")` |

### Advanced

Expand Down