https://github.com/canopas/rich-editor-swiftui
Powerful WYSIWYG Rich editor for SwiftUI.
https://github.com/canopas/rich-editor-swiftui
appkit editor ios ios-swift macos rich-text-editor richtext string swift swiftui swiftui-example text-editor text-formating text-formatter tvos uikit watchos
Last synced: about 1 year ago
JSON representation
Powerful WYSIWYG Rich editor for SwiftUI.
- Host: GitHub
- URL: https://github.com/canopas/rich-editor-swiftui
- Owner: canopas
- License: mit
- Created: 2023-10-11T09:01:14.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-21T11:31:36.000Z (over 1 year ago)
- Last Synced: 2025-04-09T22:17:58.156Z (about 1 year ago)
- Topics: appkit, editor, ios, ios-swift, macos, rich-text-editor, richtext, string, swift, swiftui, swiftui-example, text-editor, text-formating, text-formatter, tvos, uikit, watchos
- Language: Swift
- Homepage: https://canopas.github.io/rich-editor-swiftui/
- Size: 9.62 MB
- Stars: 204
- Watchers: 3
- Forks: 13
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# RichEditorSwiftUI
[](https://img.shields.io/badge/Swift-5.9-Orange?style=flat-square)
[](https://img.shields.io/badge/Platforms-macOS_iOS_tvOS_watchOS_vision_OS_-Green?style=flat-square)
[](https://img.shields.io/cocoapods/v/RichEditorSwiftUI.svg)
[](https://img.shields.io/badge/Swift_Package_Manager-compatible-orange?style=flat-square)
## Features
The editor offers the following options:
- [x] **Bold**
- [x] *Italic*
- [x] Underline
- [x] ~~Strikethrough~~
- [x] Different Heading
- [x] Text Alignment
- [x] Font size
- [x] Font color
- [x] Font family
- [x] Background color
- [x] Export with .txt, .rtf, .pdf, .json
- [ ] Link
- [ ] Image Attachment
- [ ] Undo/Redo
## What’s Coming Next for RichEditorSwiftUI?🚀
We’re thrilled about the future of **RichEditorSwiftUI!** 🎉 Check out the exciting features currently in development:
- **Link Support:** Easily add hyperlinks to your rich text content.
- **Image Drop:** Drag and drop images directly into your editor for seamless integration.
- **Undo & Redo:** Effortlessly step forward or backward in your edits for greater control.
Thank you for your support and feedback—it fuels our journey. Stay tuned for these enhancements and more! 🙌
## Screenshots
Editor light
Editor dark
Toolbar dark
Toolbar light
mac Editor light
mac Editor dark
## mac Editor video
## iPhone Editor video
## Installation
### Swift Package Manager
The [Swift Package Manager](https://swift.org/package-manager/) is a tool for automating the distribution of Swift code and is integrated into the `swift` compiler.
Once you have your Swift package set up, adding RichEditorSwiftUI as a dependency is as easy as adding it to the `dependencies` value of your `Package.swift`.
```swift
dependencies: [
.package(url: "https://github.com/canopas/rich-editor-swiftui.git", .upToNextMajor(from: "1.1.0"))
]
```
### CocoaPods
[CocoaPods][] is a dependency manager for Cocoa projects. For usage and installation instructions, visit their website. To integrate RichEditorSwiftUI into your Xcode project using CocoaPods, specify it in your Podfile:
target 'YourAppName' do
pod 'RichEditorSwiftUI', '~> 1.1.1'
end
[CocoaPods]: https://cocoapods.org
## How to add in your project
Add the dependency
```
import RichEditorSwiftUI
```
## How to use?
```
struct EditorView: View {
@ObservedObject var state: RichEditorState = .init(input: "Hello World")
var body: some View {
VStack {
#if os(macOS)
RichTextFormat.Toolbar(context: state)
#endif
RichTextEditor(
context: _state,
viewConfiguration: { _ in
}
)
.cornerRadius(10)
#if os(iOS)
RichTextKeyboardToolbar(
context: state,
leadingButtons: { $0 },
trailingButtons: { $0 },
formatSheet: { $0 }
)
#endif
}
.inspector(isPresented: $isInspectorPresented) {
RichTextFormat.Sidebar(context: state)
#if os(macOS)
.inspectorColumnWidth(min: 200, ideal: 200, max: 320)
#endif
}
}
}
```
# Demo
[Sample](https://github.com/canopas/rich-editor-swiftui/tree/main/RichEditorDemo) app demonstrates how simple the usage of the library actually is.
## Tech stack
RichEditorSwiftUI utilizes the latest Apple technologies and adheres to industry best practices. Below is the current tech stack used in the development process:
- MVVM Architecture
- SwiftUI
- Swift
- Xcode
## Contribution
The Canopas team enthusiastically welcomes contributions and project participation! There are a bunch of things you can do if you want to contribute! The [Contributor Guide](CONTRIBUTING.md) has all the information you need for everything from reporting bugs to contributing entire new features. Please don't hesitate to jump in if you'd like to, or even ask us questions if something isn't clear.
# Bugs and Feedback
For bugs, questions, and discussions please use the [Github Issues](https://github.com/canopas/rich-editor-swiftui/issues).
## Credits
RichEditor for SwiftUI is owned and maintained by the [Canopas team](https://canopas.com/). For project updates and releases, you can follow them on X at [@canopassoftware](https://x.com/canopassoftware).
A similar library is also available for Android in Jetpack Compose [here](https://github.com/canopas/rich-editor-compose).
RichTextKit: https://github.com/danielsaidi/RichTextKit
# Licence
```
Copyright 2023 Canopas Software LLP
Licensed under the Apache License, Version 2.0 (the "License");
You won't be using this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```