Adjust the remaining documentation

danielsaidi · Feb 16, 2024 · 931bfff · 931bfff
1 parent fb7d7ec
commit 931bfff
Show file tree

Hide file tree

Showing 47 changed files with 160 additions and 194 deletions.
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -26,6 +26,7 @@ By deprecating these functions, we can simplify the library in 1.0, and focus mo
 * `RichTextFormatToolbar` has new configuration and style types.
 * `RichTextFormatSidebar` has new configuration and style types.
 * `RichTextKeyboardToolbar` has a new config to always be shown.
+* `RichTextStyle.Button` now supports using custom button styles.
 * `RichTextView` has a new theme that lets you define its style.
 * `RichTextViewComponent` has a new `hasRichTextStyle` function.
 * `RichTextViewComponent` has a new `toggleRichTextStyle` function.

diff --git a/Sources/RichTextKit/Format/RichTextFormatToolbar+Configuration.swift b/Sources/RichTextKit/Format/RichTextFormatToolbar+Configuration.swift
@@ -6,6 +6,7 @@
 //  Copyright © 2024 Daniel Saidi. All rights reserved.
 //
 
+#if iOS || macOS || os(visionOS)
 import SwiftUI
 
 public extension RichTextFormatToolbar {
@@ -53,3 +54,4 @@ public extension RichTextFormatToolbar.Configuration {
     /// The standard rich text format toolbar configuration.
     static var standard = Self.init()
 }
+#endif
diff --git a/Sources/RichTextKit/Format/RichTextFormatToolbar+Style.swift b/Sources/RichTextKit/Format/RichTextFormatToolbar+Style.swift
@@ -6,6 +6,7 @@
 //  Copyright © 2024 Daniel Saidi. All rights reserved.
 //
 
+#if iOS || macOS || os(visionOS)
 import SwiftUI
 
 public extension RichTextFormatToolbar {
@@ -56,3 +57,4 @@ public extension EnvironmentValues {
         set { self [RichTextFormatToolbar.StyleKey.self] = newValue }
     }
 }
+#endif
diff --git a/Sources/RichTextKit/Format/RichTextFormatToolbar.swift b/Sources/RichTextKit/Format/RichTextFormatToolbar.swift
@@ -6,6 +6,7 @@
 //  Copyright © 2022-2024 Daniel Saidi. All rights reserved.
 //
 
+#if iOS || macOS || os(visionOS)
 import SwiftUI
 
 /**
@@ -208,3 +209,4 @@ struct RichTextFormatToolbar_Previews: PreviewProvider {
         Preview()
     }
 }
+#endif
diff --git a/Sources/RichTextKit/Format/RichTextFormatToolbarBase.swift b/Sources/RichTextKit/Format/RichTextFormatToolbarBase.swift
@@ -6,6 +6,7 @@
 //  Copyright © 2024 Daniel Saidi. All rights reserved.
 //
 
+#if iOS || macOS || os(visionOS)
 import SwiftUI
 
 /// This internal protocol is used to share code between the
@@ -167,3 +168,4 @@ extension RichTextFormatToolbarBase {
         }
     }
 }
+#endif
diff --git a/Sources/RichTextKit/Images/Image+RichText.swift b/Sources/RichTextKit/Images/Image+RichText.swift
@@ -3,7 +3,7 @@
 //  RichTextKit
 //
 //  Created by Daniel Saidi on 2022-05-28.
-//  Copyright © 2022-2023 Daniel Saidi. All rights reserved.
+//  Copyright © 2022-2024 Daniel Saidi. All rights reserved.
 //
 
 import SwiftUI

diff --git a/Sources/RichTextKit/Images/ImageRepresentable.swift b/Sources/RichTextKit/Images/ImageRepresentable.swift
@@ -3,16 +3,13 @@
 //  RichTextKit
 //
 //  Created by Daniel Saidi on 2022-05-28.
-//  Copyright © 2022-2023 Daniel Saidi. All rights reserved.
+//  Copyright © 2022-2024 Daniel Saidi. All rights reserved.
 //
 
 #if canImport(AppKit) && !targetEnvironment(macCatalyst)
 import AppKit
 
-/**
- This typealias bridges platform-specific images to simplify
- multi-platform support.
- */
+/// This typealias bridges platform-specific image types.
 public typealias ImageRepresentable = NSImage
 
 public extension ImageRepresentable {
@@ -34,9 +31,6 @@ public extension ImageRepresentable {
 #if canImport(UIKit)
 import UIKit
 
-/**
- This typealias bridges platform-specific fonts, to simplify
- multi-platform support.
- */
+/// This typealias bridges platform-specific image types.
 public typealias ImageRepresentable = UIImage
 #endif
diff --git a/Sources/RichTextKit/Images/RichTextImageAttachment.swift b/Sources/RichTextKit/Images/RichTextImageAttachment.swift
@@ -3,7 +3,7 @@
 //  RichTextKit
 //
 //  Created by Daniel Saidi on 2022-06-05.
-//  Copyright © 2022-2023 Daniel Saidi. All rights reserved.
+//  Copyright © 2022-2024 Daniel Saidi. All rights reserved.
 //
 
 #if iOS || os(tvOS) || os(visionOS)
@@ -27,37 +27,32 @@ import UniformTypeIdentifiers
  overrides `image` on iOS and `attachmentCell` on macOS.
 
  This is probably the wrong way to solve this problem, but I
- haven't been able to find another way. If we set the `image`
- property of a plain `NSTextAttachment`, it works to add and
- load the attachment on the same platform, but trying to use
- the attachment on other platforms will fail.
+ haven't been able to find another way. If we set `image` on
+ a plain `NSTextAttachment`, it can add and load attachments
+ on the same platform, but fails on other platforms.
 
  Another problem with `NSTextAttachment`, is that it results
  in large files, since it by default doesn't specify uniform
  type identifier or compression, which makes it handle image
- attachments as (potentially) huge png data. This attachment
- allows you to easily use jpg with a custom compression rate
- instead, which results in much smaller files.
+ attachments as huge png data. This attachment allows you to
+ easily use jpg with a custom compression rate instead.
 
  # WARNING
 
  If we use ``RichTextDataFormat/archivedData`` to persist an
- image attachment in a string, we'll use an `NSKeyedArchiver`
- to archive the data and an `NSKeyedUnarchiver` to unarchive
- it. This requires that the attachment types that are stored
- into the archive data exist when the data is unarchived. If
- any type is missing, this unarchiving will fail. This means
- that if you later decide to use another library to handle a
- file that contains an ``RichTextImageAttachment``, you must
- setup a custom class in the unarchiver, for instance:
+ image attachment, we'll use `NSKeyedArchiver` to archive it
+ and `NSKeyedUnarchiver` to unarchive it. This requires that
+ the types within the archive data still exist when the data
+ is unarchived. If any type is missing, you must register an
+ unarchiver class replacement like this:
 
  ```
  let unarchiver = NSKeyedUnarchiver()
  unarchiver.setClass(MyNewAttachment.self, forClassName: "...")`
  ```
 
  You'll see the name of the missing class in the unarchiving
- error, so just pop that name in as the class name.
+ error, so just use that name as the class name.
  */
 open class RichTextImageAttachment: NSTextAttachment {
 

diff --git a/Sources/RichTextKit/Images/RichTextImageAttachmentManager.swift b/Sources/RichTextKit/Images/RichTextImageAttachmentManager.swift
@@ -3,7 +3,7 @@
 //  RichTextKit
 //
 //  Created by Daniel Saidi on 2022-06-05.
-//  Copyright © 2022-2023 Daniel Saidi. All rights reserved.
+//  Copyright © 2022-2024 Daniel Saidi. All rights reserved.
 //
 
 import CoreGraphics
@@ -21,8 +21,8 @@ import AppKit
  This protocol extends ``RichTextReader`` with functionality
  for handling image attachments.
 
- The protocol is implemented by `NSAttributedString` but can
- be implemented by any `RichTextReader`.
+ The protocol is implemented by `NSAttributedString` and can
+ be implemented by any `RichTextReader` as well.
  */
 public protocol RichTextImageAttachmentManager: RichTextReader {}
 

diff --git a/Sources/RichTextKit/Images/RichTextImageAttachmentSize.swift b/Sources/RichTextKit/Images/RichTextImageAttachmentSize.swift
@@ -3,14 +3,13 @@
 //  RichTextKit
 //
 //  Created by Daniel Saidi on 2022-06-02.
-//  Copyright © 2022-2023 Daniel Saidi. All rights reserved.
+//  Copyright © 2022-2024 Daniel Saidi. All rights reserved.
 //
 
 import CoreGraphics
 
 /**
- This enum defines various ways to size images when they are
- used in a rich text.
+ This enum defines various ways to size images in rich text.
  */
 public enum RichTextImageAttachmentSize {
 
@@ -23,19 +22,15 @@ public enum RichTextImageAttachmentSize {
 
 public extension RichTextImageAttachmentSize {
 
-    /**
-     The image's resulting height in a certain frame.
-     */
+    /// The image's resulting height in a certain frame.
     func height(in frame: CGRect) -> CGFloat {
         switch self {
         case .frame: frame.height
         case .points(let points): points
         }
     }
 
-    /**
-     The image's resulting width in a certain frame.
-     */
+    /// The image's resulting width in a certain frame.
     func width(in frame: CGRect) -> CGFloat {
         switch self {
         case .frame: frame.width

diff --git a/Sources/RichTextKit/Images/RichTextImageConfiguration.swift b/Sources/RichTextKit/Images/RichTextImageConfiguration.swift
@@ -3,7 +3,7 @@
 //  RichTextKit
 //
 //  Created by Daniel Saidi on 2022-06-02.
-//  Copyright © 2022-2023 Daniel Saidi. All rights reserved.
+//  Copyright © 2022-2024 Daniel Saidi. All rights reserved.
 //
 
 import Foundation
@@ -14,7 +14,7 @@ import Foundation
 
  The paste and drop configurations should be `.disabled` for
  rich text formats that don't support inserting images, like
- .txt and .rtf (where images must be added to a sub-folder).
+ `.txt` and `.rtf`.
  */
 public struct RichTextImageConfiguration {
 
@@ -29,7 +29,10 @@ public struct RichTextImageConfiguration {
     public init(
         pasteConfiguration: RichTextImageInsertConfiguration,
         dropConfiguration: RichTextImageInsertConfiguration,
-        maxImageSize: (width: RichTextImageAttachmentSize, height: RichTextImageAttachmentSize)
+        maxImageSize: (
+            width: RichTextImageAttachmentSize,
+            height: RichTextImageAttachmentSize
+        )
     ) {
         self.pasteConfiguration = pasteConfiguration
         self.dropConfiguration = dropConfiguration
@@ -40,7 +43,10 @@ public struct RichTextImageConfiguration {
     public var dropConfiguration: RichTextImageInsertConfiguration
 
     /// The max size to limit images in the text view to.
-    public var maxImageSize: (width: RichTextImageAttachmentSize, height: RichTextImageAttachmentSize)
+    public var maxImageSize: (
+        width: RichTextImageAttachmentSize,
+        height: RichTextImageAttachmentSize
+    )
 
     /// The image configuration to use when pasting images.
     public var pasteConfiguration: RichTextImageInsertConfiguration

diff --git a/Sources/RichTextKit/Images/RichTextImageInsertConfiguration.swift b/Sources/RichTextKit/Images/RichTextImageInsertConfiguration.swift
@@ -3,7 +3,7 @@
 //  RichTextKit
 //
 //  Created by Daniel Saidi on 2022-06-02.
-//  Copyright © 2022-2023 Daniel Saidi. All rights reserved.
+//  Copyright © 2022-2024 Daniel Saidi. All rights reserved.
 //
 
 import Foundation
@@ -14,8 +14,7 @@ import Foundation
 
  The configuration is needed, since ``RichTextDataFormat/rtf``
  and ``RichTextDataFormat/plainText`` doesn't support images
- and a text view does not know the format of the string that
- it contains.
+ and a text view doesn't know about the data format.
  */
 public enum RichTextImageInsertConfiguration: Equatable {
 

diff --git a/Sources/RichTextKit/Keyboard/RichTextKeyboardToolbar.swift b/Sources/RichTextKit/Keyboard/RichTextKeyboardToolbar.swift
@@ -3,10 +3,10 @@
 //  RichTextKit
 //
 //  Created by Daniel Saidi on 2022-12-14.
-//  Copyright © 2022-2023 Daniel Saidi. All rights reserved.
+//  Copyright © 2022-2024 Daniel Saidi. All rights reserved.
 //
 
-#if iOS || os(visionOS)
+#if iOS || macOS || os(visionOS)
 import SwiftUI
 
 /**
@@ -47,7 +47,7 @@ public struct RichTextKeyboardToolbar<LeadingButtons: View, TrailingButtons: Vie
        - leadingActions: The leading actions, by default `.undo`, `.redo` and `.copy`.
        - trailingActions: The trailing actions, by default `.dismissKeyboard`.
        - leadingButtons: The leading buttons to place after the leading actions.
-       - trailingButtons: The trailing buttons to place after the trailing actions.
+       - trailingButtons: The trailing buttons to place before the trailing actions.
        - richTextFormatSheet: The rich text format sheet to use, given the default ``RichTextFormatToolbar``.
      */
     public init(
@@ -124,10 +124,7 @@ public struct RichTextKeyboardToolbar<LeadingButtons: View, TrailingButtons: Vie
 
     public var body: some View {
         VStack(spacing: 0) {
-            HStack(spacing: style.itemSpacing) {
-                content
-            }
-            .padding(10)
+            content
         }
         .environment(\.sizeCategory, .medium)
         .frame(height: style.toolbarHeight)
@@ -149,21 +146,19 @@ public struct RichTextKeyboardToolbar<LeadingButtons: View, TrailingButtons: Vie
     }
 }
 
-extension UIApplication {
-    func endEditing() {
-        sendAction(#selector(UIResponder.resignFirstResponder), to: nil, from: nil, for: nil)
-    }
-}
-
 private extension View {
 
     @ViewBuilder
     func prefersMediumSize() -> some View {
+        #if macOS
+        self
+        #else
         if #available(iOS 16, *) {
             self.presentationDetents([.medium])
         } else {
             self
         }
+        #endif
     }
 }
 
@@ -176,9 +171,12 @@ private extension RichTextKeyboardToolbar {
 
     @ViewBuilder
     var content: some View {
-        leadingViews
-        Spacer()
-        trailingViews
+        HStack(spacing: style.itemSpacing) {
+            leadingViews
+            Spacer()
+            trailingViews
+        }
+        .padding(10)
     }
 
     var divider: some View {

diff --git a/Sources/RichTextKit/Keyboard/RichTextKeyboardToolbarMenu.swift b/Sources/RichTextKit/Keyboard/RichTextKeyboardToolbarMenu.swift
@@ -3,7 +3,7 @@
 //  RichTextKit
 //
 //  Created by Daniel Saidi on 2022-12-13.
-//  Copyright © 2022 Dnaiel Saidi. All rights reserved.
+//  Copyright © 2022-2024 Dnaiel Saidi. All rights reserved.
 //
 
 #if iOS || os(visionOS)

diff --git a/Sources/RichTextKit/Localization/RTKL10n.swift b/Sources/RichTextKit/Localization/RTKL10n.swift
@@ -3,14 +3,12 @@
 //  KeyboardKit
 //
 //  Created by Daniel Saidi on 2022-12-14.
-//  Copyright © 2022-2023 Daniel Saidi. All rights reserved.
+//  Copyright © 2022-2024 Daniel Saidi. All rights reserved.
 //
 
 import SwiftUI
 
-/**
- This enum defines RichTextKit-specific, localized texts.
- */
+/// This enum defines RichTextKit-specific, localized texts.
 public enum RTKL10n: String, CaseIterable, Identifiable {
 
     case

diff --git a/Sources/RichTextKit/Pasteboard/PasteboardImageReader.swift b/Sources/RichTextKit/Pasteboard/PasteboardImageReader.swift
@@ -3,7 +3,7 @@
 //  RichTextKit
 //
 //  Created by Daniel Saidi on 2022-05-31.
-//  Copyright © 2022-2023 Daniel Saidi. All rights reserved.
+//  Copyright © 2022-2024 Daniel Saidi. All rights reserved.
 //
 
 import Foundation