Add list footer

Author: danielsaidi

RELEASE_NOTES.md

@@ -4,6 +4,17 @@ SwiftUIKit makes its best effort to honor semver, but breaking changes can occur
 
 
 
+## 5.9.1
+
+This version improves the plain list content capabilities of the SDK.
+
+### ✨ Features
+
+* `PlainListContent` is a wrapper that removes any list decorations from a view.
+* `ListHeader` and `ListFooter` are `PlainListContent` wrappers that perform header/footer specific adjustments.
+
+
+
 ## 5.9
 
 This version deprecates progress types, since a native `Gauge` can be used instead.

Sources/SwiftUIKit/Lists/ListHeader.swift

@@ -0,0 +1,125 @@
+//
+//  PlainListContent.swift
+//  SwiftUIKit
+//
+//  Created by Daniel Saidi on 2023-06-01.
+//  Copyright © 2023-2025 Daniel Saidi. All rights reserved.
+//
+
+import SwiftUI
+
+/// This view can be used to add a plain content view to any
+/// part of a `List`.
+private struct PlainListContent<Content: View>: View {
+
+    public init(
+        @ViewBuilder content: @escaping () -> Content
+    ) {
+        self.content = content
+    }
+
+    private let content: (() -> Content)
+
+    public var body: some View {
+        content()
+            .frame(maxWidth: .infinity)
+            .listRowBackground(Color.clear)
+            .prefersListRowSeparatorHidden()
+    }
+}
+
+/// This view can be used to add a plain footer to a `List`.
+///
+/// The view adds negative padding to adjust for the spacing
+/// to the aligning content on certain platforms.
+public struct ListFooter<Content: View>: View {
+
+    public init(
+        @ViewBuilder content: @escaping () -> Content
+    ) {
+        #if os(iOS)
+        self.padding = -10
+        #else
+        self.padding = 0
+        #endif
+        self.content = content
+    }
+
+    private let padding: Double
+    private let content: (() -> Content)
+
+    public var body: some View {
+        PlainListContent(content: content)
+            .padding(.top, padding)
+    }
+}
+
+/// This view can be used to add a plain header to a `List`.
+///
+/// The view adds negative padding to adjust for the spacing
+/// to the aligning content on certain platforms. 
+public struct ListHeader<Content: View>: View {
+
+    /// Create a list header.
+    ///
+    /// - Parameters:
+    ///   - content: The header view.
+    public init(
+        @ViewBuilder content: @escaping () -> Content
+    ) {
+        #if os(iOS)
+        self.padding = -10
+        #else
+        self.padding = 0
+        #endif
+        self.content = content
+    }
+    
+    private let padding: Double
+    private let content: (() -> Content)
+
+    public var body: some View {
+        PlainListContent(content: content)
+            .padding(.bottom, padding)
+    }
+}
+
+private extension View {
+
+    @ViewBuilder
+    func prefersListRowSeparatorHidden() -> some View {
+        #if os(tvOS) || os(watchOS)
+        self
+        #else
+        if #available(iOS 15.0, macOS 13.0, watchOS 9.0, *) {
+            self.listRowSeparator(.hidden)
+        } else {
+            self
+        }
+        #endif
+    }
+}
+
+#Preview {
+    
+    func item() -> some View {
+        Text("Preview.Item", bundle: .module)
+    }
+    
+    return VStack {
+        List {
+            ListHeader {
+                Color.red.frame(square: 150)
+            }
+            Section {
+                item()
+                item()
+                item()
+                item()
+            }
+            ListFooter {
+                Color.red.frame(square: 150)
+            }
+        }
+    }
+}

Sources/SwiftUIKit/Lists/PlainListContent.swift

@@ -104,13 +104,15 @@ SwiftUIKit is available under the MIT license.
 - ``ListCardButtonStyle``
 - ``ListCardStyle``
 - ``ListDragHandle``
+- ``ListFooter``
 - ``ListHeader``
 - ``ListPadding``
 - ``ListSectionTitle``
 - ``ListSelectItem``
 - ``ListShelfSection``
 - ``ListShelfSectionStyle``
 - ``ListSubtitle``
+- ``PlainListContent``
 - ``Reorderable``
 - ``ReorderableForEach``
 - ``SidebarListRowBackgroundModifier``

Sources/SwiftUIKit/SwiftUIKit.docc/SwiftUIKit.md

@@ -0,0 +1,49 @@
+import SwiftUI
+
+public extension ListHeader {
+
+    @available(*, deprecated, message: "Apply a custom bottom padding directly to the view instead.")
+    @_disfavoredOverload
+    init(
+        bottomPadding: Double? = nil,
+        @ViewBuilder view: @escaping () -> Content
+    ) {
+        self.init(content: view)
+    }
+}
+
+@available(*, deprecated, message: "Use ListHeader directly instead")
+public extension View {
+
+    /// Convert the view to a list header.
+    ///
+    /// - Parameters:
+    ///   - bottomPadding: A custom bottom padding, if any.
+    func listHeader(
+        bottomPadding: Double? = nil
+    ) -> some View {
+        ListHeader(bottomPadding: bottomPadding) {
+            self
+        }
+    }
+}
+
+@available(*, deprecated, message: "Use ListHeader directly instead")
+public extension Image {
+
+    /// Convert the image to a list header.
+    ///
+    /// - Parameters:
+    ///   - height: The image height, if any.
+    ///   - bottomPadding: A custom bottom padding, if any.
+    @MainActor func listHeader(
+        height: CGFloat?,
+        bottomPadding: Double? = nil
+    ) -> some View {
+        ListHeader {
+            self.resizable()
+                .aspectRatio(contentMode: .fit)
+                .frame(height: height)
+        }
+    }
+}