repository·develop·Indexed 19 days ago
https://github.com/getstream/stream-chat-swiftuiA declarative, high-performance UI framework for iOS built on top of the StreamChat core framework. It provides ready-to-use, customizable chat components including channel lists, message lists, and message composers. The SDK offers three tiers of components: high-level Screens, stateful components with built-in view models, and low-level stateless components for fully custom chat experiences.
The Channel List component allows users to browse and interact with channels. Key features include:
The Message List component is a high-performance list designed to render various message types. Key features include:
The Message Composer is a powerful, customizable input area. Key features include:
The SwiftUI SDK provides three tiers of components depending on the level of control and customization you require:
The SwiftUI SDK provides two distinct types of components to balance ease of use with customization:
The SDK is built on top of the StreamChat framework and follows declarative SwiftUI patterns.
You can generate and open the local documentation archive using xcodebuild. This will build the .doccarchive and open it automatically in Xcode.
xcodebuild docbuild -skipMacroValidation -skipPackagePluginValidation -derivedDataPath .derivedData -scheme StreamChatSwiftUI -destination generic/platform=iOS | xcpretty
open .derivedData/Build/Products/Debug-iphoneos/StreamChatSwiftUI.doccarchiveTo integrate Stream Chat into your iOS app using SwiftUI, add the SDK as a Swift Package dependency in Xcode:
.xcodeproj.https://github.com/getstream/stream-chat-swift.StreamChatSwiftUI to use the SwiftUI-based UI components. If you only need the low-level client without UI, select StreamChat.Note: The minimal Swift version requirement for this installation method is 5.3 because the SDK must be distributed with resources.
https://github.com/getstream/stream-chat-swiftThe InstantCommandsHandler follows a delegation pattern to manage commands:
canHandleCommand(in:caretLocation:) iterates through its child commands to see if any can handle the current text. If no child handles it, it checks if the text matches the symbol (e.g., /) to trigger a typing suggestion.showSuggestions(for:) returns a Future containing SuggestionInfo. If a child handler is identified, it delegates the suggestion request to that handler; otherwise, it returns the list of child commands as suggestions.handleCommand(...) and executeOnMessageSent(...) delegate the actual logic of transforming text or performing actions to the specific child CommandHandler responsible for that command.canBeExecuted(...) checks if a command is valid for execution by delegating to the appropriate child handler.The StreamChatSwiftUI SDK relies on the following dependencies:
The InstantCommandsHandler is used to manage instant commands (triggered by a symbol like /) within the chat composer. It acts as a container for multiple CommandHandler instances, delegating command detection, suggestion display, and execution to them.
To use it, provide an array of CommandHandler objects and an optional symbol (defaults to /).
let myCommands: [CommandHandler] = [
// Your custom command handlers here
]
let instantHandler = InstantCommandsHandler(
commands: myCommands,
symbol: "/",
id: "instantCommands"
)The CommandSuggestionsView is a UI component used to display a list of available commands (e.g., slash commands) when a user is typing in the chat composer. It renders a header and a scrollable list of command rows.
To use this view, you need to provide:
instantCommands: An array of CommandHandler objects representing the available commands.commandSelected: A closure that is executed when a user taps a command. This closure receives a ComposerCommand object.When a command is selected, the view constructs a ComposerCommand using the handler's id, displayInfo, and replacesMessageSent property.
CommandSuggestionsView(
instantCommands: myCommandHandlers,
commandSelected: { composerCommand in
// Handle the selected command
print("Selected command: \(composerCommand.id)")
}
)The MuteCommandHandler is a specialized command handler used within the Chat Composer to process mute requests. It implements the TwoStepMentionCommand protocol, which implies a two-step interaction flow (likely selecting a user and then confirming the action).
When executed, the handler uses the ChatClient to call the mute method on the userController for the specifically selected user.
Key characteristics:
/mute.executeOnMessageSent method triggers the actual mute action via the chatClient.ChatChannelController and a commandSymbol for initialization.// Example of how the handler is initialized within the SDK context
let handler = MuteCommandHandler(
channelController: channelController,
commandSymbol: "/mute"
)