Refactor keyboard toolbar

RELEASE_NOTES.md

@@ -12,15 +12,14 @@ This release removes all deprecated code and cleans up the library somewhat.
 
 ### ✨ Features
 
-* The new `richTextKeyboardToolbarConfig` view extension can be used to configure a `RichTextKeyboardToolbar`.
-* The new `richTextKeyboardToolbarStyle` view extension can be used to style a `RichTextKeyboardToolbar`.
+* The new `richTextKeyboardToolbarConfig` view extension can be used to configure the `RichTextKeyboardToolbar`.
+* The new `richTextKeyboardToolbarStyle` view extension can be used to style the `RichTextKeyboardToolbar`.
 
 ### 💥 Breaking Changes
 
 * All previously deprecated code has been deleted. 
 
-* `RichTextKeyboardToolbar`'s `style` and `config` is now applied with view extensions instead of with the initializer.
-* `RichTextKeyboardToolbar`'s `leadingActions` and `trailingActions` are now specified with the configuration instead of the initializer.
+* `RichTextKeyboardToolbar` is now configured with view extensions instead of with the initializer.
 
 
 

Sources/RichTextKit/Actions/RichTextAction.swift

@@ -89,13 +89,13 @@ public extension RichTextAction {
     /// The action's standard icon.
     var icon: Image {
         switch self {
-        case .copy: .richTextActionCopy
-        case .dismissKeyboard: .richTextActionDismissKeyboard
+        case .copy: .richTextCopy
+        case .dismissKeyboard: .richTextDismissKeyboard
         case .pasteImage: .richTextDocuments
         case .pasteImages: .richTextDocuments
         case .pasteText: .richTextDocuments
-        case .print: .richTextActionExport
-        case .redoLatestChange: .richTextActionRedo
+        case .print: .richTextPrint
+        case .redoLatestChange: .richTextRedo
         case .selectRange: .richTextSelection
         case .setAlignment(let val): val.icon
         case .setAttributedString: .richTextDocument
@@ -108,7 +108,7 @@ public extension RichTextAction {
         case .stepLineSpacing: .richTextLineSpacing
         case .stepSuperscript(let val): .richTextStepSuperscript(val)
         case .toggleStyle(let val): val.icon
-        case .undoLatestChange: .richTextActionUndo
+        case .undoLatestChange: .richTextUndo
         }
     }
 

Sources/RichTextKit/Data/RichTextDataFormat+Menu.swift

@@ -71,7 +71,7 @@ struct RichTextData_FormatMenu_Previews: PreviewProvider {
         VStack {
             RichTextDataFormat.Menu(
                 title: "Export...",
-                icon: .richTextActionExport,
+                icon: .richTextExport,
                 formatAction: { _ in },
                 pdfAction: {}
             )

Sources/RichTextKit/Export/RichTextExportMenu.swift

@@ -20,7 +20,7 @@ public struct RichTextExportMenu: View {
 
     public init(
         title: String = RTKL10n.menuExportAs.text,
-        icon: Image = .richTextActionExport,
+        icon: Image = .richTextExport,
         formats: [RichTextDataFormat] = RichTextDataFormat.libraryFormats,
         formatAction: @escaping (RichTextDataFormat) -> Void,
         pdfAction: (() -> Void)? = nil

Sources/RichTextKit/Images/Image+RichText.swift

@@ -10,14 +10,14 @@ import SwiftUI
 
 public extension Image {
 
-    static let richTextActionCopy = symbol("doc.on.clipboard")
-    static let richTextActionDismissKeyboard = symbol("keyboard.chevron.compact.down")
-    static let richTextActionEdit = symbol("square.and.pencil")
-    static let richTextActionExport = symbol("square.and.arrow.up.on.square")
-    static let richTextActionPrint = symbol("printer")
-    static let richTextActionRedo = symbol("arrow.uturn.forward")
-    static let richTextActionShare = symbol("square.and.arrow.up")
-    static let richTextActionUndo = symbol("arrow.uturn.backward")
+    static let richTextCopy = symbol("doc.on.clipboard")
+    static let richTextDismissKeyboard = symbol("keyboard.chevron.compact.down")
+    static let richTextEdit = symbol("square.and.pencil")
+    static let richTextExport = symbol("square.and.arrow.up.on.square")
+    static let richTextPrint = symbol("printer")
+    static let richTextRedo = symbol("arrow.uturn.forward")
+    static let richTextShare = symbol("square.and.arrow.up")
+    static let richTextUndo = symbol("arrow.uturn.backward")
 
     static let richTextAlignmentCenter = symbol("text.aligncenter")
     static let richTextAlignmentJustified = symbol("text.justify")

Sources/RichTextKit/Keyboard/RichTextKeyboardToolbar+Config.swift

@@ -0,0 +1,73 @@
+//
+//  RichTextKeyboardToolbar+Config.swift
+//  RichTextKit
+//
+//  Created by Ryan Jarvis on 2024-02-24.
+//
+
+#if iOS || macOS || os(visionOS)
+import SwiftUI
+
+/// This struct can configure a ``RichTextKeyboardToolbar``.
+public struct RichTextKeyboardToolbarConfig {
+
+    /// Create a custom keyboard toolbar configuration.
+    ///
+    /// - Parameters:
+    ///   - alwaysDisplayToolbar: Whether or not to always show the toolbar, by default `false`.
+    ///   - leadingActions: The leading actions, by default `.undo` and `.redo`.
+    ///   - trailingActions: The trailing actions, by default `.dismissKeyboard`.
+    public init(
+        alwaysDisplayToolbar: Bool = false,
+        leadingActions: [RichTextAction] = [.undo, .redo],
+        trailingActions: [RichTextAction] = [.dismissKeyboard]
+    ) {
+        self.alwaysDisplayToolbar = alwaysDisplayToolbar
+        self.leadingActions = leadingActions
+        self.trailingActions = trailingActions
+    }
+
+    /// Whether or not to always show the toolbar.
+    public var alwaysDisplayToolbar: Bool
+
+    /// The leading toolbar actions.
+    public var leadingActions: [RichTextAction]
+
+    /// The trailing toolbar actions.
+    public var trailingActions: [RichTextAction]
+}
+
+public extension RichTextKeyboardToolbarConfig {
+
+    /// A standard rich text keyboard toolbar configuration.
+    ///
+    /// You can override this to change the global default.
+    static var standard = RichTextKeyboardToolbarConfig()
+}
+
+public extension View {
+
+    /// Apply a ``RichTextKeyboardToolbar`` configuration.
+    func richTextKeyboardToolbarConfig(
+        _ config: RichTextKeyboardToolbarConfig
+    ) -> some View {
+        self.environment(\.richTextKeyboardToolbarConfig, config)
+    }
+}
+
+extension RichTextKeyboardToolbarConfig {
+
+    struct Key: EnvironmentKey {
+
+        public static var defaultValue: RichTextKeyboardToolbarConfig = .standard
+    }
+}
+
+public extension EnvironmentValues {
+
+    var richTextKeyboardToolbarConfig: RichTextKeyboardToolbarConfig {
+        get { self [RichTextKeyboardToolbarConfig.Key.self] }
+        set { self [RichTextKeyboardToolbarConfig.Key.self] = newValue }
+    }
+}
+#endif