https://github.com/eneskaraosman/swiftychat
SwiftUI Chat UI (Client) Framework & Documentation to get started!
https://github.com/eneskaraosman/swiftychat
chat chat-application chat-bot chatbot chatbot-framework chatroom inputview ios message messaging swiftui
Last synced: 2 months ago
JSON representation
SwiftUI Chat UI (Client) Framework & Documentation to get started!
- Host: GitHub
- URL: https://github.com/eneskaraosman/swiftychat
- Owner: EnesKaraosman
- License: apache-2.0
- Created: 2020-05-24T13:24:29.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-13T12:39:59.000Z (about 2 years ago)
- Last Synced: 2024-05-01T17:54:02.278Z (about 2 years ago)
- Topics: chat, chat-application, chat-bot, chatbot, chatbot-framework, chatroom, inputview, ios, message, messaging, swiftui
- Language: Swift
- Homepage:
- Size: 18.4 MB
- Stars: 250
- Watchers: 14
- Forks: 46
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# SwiftyChat
A lightweight SwiftUI chat UI with [built-in message types](#message-kinds), theming, and cross-platform support.
Also available for [Flutter](https://github.com/EnesKaraosman/swifty_chat).
## Features
- High-performance rendering (O(n) complexity, cached formatters, async image loading)
- 10 built-in message types including text, image, video, location, carousel, and quick replies
- 8 pre-built [themes](#pre-built-themes) with full style customization via environment
- [Custom message cells](CustomMessage.md) for any message type you need
- Cross-platform: iOS 17+ and macOS 14+
- Landscape orientation support with auto-scaling cells
- User avatars with configurable positioning
- Keyboard dismiss on tap and scroll
- Scroll to bottom or to a specific message
- Picture-in-Picture video playback
- Per-corner rounding on text bubbles
- Multiline input bar ([BasicInputView](../master/Sources/SwiftyChat/InputView/BasicInputView.swift))
- Attributed string / markdown support
## Preview
Basic Example
| Light | Dark |
:---:|:---:|
| 
Advanced Example
| Contact, QuickReply, Text, Carousel | Map, Image | ContextMenu |
:---:|:---:|:---:
| 
| 
## Installation
```
https://github.com/EnesKaraosman/SwiftyChat.git
```
Add via Swift Package Manager in Xcode.
## Message Kinds
```swift
public enum ChatMessageKind: CustomStringConvertible {
case text(String) // Auto-scales for emoji-only messages
case image(ImageLoadingKind) // Local (UIImage/NSImage) or remote (URL)
case imageText(ImageLoadingKind, String) // Image with caption
case location(LocationItem) // MapKit pin
case contact(ContactItem) // Shareable contact card
case quickReply([QuickReplyItem]) // Tappable options, auto-disables after selection
case carousel([CarouselItem]) // Scrollable cards with buttons
case video(VideoItem) // Video with PiP support
case loading // Animated loading indicator
case custom(Any) // Your own message type
}
```
## Usage
### Minimal setup
```swift
import SwiftyChat
@State private var messages: [YourMessage] = []
@State private var scrollToBottom = false
ChatView(
messages: $messages,
scrollToBottom: $scrollToBottom
) {
BasicInputView(
message: $message,
placeholder: "Type something",
onCommit: { messageKind in
messages.append(/* your message */)
}
)
}
.environment(\.chatStyle, ChatMessageCellStyle())
```
`YourMessage` must conform to the `ChatMessage` protocol (which has an associated `ChatUser` type). See the [Example app](../master/Example) for a complete implementation.
### Input view
A built-in `BasicInputView` is included. Use it as-is, or build your own — `ChatView` accepts any view via its `inputView` closure.
### Styling
Every visual aspect is customizable through `ChatMessageCellStyle`:
```swift
public struct ChatMessageCellStyle {
let incomingTextStyle: TextCellStyle
let outgoingTextStyle: TextCellStyle
let incomingCellEdgeInsets: EdgeInsets
let outgoingCellEdgeInsets: EdgeInsets
let contactCellStyle: ContactCellStyle
let imageCellStyle: ImageCellStyle
let imageTextCellStyle: ImageTextCellStyle
let quickReplyCellStyle: QuickReplyCellStyle
let carouselCellStyle: CarouselCellStyle
let locationCellStyle: LocationCellStyle
let videoPlaceholderCellStyle: VideoPlaceholderCellStyle
let incomingAvatarStyle: AvatarStyle
let outgoingAvatarStyle: AvatarStyle
}
```
Inject via `.environment(\.chatStyle, yourStyle)`. All properties have sensible defaults.
See [Styles.md](../master/Styles.md) for the full style reference and [CustomMessage.md](CustomMessage.md) for custom cell types.
## Pre-built Themes
| Theme | Description |
|-------|-------------|
| **Modern** | Clean blue, minimal design |
| **Classic** | Traditional green messaging |
| **Dark Neon** | Cyberpunk with neon pink accents |
| **Minimal** | Subtle gray tones |
| **Ocean** | Calming teal, sea-inspired |
| **Sunset** | Warm orange gradients |
| **Nature** | Fresh green, eco-friendly |
| **Lavender** | Soft purple, relaxing |
See `ThemeShowcaseView` in the Example app for live demos.
## Contributing
PRs are welcome for features, bug fixes, or documentation improvements.
## Inspiration
- [MessageKit](https://github.com/MessageKit/MessageKit) (UIKit)
- [Nio](https://github.com/niochat/nio) (SwiftUI)