From a7eab102451ba7d7ab0d7379561ea3d495bb4fe3 Mon Sep 17 00:00:00 2001 From: Divyesh Canopas <83937721+cp-divyesh-v@users.noreply.github.com> Date: Wed, 1 Jan 2025 14:33:30 +0530 Subject: [PATCH 1/2] Updated read me with what's coming next (#76) * updated read me and index * updated list format * updated upcoming feature list * updated sample screen shots path --- README.md | 14 ++++++- docs/index.md | 113 +++++++++++++++++++++++++++++++++++++++++++++----- 2 files changed, 116 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 710b04f..d38ac09 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,19 @@ The editor offers the following options: - [x] Font family - [x] Background color - [x] Export with .txt, .rtf, .pdf, .json -- [x] Link +- [ ] 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 diff --git a/docs/index.md b/docs/index.md index c04d869..6d7355d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,8 +1,6 @@ # RichEditorSwiftUI -iOS WYSIWYG Rich editor for SwiftUI. - - +![RichEditorSwiftUI (1)](https://github.com/canopas/rich-editor-swiftui/assets/73588408/8c3013ae-8a27-4ebc-a511-51e726825c4b) ## Features @@ -12,6 +10,65 @@ The editor offers the following options: - [x] *Italic* - [x] Underline - [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 + +## Screenshots + + + + + + + + + + +
Editor lightEditor dark
+ + + + + + + + + + +
Toolbar darkToolbar light
+ + + + + + + + +
mac Editor light
+ + + + + + + + +
mac Editor dark
+ +## mac Editor video + +
+
+ +## iPhone Editor video +
+
## Installation @@ -23,7 +80,7 @@ Once you have your Swift package set up, adding RichEditorSwiftUI as a dependenc ```swift dependencies: [ - .package(url: "https://github.com/canopas/rich-editor-swiftui.git", .upToNextMajor(from: "1.0.0")) + .package(url: "https://github.com/canopas/rich-editor-swiftui.git", .upToNextMajor(from: "1.1.0")) ] ``` @@ -32,7 +89,7 @@ dependencies: [ [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.0.0' + pod 'RichEditorSwiftUI', '~> 1.1.0' end [CocoaPods]: https://cocoapods.org @@ -42,21 +99,57 @@ dependencies: [ Add the dependency ``` - import XYZRichEditor + import RichEditorSwiftUI ``` -## How to use ? +## How to use? ``` struct EditorView: View { @ObservedObject var state: RichEditorState = .init(input: "Hello World") - + var body: some View { - RichEditor(state: _state) - .padding(10) + 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 + } } } ``` + +## 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 + # Demo [Sample](https://github.com/canopas/rich-editor-swiftui/tree/main/RichEditorDemo) app demonstrates how simple the usage of the library actually is. From be7c3e2020a5c472ac88f0b0527de858d8682464 Mon Sep 17 00:00:00 2001 From: Divyesh Canopas Date: Wed, 1 Jan 2025 16:47:05 +0530 Subject: [PATCH 2/2] bump version 1.1.1 --- .github/workflows/release.yaml | 2 +- README.md | 2 +- RichEditorSwiftUI.podspec | 6 +++--- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 669685e..33414dc 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -4,7 +4,7 @@ name: Release on: push: branches: - - master + - main jobs: build: diff --git a/README.md b/README.md index d38ac09..9bf4f9f 100644 --- a/README.md +++ b/README.md @@ -110,7 +110,7 @@ dependencies: [ [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.0' + pod 'RichEditorSwiftUI', '~> 1.1.1' end [CocoaPods]: https://cocoapods.org diff --git a/RichEditorSwiftUI.podspec b/RichEditorSwiftUI.podspec index aa1ca46..0c50a63 100644 --- a/RichEditorSwiftUI.podspec +++ b/RichEditorSwiftUI.podspec @@ -1,7 +1,7 @@ Pod::Spec.new do |s| - s.name = 'RichEditorSwiftUI' - s.version = '1.0.0' - s.summary = 'Powerful WYSIWYG Rich editor for SwiftUI.' + s.name = "RichEditorSwiftUI" + s.version = "1.1.1" + s.summary = "Rich text editing, SwiftUI rich text editor library." s.description = <<-DESC Wrapper around UITextView to support Rich text editing in SwiftUI.