Important
This package is presently in its alpha stage of development
A protocol-oriented, batteries-included framework for building chat interfaces in Swift.
- Open your Swift project in Xcode.
- Go to
File->Add Package Dependency. - In the search bar, enter the URL: https://github.com/PreternaturalAI/ChatKit.
- Choose the version you'd like to install.
- Click
Add Package.
+ import ChatKitFor example:
public struct Message: Codable, Hashable, Identifiable, Sendable {
public enum Role: Codable, Hashable, Sendable {
case user
case assistant
}
public var id = UUID()
public var creationDate: Date = Date()
public var text: String
public var role: Role = .user
}import SwiftUI
import ChatKit
struct ContentView: View {
// tracks user message input
@State private var inputFieldText: String = ""
let messages = [
Message(text: "User Message", role: .user),
Message(text: "Assistant Message", role: .assistant),
]
var body: some View {
ChatKit.ChatView {
ChatMessageList(
messages
) { (message: Message) in
ChatItemCell(item: AnyChatMessage(message.text))
// logic for when to show the grey reply bubble
.roleInvert(message.role == .assistant)
.onDelete {
// handle message deletion
}
.onEdit { message in
// handle message editing
}
.onResend {
// handle resending message
}
.cocoaListItem(id: message.id)
.chatItemDecoration(placement: .besideItem) {
// message decoration for delete / resend / edit actions
Menu {
// automatically includes the configured actions above
// (e.g. Delete / Edit / Resend)
ChatItemActions()
} label: {
Image(systemName: .squareAndPencil)
.foregroundColor(.secondary)
.font(.body)
.fontWeight(.medium)
}
.menuStyle(.button)
.buttonStyle(.plain)
}
}
if messages.isEmpty {
ContentUnavailableView("No Messages", systemImage: "message.fill")
}
} input: {
// message input
ChatInputBar(
text: $inputFieldText
) { message in
// handle message sending
}
}
}
}