Add rich text view configuration type

Author: danielsaidi

Demo/iOS/EditorScreen.swift

@@ -40,7 +40,11 @@ struct EditorScreen: View {
 private extension EditorScreen {
 
     var editor: some View {
-        RichTextEditor(text: $text, context: context) {
+        RichTextEditor(
+            text: $text,
+            context: context,
+            config: .init(isScrollingEnabled: false)
+        ) {
             $0.textContentInset = CGSize(width: 10, height: 20)
         }
         .background(Material.regular)

Demo/macOS/EditorScreen.swift

@@ -45,7 +45,11 @@ struct EditorScreen: View {
 private extension EditorScreen {
 
     var editor: some View {
-        RichTextEditor(text: $text, context: context) {
+        RichTextEditor(
+            text: $text,
+            context: context,
+            config: .init(isScrollingEnabled: false)
+        ) {
             $0.textContentInset = CGSize(width: 10, height: 20)
         }
         .frame(minWidth: 400)

RELEASE_NOTES.md

@@ -11,9 +11,13 @@ Until then, minor updates may remove deprecated features and introduce breaking
 
 Thanks to [@ropellanda][ropellanda], RichTextKit now supports Vision OS.
 
+Thanks to [@screenworker][screenworker], RichTextEditor now has a `config` that can disable scrolling.
+
 ### ✨ Features
 
 * `Image` has a new rich text-specific image builders.
+* `RichTextEditor` has a new `config` value parameter that can disable scrolling.
+* `RichTextView` has a new `configuration` property that can disable scrolling.
 
 ### 🗑️ Deprecations 
 
@@ -481,3 +485,4 @@ RichTextKit adds extensive support for a bunch of rich text features:
 [Mcrich23]: https://github.com/Mcrich23
 [msrutek-paylocity]: https://github.com/msrutek-paylocity
 [ropellanda]: https://github.com/ropellanda
+[screenworker]: https://github.com/screenworker

Sources/RichTextKit/Context/RichTextContext.swift

@@ -185,14 +185,7 @@ public extension RichTextContext {
         highlightedRange = range
     }
 
-    /**
-     Paste an image into the text view, at a certain index.
-
-     - Parameters:
-       - image: The image to paste.
-       - index: The index to paste at, by default the `selectedRange` location.
-       - moveCursorToPastedContent: Whether or not to move the cursor to the end of the pasted content, by default `false`.
-     */
+    /// Paste an image into the editor, at a certain index.
     func pasteImage(
         _ image: ImageRepresentable,
         at index: Int? = nil,
@@ -202,15 +195,8 @@ public extension RichTextContext {
         shouldPasteImage = (image, index, moveCursorToPastedContent)
     }
 
-    /**
-     Paste images into the text view, at a certain index.
-
-     - Parameters:
-       - images: The images to paste.
-       - index: The index to paste at, by default the `selectedRange` location.
-       - moveCursorToPastedContent: Whether or not to move the cursor to the end of the pasted content, by default `false`.
-     */
-    func pasteImage(
+    /// Paste images into the editor, at a certain index.
+    func pasteImages(
         _ images: [ImageRepresentable],
         at index: Int? = nil,
         moveCursorToPastedContent: Bool = false
@@ -219,14 +205,7 @@ public extension RichTextContext {
         shouldPasteImages = (images, index, moveCursorToPastedContent)
     }
 
-    /**
-     Paste text into the text view, at a certain index.
-
-     - Parameters:
-       - text: The text to paste.
-       - index: The index to paste at, by default the `selectedRange` location.
-       - moveCursorToPastedContent: Whether or not to move the cursor to the end of the pasted content, by default `false`.
-     */
+    /// Paste text into the editor, at a certain index.
     func pasteText(
         _ text: String,
         at index: Int? = nil,

Sources/RichTextKit/RichTextEditor.swift

@@ -18,9 +18,8 @@ import SwiftUI
 
  You can use the provided context to trigger and observe any
  changes to the text editor. Note that changing the value of
- the `text` binding will not (yet) update this editor. Until
- it is fixed, use `setAttributedString(to:)` to set the rich
- text or plain string to another value.
+ the `text` binding will not yet update the editor. Until it
+ is fixed, use `setAttributedString(to:)`.
 
  Since the view wraps a native `UIKit` or `AppKit` text view,
  you can't apply `.toolbar` modifiers to it, like you can do
@@ -51,33 +50,33 @@ public struct RichTextEditor: ViewRepresentable {
      - Parameters:
        - text: The rich text to edit.
        - context: The rich text context to use.
+       - config: The rich text configuration to use, by deafult `standard`.
        - format: The rich text data format, by default ``RichTextDataFormat/archivedData``.
      */
     public init(
         text: Binding<NSAttributedString>,
         context: RichTextContext,
+        config: RichTextView.Configuration = .standard,
         format: RichTextDataFormat = .archivedData,
         viewConfiguration: @escaping ViewConfiguration = { _ in }
     ) {
         self.text = text
-        self._richTextContext = ObservedObject(wrappedValue: context)
+        self.config = config
+        self._context = ObservedObject(wrappedValue: context)
         self.format = format
         self.viewConfiguration = viewConfiguration
     }
 
     public typealias ViewConfiguration = (RichTextViewComponent) -> Void
-
-
-    private var format: RichTextDataFormat
-
-    private var text: Binding<NSAttributedString>
-
+    
     @ObservedObject
-    private var richTextContext: RichTextContext
-
+    private var context: RichTextContext
+    
+    private var text: Binding<NSAttributedString>
+    private let config: RichTextView.Configuration
+    private var format: RichTextDataFormat
     private var viewConfiguration: ViewConfiguration
 
-
     #if iOS || os(tvOS) || os(visionOS)
     public let textView = RichTextView()
     #endif
@@ -95,24 +94,26 @@ public struct RichTextEditor: ViewRepresentable {
         RichTextCoordinator(
             text: text,
             textView: textView,
-            richTextContext: richTextContext
+            richTextContext: context
         )
     }
 
 
     #if iOS || os(tvOS) || os(visionOS)
     public func makeUIView(context: Context) -> some UIView {
         textView.setup(with: text.wrappedValue, format: format)
+        textView.configuration = config
         viewConfiguration(textView)
         return textView
     }
 
     public func updateUIView(_ view: UIViewType, context: Context) {}
-    #endif
-
-    #if macOS
+    
+    #else
+    
     public func makeNSView(context: Context) -> some NSView {
         textView.setup(with: text.wrappedValue, format: format)
+        textView.configuration = config
         viewConfiguration(textView)
         return scrollView
     }

Sources/RichTextKit/RichTextView+Config.swift

@@ -0,0 +1,41 @@
+//
+//  RichTextView+Config.swift
+//  RichTextKit
+//
+//  Created by Daniel Saidi on 2024-01-16.
+//  Copyright © 2024 Daniel Saidi. All rights reserved.
+//
+
+#if iOS || macOS || os(tvOS) || os(visionOS)
+import SwiftUI
+
+public extension RichTextView {
+    
+    /**
+     This type can be used to configure a ``RichTextEditor``.
+     */
+    struct Configuration {
+        
+        /**
+         Create a custom configuration.
+         
+         - Parameters:
+           - isScrollingEnabled: Whether or not the editor should scroll, by default `true`.
+         */
+        public init(
+            isScrollingEnabled: Bool = true
+        ) {
+            self.isScrollingEnabled = isScrollingEnabled
+        }
+        
+        /// Whether or not the editor should scroll.
+        public var isScrollingEnabled: Bool
+    }
+}
+
+public extension RichTextView.Configuration {
+    
+    /// Get a standard rich text editor configuration.
+    static var standard: Self { .init() }
+}
+#endif

Sources/RichTextKit/RichTextView_AppKit.swift

@@ -26,6 +26,9 @@ import AppKit
 open class RichTextView: NSTextView, RichTextViewComponent {
 
     // MARK: - Properties
+    
+    /// The configuration to use by the rich text view.
+    public var configuration: Configuration = .standard
 
     /// The style to use when highlighting text in the view.
     public var highlightingStyle: RichTextHighlightingStyle = .standard
@@ -74,6 +77,21 @@ open class RichTextView: NSTextView, RichTextViewComponent {
 
         return super.performDragOperation(draggingInfo)
     }
+    
+    open override func scrollWheel(with event: NSEvent) {
+        
+        if configuration.isScrollingEnabled {
+            return super.scrollWheel(with: event)
+        }
+
+        // 1st nextResponder is NSClipView
+        // 2nd nextResponder is NSScrollView
+        // 3rd nextResponder is NSResponder SwiftUIPlatformViewHost
+        self.nextResponder?
+            .nextResponder?
+            .nextResponder?
+            .scrollWheel(with: event)
+    }
 
 
     // MARK: - Setup

Sources/RichTextKit/RichTextView_UIKit.swift

@@ -47,7 +47,14 @@ open class RichTextView: UITextView, RichTextViewComponent {
 
 
     // MARK: - Properties
-
+    
+    /// The configuration to use by the rich text view.
+    public var configuration: Configuration = .standard {
+        didSet {
+            isScrollEnabled = configuration.isScrollingEnabled
+        }
+    }
+    
     /// The style to use when highlighting text in the view.
     public var highlightingStyle: RichTextHighlightingStyle = .standard