Update documentation

Author: danielsaidi

RELEASE_NOTES.md

@@ -4,6 +4,12 @@ SwiftUIKit makes its best effort to honor semver, but breaking changes can occur
 
 
 
+## 5.8.4
+
+This version updates deprecation information for presentation types.
+
+
+
 ## 5.8.3
 
 This version deprecates list action types.

Sources/SwiftUIKit/_Deprecated/ListAction.swift

@@ -132,20 +132,3 @@ private extension ListAction {
         #endif
     }
 }
-
-#Preview {
-
-    @MainActor
-    func view(for action: ListAction) -> some View {
-        action.button
-    }
-    
-    return List {
-        view(for: .call(phoneNumber: "abc123"))
-        #if os(macOS) || os(iOS) || os(visionOS)
-        view(for: .copy("abc123"))
-        #endif
-        view(for: .email(address: "abc123"))
-        view(for: .openUrl("https://danielsaidi.com"))
-    }
-}

Sources/SwiftUIKit/_Deprecated/Presentation/AlertContext.swift

@@ -9,31 +9,7 @@
 import SwiftUI
 
 /// This context can be used to present alerts.
-///
-/// To use this class, just create a `@StateObject` instance
-/// in your presenting view and bind the context to the view:
-///
-/// ```swift
-/// extension Alert {
-///     static let customAlert = Alert(title: "Hello, world!")
-/// }
-///
-/// struct MyView: View {
-///
-///     @StateObject var context = AlertContext()
-///     var body: some View {
-///         Button("Show alert") {
-///             context.present(.customAlert)
-///         }
-///         .alert(context)
-///     }
-/// }
-/// ```
-///
-/// This view modifier will also inject the provided context
-/// as an environment object into the view hierarchy, to let
-/// other views in the same hierarchy reuse the same context.
-@available(*, deprecated, message: "This has been moved to https://github.com/danielsaidi/PresentationKit")
+@available(*, deprecated, message: "This has been moved to PresentationKit and renamed.")
 public class AlertContext: PresentationContext<Alert> {
 
     @MainActor
@@ -45,8 +21,9 @@ public class AlertContext: PresentationContext<Alert> {
 }
 
 public extension View {
-    
-    @available(*, deprecated, message: "This has been moved to https://github.com/danielsaidi/PresentationKit")
+
+    /// Bind an ``AlertContext`` to the view.
+    @available(*, deprecated, message: "This has been moved to PresentationKit")
     func alert(_ context: AlertContext) -> some View {
         alert(
             isPresented: context.isActiveBinding,
@@ -56,32 +33,14 @@ public extension View {
     }
 }
 
-/**
- This key can be used to keep track of the currently focused
- context within a multi-window app.
-
- To apply it to a view, just use the `focusedValue` modifier
- with your context instance:
-
- ```swift
- .focusedValue(\.fullscreenCoverContext, context)
- ```
-
- To access the focus value, e.g. in a menu command, just use
- the `@FocusedValue` property wrapper:
-
- ```swift
- @FocusedValue(\.fullscreenCoverContext)
- var fullscreenCoverContext: FullscreenCoverContext?
- ```
- */
-@available(*, deprecated, message: "This has been moved to https://github.com/danielsaidi/PresentationKit")
+/// This key can be used to keep track of the current value.
+@available(*, deprecated, message: "This has been moved to PresentationKit")
 public struct AlertContextFocusedValueKey: FocusedValueKey {
 
     public typealias Value = AlertContext
 }
 
-@available(*, deprecated, message: "This has been moved to https://github.com/danielsaidi/PresentationKit")
+@available(*, deprecated, message: "This has been moved to PresentationKit")
 public extension FocusedValues {
 
     var alertContext: AlertContextFocusedValueKey.Value? {

Sources/SwiftUIKit/_Deprecated/ErrorAlertConvertible.swift renamed to Sources/SwiftUIKit/_Deprecated/Presentation/ErrorAlertConvertible.swift

@@ -8,23 +8,17 @@
 
 import SwiftUI
 
-@available(*, deprecated, message: "This has been moved to https://github.com/danielsaidi/PresentationKit")
+@available(*, deprecated, message: "This has been moved to PresentationKit and renamed.")
 public protocol ErrorAlerter {
-    
+
     var alert: AlertContext { get }
 }
 
-@available(*, deprecated, message: "This has been moved to https://github.com/danielsaidi/PresentationKit")
 @MainActor
+@available(*, deprecated, message: "This has been moved to PresentationKit and renamed.")
 public extension ErrorAlerter {
 
-    /**
-     Alert the provided error.
-
-     If the error is an ``ErrorAlertConvertible``, then this
-     presents its ``ErrorAlertConvertible/errorAlert``, else
-     the error's `localizedDescription` is alerted.
-     */
+    /// Alert the provided error.
     func alert(
         error: Error,
         okButtonText: String = "OK"
@@ -39,10 +33,6 @@ public extension ErrorAlerter {
             )
         )
     }
-}
-
-@available(*, deprecated, message: "This has been moved to https://github.com/danielsaidi/PresentationKit")
-public extension ErrorAlerter {
 
     /// This typealias describes an async operation.
     typealias AsyncOperation = () async throws -> Void
@@ -57,7 +47,7 @@ public extension ErrorAlerter {
     typealias BlockOperation<ErrorType: Error> = (BlockCompletion<ErrorType>) -> Void
 
     /// Alert the provided error asynchronously.
-    @MainActor func alertAsync(
+    func alertAsync(
         error: Error,
         okButtonText: String = "OK"
     ) {
@@ -69,7 +59,7 @@ public extension ErrorAlerter {
 
     /// Try to perform a block-based operation, and alert if
     /// this operation fails in any way.
-    @MainActor func tryWithErrorAlert<ErrorType: Error>(
+    func tryWithErrorAlert<ErrorType: Error>(
         _ operation: @escaping BlockOperation<ErrorType>,
         completion: @escaping BlockCompletion<ErrorType>
     ) {
@@ -87,7 +77,7 @@ public extension ErrorAlerter {
     ///
     /// This function wraps an async operation in a task and
     /// alerts any errors that are thrown.
-    @MainActor func tryWithErrorAlert(_ operation: @escaping AsyncOperation) {
+    func tryWithErrorAlert(_ operation: @escaping AsyncOperation) {
         Task {
             do {
                 try await operation()

Sources/SwiftUIKit/_Deprecated/ErrorAlerter.swift renamed to Sources/SwiftUIKit/_Deprecated/Presentation/ErrorAlerter.swift

@@ -9,28 +9,7 @@
 import SwiftUI
 
 /// This context can be used to present full screen covers.
-///
-/// To use this class, just create a `@StateObject` instance
-/// in your presenting view and bind the context to the view:
-///
-/// ```swift
-/// struct MyView: View {
-///
-///     @StateObject var context = FullScreenCoverContext()
-///
-///         var body: some View {
-///             Button("Show cover") {
-///             context.present(Text("Hello, world!"))
-///         }
-///         .fullScreenCover(context)
-///     }
-/// }
-/// ```
-///
-/// This view modifier will also inject the provided context
-/// as an environment object into the view hierarchy, to let
-/// other views in the same hierarchy reuse the same context.
-@available(*, deprecated, message: "This has been moved to https://github.com/danielsaidi/PresentationKit")
+@available(*, deprecated, message: "This has been moved to PresentationKit and renamed.")
 public class FullScreenCoverContext: PresentationContext<AnyView> {
 
     @MainActor
@@ -46,10 +25,8 @@ import SwiftUI
 
 public extension View {
 
-    /// Bind an ``FullScreenCoverContext`` to the view.
-    ///
-    /// This also injects this context as environment object.
-    @available(*, deprecated, message: "This has been moved to https://github.com/danielsaidi/PresentationKit")
+    /// Bind a ``FullScreenCoverContext`` to the view.
+    @available(*, deprecated, message: "This has been moved to PresentationKit")
     func fullScreenCover(
         _ context: FullScreenCoverContext
     ) -> some View {
@@ -62,32 +39,15 @@ public extension View {
 }
 #endif
 
-/**
- This key can be used to keep track of the currently focused
- context within a multi-window app.
 
- To apply it to a view, just use the `focusedValue` modifier
- with your context instance:
-
- ```swift
- .focusedValue(\.fullscreenCoverContext, context)
- ```
-
- To access the focus value, e.g. in a menu command, just use
- the `@FocusedValue` property wrapper:
-
- ```swift
- @FocusedValue(\.fullscreenCoverContext)
- var fullscreenCoverContext: FullscreenCoverContext?
- ```
- */
-@available(*, deprecated, message: "This has been moved to https://github.com/danielsaidi/PresentationKit")
+/// This key can be used to keep track of the current value.
+@available(*, deprecated, message: "This has been moved to PresentationKit")
 public struct FullScreenCoverContextFocusedValueKey: FocusedValueKey {
 
     public typealias Value = FullScreenCoverContext
 }
 
-@available(*, deprecated, message: "This has been moved to https://github.com/danielsaidi/PresentationKit")
+@available(*, deprecated, message: "This has been moved to PresentationKit")
 public extension FocusedValues {
 
     var fullScreenCoverContext: FullScreenCoverContextFocusedValueKey.Value? {

Sources/SwiftUIKit/_Deprecated/Presentation/FullScreenCoverContext.swift

@@ -18,7 +18,7 @@ import SwiftUI
 ///
 /// You can also setup a global context and pass it into the
 /// view hierarchy as an environment object.
-@available(*, deprecated, message: "This has been moved to https://github.com/danielsaidi/PresentationKit")
+@available(*, deprecated, message: "This has been moved to PresentationKit and renamed.")
 open class PresentationContext<Content>: ObservableObject {
 
     public init() {}
@@ -33,7 +33,7 @@ open class PresentationContext<Content>: ObservableObject {
 }
 
 @MainActor
-@available(*, deprecated, message: "This has been moved to https://github.com/danielsaidi/PresentationKit")
+@available(*, deprecated, message: "This has been moved to PresentationKit")
 public extension PresentationContext {
 
     var isActiveBinding: Binding<Bool> {

Sources/SwiftUIKit/_Deprecated/Presentation/PresentationContext.swift

@@ -8,31 +8,8 @@
 
 import SwiftUI
 
-/**
- This context can be used to present sheets in a dynamic way.
- 
- To use this class, just create a `@StateObject` instance in
- your presenting view and bind the context to that view:
- 
- ```swift
- struct MyView: View {
- 
-     @StateObject var context = SheetContext()
- 
-     var body: some View {
-         Button("Show sheet") {
-             context.present(Text("Hello, world!"))
-         }
-         .sheet(context)
-     }
- }
- ```
- 
- This view modifier will also inject the provided context as
- an environment object into the view hierarchy, to let other
- views in the same view hierarchy reuse the same context.
- */
-@available(*, deprecated, message: "This has been moved to https://github.com/danielsaidi/PresentationKit")
+/// This context can be used to present sheets.
+@available(*, deprecated, message: "This has been moved to PresentationKit and renamed.")
 public class SheetContext: PresentationContext<AnyView> {
 
     @MainActor
@@ -41,12 +18,10 @@ public class SheetContext: PresentationContext<AnyView> {
     }
 }
 
-@available(*, deprecated, message: "This has been moved to https://github.com/danielsaidi/PresentationKit")
+@available(*, deprecated, message: "This has been moved to PresentationKit")
 public extension View {
 
-    /// Bind an ``SheetContext`` to the view.
-    ///
-    /// This also injects this context as environment object.
+    /// Bind a ``SheetContext`` to the view.
     func sheet(_ context: SheetContext) -> some View {
         sheet(
             isPresented: context.isActiveBinding,
@@ -56,26 +31,9 @@ public extension View {
     }
 }
 
-/**
- This key can be used to keep track of the currently focused
- context within a multi-window app.
-
- To apply it to a view, just use the `focusedValue` modifier
- with your context instance:
 
- ```swift
- .focusedValue(\.sheetContext, context)
- ```
-
- To access the focus value, e.g. in a menu command, just use
- the `@FocusedValue` property wrapper:
-
- ```swift
- @FocusedValue(\.sheetContext)
- private var sheetContext: SheetContext?
- ```
- */
-@available(*, deprecated, message: "This has been moved to https://github.com/danielsaidi/PresentationKit")
+/// This key can be used to keep track of the current value.
+@available(*, deprecated, message: "This has been moved to PresentationKit")
 public struct SheetContextFocusedValueKey: FocusedValueKey {
 
     public typealias Value = SheetContext