Move examples into a new namespace and rename some view modifiers

Author: danielsaidi

Demo/Demo/ContentView.swift

@@ -3,7 +3,7 @@
 //  ScrollKit
 //
 //  Created by Daniel Saidi on 2023-02-04.
-//  Copyright © 2023-2024 Daniel Saidi. All rights reserved.
+//  Copyright © 2023-2025 Daniel Saidi. All rights reserved.
 //
 
 import SwiftUI

Demo/Demo/DemoScreen.swift

@@ -3,7 +3,7 @@
 //  ScrollKit
 //
 //  Created by Daniel Saidi on 2023-02-04.
-//  Copyright © 2023-2024 Daniel Saidi. All rights reserved.
+//  Copyright © 2023-2025 Daniel Saidi. All rights reserved.
 //
 
 import ScrollKit
@@ -21,7 +21,7 @@ struct DemoScreen<HeaderView: View>: View {
     let headerView: () -> HeaderView
 
     @State
-    private var headerVisibleRatio: CGFloat = 1
+    private var visibleHeaderRatio: CGFloat = 1
 
     @State
     private var scrollOffset: CGPoint = .zero
@@ -39,7 +39,7 @@ struct DemoScreen<HeaderView: View>: View {
                 Text("Demo Title")
                     .font(.headline)
                     .previewHeaderContent()
-                    .opacity(1 - headerVisibleRatio)
+                    .opacity(1 - visibleHeaderRatio)
             }
         }
         .toolbarBackground(.hidden)
@@ -61,7 +61,7 @@ struct DemoScreen<HeaderView: View>: View {
             Text("Some additional information")
         }
         .padding(20)
-        .opacity(headerVisibleRatio)
+        .opacity(visibleHeaderRatio)
     }
 
     var listItems: some View {
@@ -77,9 +77,9 @@ struct DemoScreen<HeaderView: View>: View {
         }
     }
 
-    func handleScrollOffset(_ offset: CGPoint, headerVisibleRatio: CGFloat) {
+    func handleScrollOffset(_ offset: CGPoint, visibleHeaderRatio: CGFloat) {
         self.scrollOffset = offset
-        self.headerVisibleRatio = headerVisibleRatio
+        self.visibleHeaderRatio = visibleHeaderRatio
     }
 }
 

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023-2024 Daniel Saidi
+Copyright (c) 2023-2025 Daniel Saidi
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -56,29 +56,30 @@ struct MyView: View {
 
     @State
     private var visibleRatio = CGFloat.zero
-    
-    func handleOffset(_ scrollOffset: CGPoint, visibleHeaderRatio: CGFloat) {
-        self.offset = scrollOffset
-        self.visibleRatio = visibleHeaderRatio
-    }
-    
-    func header() -> some View {
-        ZStack(alignment: .bottomLeading) {
-            Color.blue
-            Color.yellow.opacity(visibleRatio)  // Fades in
-        }
-    }
 
     var body: some View {
         ScrollViewWithStickyHeader(
-            header: header,
-            headerHeight: 250,
-            headerMinHeight: 150,
-            onScroll: handleOffset
+            header: stickyHeader,   // A header view
+            headerHeight: 250,      // Its resting height
+            headerMinHeight: 150,   // Its minimum height
+            onScroll: handleScroll  // An optional scroll action
         ) {
             // Add your scroll content here, e.g. a `LazyVStack`
         }
     }
+
+    func handleScroll(_ offset: CGPoint, visibleHeaderRatio: CGFloat) {
+        self.scrollOffset = offset
+        self.visibleRatio = visibleHeaderRatio
+    }
+
+    func stickyHeader() -> some View {
+        ZStack {
+            Color.red
+            ScrollViewHeaderGradient()  // By default a dark gradient
+            Text("Scroll offset: \(offset.y)")
+        }
+    }
 }
 ```
 

RELEASE_NOTES.md

@@ -6,6 +6,18 @@ Until then, deprecated features may be removed in any minor version.
 
 
 
+## 0.7
+
+This version moves examples into a new namespace and renames some View extensions to make more sense. 
+
+### 🗑️ Deprecations
+
+* All examples have been moved into a new `Examples` namespace.
+* The `hideStatusBarUntilScrolled` view extension has been renamed to `statusBarHiddenUntilScrolled`.
+* The `withScrollOffsetTracking` view extension has been renamed to `scrollViewOffsetTracking`.
+
+
+
 ## 0.6.1
 
 This version adjusts the code to address a concurrency warning.

Sources/ScrollKit/Examples/Examples+Spotify.swift

@@ -0,0 +1,15 @@
+//
+//  Examples+Spotify.swift
+//  ScrollKit
+//
+//  Created by Daniel Saidi on 2023-12-04.
+//  Copyright © 2023-2025 Daniel Saidi. All rights reserved.
+//
+
+import Foundation
+
+public extension Examples {
+ 
+    /// This namespace contains Spotify-related types.
+    struct Spotify {}
+}

Sources/ScrollKit/Examples/Spotify+PreviewInfo.swift renamed to Sources/ScrollKit/Examples/Examples+SpotifyAlbum.swift

@@ -1,17 +1,17 @@
 //
-//  Spotify+PreviewInfo.swift
+//  Examples+SpotifyAlbum.swift
 //  ScrollKit
 //
 //  Created by Daniel Saidi on 2023-03-10.
-//  Copyright © 2023-2024 Daniel Saidi. All rights reserved.
+//  Copyright © 2023-2025 Daniel Saidi. All rights reserved.
 //
 
 import SwiftUI
 
-public extension Spotify {
+public extension Examples.Spotify {
 
     /// This model is used by the Spotify previews.
-    struct PreviewInfo {
+    struct Album {
 
         public init(
             bandName: String,
@@ -20,7 +20,8 @@ public extension Spotify {
             releaseDate: Date,
             releaseCoverUrl: String,
             tintColor: Color,
-            tracks: [String]) {
+            tracks: [String]
+        ) {
             self.bandName = bandName
             self.releaseTitle = releaseTitle
             self.releaseType = releaseType
@@ -40,7 +41,7 @@ public extension Spotify {
     }
 }
 
-public extension Spotify.PreviewInfo {
+public extension Examples.Spotify.Album {
 
     static var anthrax: Self {
         .init(
@@ -77,7 +78,7 @@ public extension Spotify.PreviewInfo {
             releaseTitle: "Forsaken",
             releaseType: "Album",
             releaseDate: Calendar.current.date(from: DateComponents(year: 1999)) ?? .now,
-            releaseCoverUrl: "https://i.discogs.com/75jm2NwzdkgIlEo9ucyl4_o1OCOzB4EQPZua8VQ5W94/rs:fit/g:sm/q:90/h:600/w:600/czM6Ly9kaXNjb2dz/LWRhdGFiYXNlLWlt/YWdlcy9SLTQzOTg5/NDUtMTM4NzIwNTE4/Ni02NTI1LmpwZWc.jpeg",
+            releaseCoverUrl: "https://danielsaidi.com/assets/bands/misfortune/forsaken.jpg",
             tintColor: .init(red: 0.5, green: 0.3, blue: 0),
             tracks: [
                 "Forsaken",

Sources/ScrollKit/Examples/Spotify+PreviewScreen.swift renamed to Sources/ScrollKit/Examples/Examples+SpotifyAlbumScreen.swift

@@ -1,40 +1,40 @@
 //
-//  Spotify+PreviewScreen.swift
+//  Examples+SpotifyAlbumScreen.swift
 //  ScrollKit
 //
 //  Created by Daniel Saidi on 2023-02-07.
-//  Copyright © 2023-2024 Daniel Saidi. All rights reserved.
+//  Copyright © 2023-2025 Daniel Saidi. All rights reserved.
 //
 
 import SwiftUI
 
-public extension Spotify {
+public extension Examples.Spotify {
 
     /// This view mimics a Spotify album screen.
-    struct PreviewScreen: View {
+    struct AlbumScreen: View {
 
-        public init(info: PreviewInfo) {
-            self.info = info
+        public init(album: Album) {
+            self.album = album
         }
 
-        private var info: PreviewInfo
+        private var album: Album
 
         @Environment(\.dismiss)
         private var dismiss
 
         @State
-        private var headerVisibleRatio = 1.0
+        private var visibleHeaderRatio = 1.0
 
         @State
         private var scrollOffset = CGPoint.zero
 
         public var body: some View {
             ScrollViewWithStickyHeader(
                 header: scrollViewHeader,
-                headerHeight: Spotify.PreviewScreenHeader.height,
+                headerHeight: Examples.Spotify.AlbumScreen.Header.height,
                 onScroll: handleScrollOffset
             ) {
-                Spotify.PreviewScreenContent(info: info)
+                Examples.Spotify.AlbumScreen.Content(album: album)
             }
             .preferredColorScheme(.dark)
             #if os(iOS)
@@ -46,21 +46,21 @@ public extension Spotify {
         }
 
         func scrollViewHeader() -> some View {
-            Spotify.PreviewScreenHeader(
-                info: info,
-                headerVisibleRatio: headerVisibleRatio
+            Examples.Spotify.AlbumScreen.Header(
+                album: album,
+                visibleHeaderRatio: visibleHeaderRatio
             )
         }
 
         var toolbarTitleView: some View {
-            Text(info.releaseTitle)
+            Text(album.releaseTitle)
                 .font(.headline.bold())
-                .opacity(headerVisibleRatio > 0 ? 0 : -5 * headerVisibleRatio)
+                .opacity(visibleHeaderRatio > 0 ? 0 : -5 * visibleHeaderRatio)
         }
 
-        func handleScrollOffset(_ offset: CGPoint, headerVisibleRatio: CGFloat) {
+        func handleScrollOffset(_ offset: CGPoint, visibleHeaderRatio: CGFloat) {
             self.scrollOffset = offset
-            self.headerVisibleRatio = headerVisibleRatio
+            self.visibleHeaderRatio = visibleHeaderRatio
         }
     }
 }
@@ -90,14 +90,21 @@ private extension View {
     }
 }
 
-#Preview("Navigation") {
+private var previewAlbum: Examples.Spotify.Album { .misfortune }
+
+#Preview("Plain") {
+
+    Examples.Spotify.AlbumScreen(album: previewAlbum)
+}
+
+#Preview("Push") {
 
     NavigationView {
         #if os(macOS)
         Color.clear
         #endif
         NavigationLink("Test") {
-            Spotify.PreviewScreen(info: .regina)
+            Examples.Spotify.AlbumScreen(album: previewAlbum)
         }
     }
     #if os(iOS)
@@ -118,7 +125,7 @@ private extension View {
             }
             .sheet(isPresented: $isPresented) {
                 NavigationView {
-                    Spotify.PreviewScreen(info: .regina)
+                    Examples.Spotify.AlbumScreen(album: previewAlbum)
                 }
                 .navigationViewStyle(.stack)
             }

Sources/ScrollKit/Examples/Spotify+PreviewScreenContent.swift renamed to Sources/ScrollKit/Examples/Examples+SpotifyAlbumScreenContent.swift

@@ -1,23 +1,23 @@
 //
-//  Spotify+PreviewScreenContent.swift
+//  Examples+SpotifyAlbumScreenContent.swift
 //  ScrollKit
 //
 //  Created by Daniel Saidi on 2023-02-06.
-//  Copyright © 2023-2024 Daniel Saidi. All rights reserved.
+//  Copyright © 2023-2025 Daniel Saidi. All rights reserved.
 //
 
 import SwiftUI
 
-public extension Spotify {
+public extension Examples.Spotify.AlbumScreen {
 
     /// This view mimics a Spotify album screen content view.
-    struct PreviewScreenContent: View {
+    struct Content: View {
 
-        public init(info: PreviewInfo) {
-            self.info = info
+        public init(album: Examples.Spotify.Album) {
+            self.album = album
         }
 
-        private let info: PreviewInfo
+        private let album: Examples.Spotify.Album
 
         public var body: some View {
             VStack(spacing: 20) {
@@ -30,16 +30,16 @@ public extension Spotify {
     }
 }
 
-private extension Spotify.PreviewScreenContent {
+private extension Examples.Spotify.AlbumScreen.Content {
 
     var title: some View {
         VStack(alignment: .leading, spacing: 8) {
-            Text(info.releaseTitle)
+            Text(album.releaseTitle)
                 .font(.title2.bold())
                 .frame(maxWidth: .infinity, alignment: .leading)
-            Text(info.bandName)
+            Text(album.bandName)
                 .font(.footnote.bold())
-            Text("\(info.releaseType) · \(info.releaseDate.formatted(.dateTime.year()))")
+            Text("\(album.releaseType) · \(album.releaseDate.formatted(.dateTime.year()))")
                 .font(.footnote.bold())
                 .foregroundColor(.secondary)
         }
@@ -61,7 +61,7 @@ private extension Spotify.PreviewScreenContent {
 
     var list: some View {
         LazyVStack(alignment: .leading, spacing: 30) {
-            ForEach(Array(info.tracks.enumerated()), id: \.offset) {
+            ForEach(Array(album.tracks.enumerated()), id: \.offset) {
                 listItem($0.element)
             }
         }
@@ -70,7 +70,7 @@ private extension Spotify.PreviewScreenContent {
     func listItem(_ song: String) -> some View {
         VStack(alignment: .leading) {
             Text(song).font(.headline)
-            Text(info.bandName)
+            Text(album.bandName)
                 .font(.footnote)
                 .foregroundColor(.secondary)
         }
@@ -80,6 +80,6 @@ private extension Spotify.PreviewScreenContent {
 #Preview {
 
     ScrollView {
-        Spotify.PreviewScreenContent(info: .anthrax)
+        Examples.Spotify.AlbumScreen.Content(album: .anthrax)
     }
 }