Add docs

Author: Wouter01

README.md

@@ -212,3 +212,14 @@ func accessoryBar(@ViewBuilder content: () -> some View) -> some View
 /// Control the visibility of the list reorder controls. Untested.
 func listReorderControlVisibility(_ visibility: ListAccessoryVisibility) -> some View
 ```
+
+#### Form initializers
+
+```swift
+public extension Form {
+    /// Add a footer to a form.
+    static func withFooter<C: View, F: View>(@ViewBuilder content: () -> C, @ViewBuilder footer: () -> F) -> some View {
+        Form<FormFooterContent<C, F>>(content: content, footer: footer)
+    }
+}
+```

Sources/SwiftUIHidden/App+open.swift

@@ -8,6 +8,7 @@
 import SwiftUI
 
 public enum AppActions {
+    /// Open SwiftUI Settings.
     public static func openSettings() {
         if #available(macOS 14.0, *) {
             EnvironmentValues().openSettings()
@@ -18,30 +19,36 @@ public enum AppActions {
         }
     }
 
+    /// Open a SwiftUI Window.
     @available(macOS 13.0, *)
     public static func openWindow(id: String) {
         EnvironmentValues().openWindow(id: id)
     }
 
+    /// Open a SwiftUI Window.
     @available(macOS 13.0, *)
     public static func openWindow<Value: Codable & Hashable>(id: String, value: Value) {
         EnvironmentValues().openWindow(id: id, value: value)
     }
 
+    /// Open a SwiftUI Window.
     @available(macOS 13.0, *)
     public static func openWindow<Value: Codable & Hashable>(value: Value) {
         EnvironmentValues().openWindow(value: value)
     }
 
+    /// Open a SwiftUI Document.
     @available(macOS 13.0, *)
     public static func openDocument(at url: URL) async throws {
         try await EnvironmentValues().openDocument(at: url)
     }
 
+    /// Open an URL.
     public static func openURL(_ url: URL) {
         EnvironmentValues().openURL(url)
     }
 
+    /// Open an URL.
     public static func openURL(_ url: URL) async -> Bool {
         await withCheckedContinuation {
             EnvironmentValues().openURL(url, completion: $0.resume(returning:))

Sources/SwiftUIHidden/Environment+extensions.swift

@@ -24,6 +24,7 @@ public struct WithCurrentWindowAction {
 public struct HiddenEnvironmentValues {
     let environment: EnvironmentValues
 
+    /// Open SwiftUI Settings.
     public var openSettings: () -> Void {
         if #available(macOS 14.0, *) {
             environment.openSettings.callAsFunction
@@ -38,6 +39,7 @@ public struct HiddenEnvironmentValues {
         }
     }
 
+    /// Access the current window.
     public var withCurrentWindow: WithCurrentWindowAction {
         .init(action: environment.withCurrentWindow)
     }

Sources/SwiftUIHidden/Form+init.swift

@@ -8,6 +8,7 @@
 import SwiftUI
 
 public extension Form {
+    /// Add a footer to a form.
     static func withFooter<C: View, F: View>(@ViewBuilder content: () -> C, @ViewBuilder footer: () -> F) -> some View {
         Form<FormFooterContent<C, F>>(content: content, footer: footer)
     }

Sources/SwiftUIHidden/Scene+extensions.swift

@@ -16,14 +16,20 @@ public extension Scene {
 public struct HiddenSceneModifier<S: Scene> {
     let content: S
 
+    /// Customize the window background. Use `.clear` for a transparent window, use `.*Material` for a blurred background
     public func windowBackground(_ shape: some ShapeStyle) -> some Scene {
         content.windowBackground(shape)
     }
 
+    /// Disable automatic window opening behavior..
+    /// For example, when set to `.hidden`, launching the app or clicking the app icon won't create a new window of that scene.
+    /// Note that previously created windows may reappear.
     public func defaultVisibility(_ visibility: Visibility) -> some Scene {
         content.defaultVisibility(visibility)
     }
 
+    /// Determine if a window should be closed when the user tries to close the window.
+    /// Returning `true` will close the window, `false` will keep the window open.
     public func windowShouldClose(_ perform: @escaping () -> Bool) -> some Scene {
         content.windowShouldClose(perform)
     }

Sources/SwiftUIHidden/View+extensions.swift

@@ -42,66 +42,81 @@ public enum ListAccessoryVisibility {
 public struct HiddenViewModifier<Content: View> {
     let content: Content
 
+    /// Apply a variable blur overlay to a view.
+    public func variableBlur(maxRadius: CGFloat, mask: Image, opaque: Bool) -> some View {
+        content.variableBlur(maxRadius: maxRadius, mask: mask, opaque: opaque)
+    }
+    
+    /// Change the toolbar behavior when the window is fullscreen.
+    /// `.showsWithWindow` is the default behavior. `.showsWithMenuBar` will hide the toolbar when fullscreen.
     public func fullScreenToolbarBehavior(_ behavior: FullScreenToolbarBehavior) -> some View {
         content.fullScreenToolbarBehavior(behavior.toOriginal)
     }
 
+    /// Get a trigger when a row has been selected by the user, and gets clicked again.
+    /// This differs from a TapGesture, as there is no time limit between the clicks.
+    public func onReselect(enabled: Bool, perform: (() -> ())?) -> some View {
+        content.onReselect(isEnabled: enabled, perform: perform)
+    }
+    
+    /// Adjust the padding around a Form with FormStyle `.grouped`
     public func formInsets(_ edges: Edge.Set, _ value: CGFloat) -> some View {
         content.formInsets(edges, value)
     }
 
+    /// Adjust the padding around a Form with FormStyle `.grouped`
     public func formInsets(_ edges: Edge.Set, _ value: EdgeInsets) -> some View {
         content.formInsets(edges, value)
     }
 
-    public func onReselect(enabled: Bool, perform: (() -> ())?) -> some View {
-        content.onReselect(isEnabled: enabled, perform: perform)
+    /// Adjust the inset of an individual row in a Form with FormStyle `.grouped`
+    public func formRowInsets(_ insets: EdgeInsets?) -> some View {
+        content.formRowInsets(insets)
     }
 
-    public func variableBlur(maxRadius: CGFloat, mask: Image, opaque: Bool) -> some View {
-        content.variableBlur(maxRadius: maxRadius, mask: mask, opaque: opaque)
+    /// Set the indentation level of a Form row.
+    public func formRowIndentationLevel(_ level: Int?) -> some View {
+        content.formRowIndentationLevel(level)
     }
 
+    /// Change the background color of a Form.
     public func formBackground<S: ShapeStyle>(_ shape: S?) -> some View {
         content.formBackground(shape)
     }
 
+    /// Change the background color of an individual row in a Form.
     public func formRowBackground<S: ShapeStyle>(_ shape: S?) -> some View {
         content.formRowBackground(shape)
     }
 
-    public func formInfoAction(action: @escaping () -> Void) -> some View {
-        content.formInfoAction(action: action)
-    }
-    
+    /// Change the background color of a section.
     public func sectionBackground(_ visibility: Visibility) -> some View {
         content.sectionBackground(visibility)
     }
 
-    public func formRowInfoVisibility(_ visibility: Visibility) -> some View {
-        content.formRowInfoVisibility(visibility)
+    /// Add a trailing info icon to a Form row.
+    /// As an example, see system bluetooth settings.
+    public func formInfoAction(action: @escaping () -> Void) -> some View {
+        content.formInfoAction(action: action)
     }
 
-    public func formRowIndentationLevel(_ level: Int?) -> some View {
-        content.formRowIndentationLevel(level)
+    /// Change the visibility of the trailing info icon in a Form row.
+    public func formRowInfoVisibility(_ visibility: Visibility) -> some View {
+        content.formRowInfoVisibility(visibility)
     }
 
+    /// Add a trailing Form row view, which becomes visible when hovered over the row.
+    /// As an example, see system wifi settings.
     public func formAccessory(@ViewBuilder accessories: () -> some View) -> some View {
         content.formAccessory(accessories: accessories)
     }
 
-    public func formRowInsets(_ insets: EdgeInsets?) -> some View {
-        content.formRowInsets(insets)
-    }
-    
+    /// Change the visibility of the trailing Form row view.
     public func formAccessoryVisibility(_ visibility: Visibility) -> some View {
         content.formAccessoryVisibility(visibility)
     }
 
-    public func listReorderControlVisibility(_ visibility: ListAccessoryVisibility) -> some View {
-        content.listReorderControlVisibility(visibility.toOriginal)
-    }
-    
+    /// Add a bottom row to a Form.
     public func bottomBar(@ViewBuilder content: () -> some View) -> some View {
         self.content.bottomBar(content: content)
     }
@@ -111,4 +126,8 @@ public struct HiddenViewModifier<Content: View> {
         self.content.accessoryBar(content: content)
     }
 
+    /// Control the visibility of the list reorder controls. Untested.
+    public func listReorderControlVisibility(_ visibility: ListAccessoryVisibility) -> some View {
+        content.listReorderControlVisibility(visibility.toOriginal)
+    }
 }