Deprecate line

Author: danielsaidi

RELEASE_NOTES.md

@@ -8,6 +8,10 @@ Until then, minor updates may remove deprecated features and introduce breaking
 
 ## 1.2
 
+This version makes a first step towards removing library-specific types in favor of native types, to avoid having to add custom types and logic to the library, where native alternatives exist.
+
+This version deprecates the `RichTextAlignment` type and instead   
+
 This version adds key path-based paragraph functions to the `RichTextViewComponent`. This means that you can now get and set the following values with a single set of functions, pickers, steppers and toggles:
 
 `alignment`, `allowsDefaultTighteningForTruncation`, `baseWritingDirection`, `defaultTabInterval`, `firstLineHeadIndent`, `headIndent`, `hyphenationFactor`, `lineBreakMode`, `lineBreakStrategy`, `lineHeightMultiple`, `lineSpacing`, `maximumLineHeight`, `minimumLineHeight`, `paragraphSpacing`, `paragraphSpacingBefore`, `tabStops`, `tailIndent`, `usesDefaultHyphenation`.
@@ -37,8 +41,8 @@ As a result, all parts of the library that handled individual value types have b
 
 ### 🗑️ Deprecations 
 
-* `RichTextAlignment` has been deprecated due to the new paragraph-based features.
-* `RichTextAlignment.Picker` has been deprecated due to the new `Picker` capabilities.
+* `RichTextAlignment` and all nested types have been deprecated due to the new paragraph-based features.
+* `RichTextLine` and all nested types have been deprecated due to the new paragraph-based features.
 
 
 

Sources/RichTextKit/Paragraph/Stepper+RichTextParagraphValue.swift

@@ -8,6 +8,7 @@
 
 import SwiftUI
 
+#if iOS || os(macOS) || os(visionOS)
 public extension Stepper {
 
     /// Creates a stepper for a paragraph style value in the
@@ -73,3 +74,4 @@ public extension Stepper {
 
     return Preview()
 }
+#endif

Sources/RichTextKit/RichTextKit.docc/RichTextKit.md

@@ -149,10 +149,6 @@ RichTextKit is available under the MIT license.
 - ``RichTextKeyboardToolbarMenu``
 - ``RichTextKeyboardToolbarStyle``
 
-### Line
-
-- ``RichTextLine``
-
 ### Localization
 
 - ``RTKL10n``

Sources/RichTextKit/_Deprecated/RichTextAlignment.swift

@@ -8,7 +8,7 @@
 
 import SwiftUI
 
-@available(*, deprecated, message: "Use native NSTextAlignment directly")
+@available(*, deprecated, message: "Use native NSTextAlignment directly instead.")
 public enum RichTextAlignment: String, CaseIterable, Codable, Equatable, Identifiable, RichTextLabelValue {
 
     /// Create a rich text alignment with a native alignment.
@@ -38,13 +38,13 @@ public enum RichTextAlignment: String, CaseIterable, Codable, Equatable, Identif
     case right
 }
 
-@available(*, deprecated, message: "Use native NSTextAlignment instead")
+@available(*, deprecated, message: "Use native NSTextAlignment directly instead.")
 public extension Collection where Element == RichTextAlignment {
 
     static var all: [Element] { RichTextAlignment.allCases }
 }
 
-@available(*, deprecated, message: "Use native NSTextAlignment instead")
+@available(*, deprecated, message: "Use native NSTextAlignment directly instead.")
 public extension RichTextAlignment {
 
     /// The unique alignment ID.

Sources/RichTextKit/Line/RichTextLine+SpacingPicker.swift renamed to Sources/RichTextKit/_Deprecated/RichTextLine+SpacingPicker.swift

@@ -8,45 +8,46 @@
 
 import SwiftUI
 
+@available(*, deprecated, message: "Use SwiftUI Picker with native NSParagraphStyle directly instead.")
 public extension RichTextLine {
-
+    
     /**
      This picker can be used to pick a font size.
-
+     
      The view returns a plain SwiftUI `Picker` view that can
      be styled and configured with plain SwiftUI.
-
+     
      You can configure this picker by applying a config view
      modifier to your view hierarchy:
-
+     
      ```swift
      VStack {
-        RichTextLine.SpacingPicker(...)
-        ...
+     RichTextLine.SpacingPicker(...)
+     ...
      }
      .richTextLineSpacingPickerConfig(...)
      ```
      */
     struct SpacingPicker: View {
-
+        
         /**
          Create a line spacing picker.
-
+         
          - Parameters:
-           - selection: The selected font size.
+         - selection: The selected font size.
          */
         public init(
             selection: Binding<CGFloat>
         ) {
             self._selection = selection
         }
-
+        
         @Binding
         private var selection: CGFloat
-
+        
         @Environment(\.richTextLineSpacingPickerConfig)
         private var config
-
+        
         public var body: some View {
             Picker(RTKL10n.lineSpacing.text, selection: $selection) {
                 ForEach(values(
@@ -58,46 +59,21 @@ public extension RichTextLine {
                 }
             }
         }
-    }
-}
-
-public extension RichTextLine.SpacingPicker {
-
-    /// Get a list of values for a certain selection.
-    func values(
-        for values: [CGFloat],
-        selection: CGFloat
-    ) -> [CGFloat] {
-        let values = values + [selection]
-        return Array(Set(values)).sorted()
-    }
-}
-
-private extension RichTextLine.SpacingPicker {
-
-    func text(
-        for fontSize: CGFloat
-    ) -> some View {
-        Text(String(format: "%.1f", fontSize))
-            .fixedSize(horizontal: true, vertical: false)
-    }
-}
-
-#Preview {
-
-    struct Preview: View {
-
-        @State
-        private var selection: CGFloat = 2.0
-
-        var body: some View {
-            RichTextLine.SpacingPicker(
-                selection: $selection
-            )
-            .withPreviewPickerStyles()
-            .richTextLineSpacingPickerConfig(.init(values: [1, 2, 3]))
+        
+        /// Get a list of values for a certain selection.
+        func values(
+            for values: [CGFloat],
+            selection: CGFloat
+        ) -> [CGFloat] {
+            let values = values + [selection]
+            return Array(Set(values)).sorted()
+        }
+        
+        func text(
+            for fontSize: CGFloat
+        ) -> some View {
+            Text(String(format: "%.1f", fontSize))
+                .fixedSize(horizontal: true, vertical: false)
         }
     }
-
-    return Preview()
 }

Sources/RichTextKit/Line/RichTextLine+SpacingPickerConfig.swift renamed to Sources/RichTextKit/_Deprecated/RichTextLine+SpacingPickerConfig.swift

@@ -8,6 +8,7 @@
 
 import SwiftUI
 
+@available(*, deprecated, message: "Use SwiftUI Picker with native NSParagraphStyle directly instead.")
 public extension RichTextLine {
 
     /// This can be used with a ``RichTextLine/SpacingPicker``.
@@ -28,12 +29,14 @@ public extension RichTextLine {
     }
 }
 
+@available(*, deprecated, message: "Use SwiftUI Picker with native NSParagraphStyle directly instead.")
 public extension RichTextLine.SpacingPickerConfig {
 
     /// The standard line spacing picker configuration.
     static var standard: Self { .init() }
 }
 
+@available(*, deprecated, message: "Use SwiftUI Picker with native NSParagraphStyle directly instead.")
 public extension View {
 
     /// Apply a ``RichTextLine`` spacing picker configuration.
@@ -44,6 +47,7 @@ public extension View {
     }
 }
 
+@available(*, deprecated, message: "Use SwiftUI Picker with native NSParagraphStyle directly instead.")
 private extension RichTextLine.SpacingPickerConfig {
 
     struct Key: EnvironmentKey {
@@ -54,6 +58,7 @@ private extension RichTextLine.SpacingPickerConfig {
     }
 }
 
+@available(*, deprecated, message: "Use SwiftUI Picker with native NSParagraphStyle directly instead.")
 public extension EnvironmentValues {
 
     /// This value can bind to a line spacing picker config.

Sources/RichTextKit/Line/RichTextLine+SpacingPickerStack.swift renamed to Sources/RichTextKit/_Deprecated/RichTextLine+SpacingPickerStack.swift

@@ -9,6 +9,7 @@
 #if iOS || macOS || os(visionOS)
 import SwiftUI
 
+@available(*, deprecated, message: "Use SwiftUI Picker with native NSParagraphStyle directly instead.")
 public extension RichTextLine {
 
     /**
@@ -63,24 +64,4 @@ public extension RichTextLine {
         }
     }
 }
-
-#Preview {
-
-    struct Preview: View {
-
-        @StateObject
-        private var context = RichTextContext()
-
-        var body: some View {
-            VStack {
-                Text("Spacing: \(context.paragraphStyle[keyPath: \.lineSpacing])")
-                RichTextLine.SpacingPickerStack(context: context)
-            }
-            .buttonStyle(.bordered)
-            .padding()
-        }
-    }
-
-    return Preview()
-}
 #endif

Sources/RichTextKit/Line/RichTextLine.swift renamed to Sources/RichTextKit/_Deprecated/RichTextLine.swift

@@ -8,5 +8,5 @@
 
 import Foundation
 
-/// This is a namespace for line-related types and views.
+@available(*, deprecated, message: "Use native NSParagraphStyle directly instead.")
 public struct RichTextLine {}