Update docs

danielsaidi · danielsaidi · commit 46d2869a0df4 · 2025-11-21T20:15:12.000+01:00
diff --git a/Demo/Demo/DemoOnboardingPage.swift b/Demo/Demo/DemoOnboardingPage.swift
@@ -40,7 +40,7 @@ enum DemoOnboardingPage: Int, CaseIterable, Identifiable {
 
 struct DemoOnboardingPageContent: View {
 
-    let pageInfo: OnboardingFlowPage<DemoOnboardingPage>
+    let pageInfo: OnboardingPage<DemoOnboardingPage>
 
     var body: some View {
         VStack(alignment: .leading, spacing: 50) {
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -13,6 +13,12 @@ These release notes only cover the current major version.
 
 
 
+## 9.0.1
+
+This patch renames a few things for ease of use.
+
+
+
 ## 9.0
 
 This version makes the SDK target iOS 17 and aligned versions.
@@ -31,7 +37,7 @@ This version makes the SDK target iOS 17 and aligned versions.
 
 ### 💥 Breaking Changes
 
-* `OnboardingPageInfo` is renamed to `OnboardingFlowPage`.
+* `OnboardingPageInfo` is renamed to `OnboardingPage`.
 * `OnboardingPageState` is renamed to `OnboardingFlowState`.
 * `OnboardingScreen` is renamed to `OnboardingFlowContainer`.
 * This version makes the SDK target iOS 17 and aligned versions.
diff --git a/Sources/OnboardingKit/Flows/OnboardingFlow+PageInfoProvider.swift b/Sources/OnboardingKit/Flows/OnboardingFlow+PageInfoProvider.swift
diff --git a/Sources/OnboardingKit/Flows/OnboardingFlow.swift b/Sources/OnboardingKit/Flows/OnboardingFlow.swift
diff --git a/Sources/OnboardingKit/Flows/OnboardingFlowContainer.swift b/Sources/OnboardingKit/Flows/OnboardingFlowContainer.swift
@@ -66,7 +66,7 @@ public struct OnboardingFlowContainer<Page, Content: View, Buttons: View>: View
 }
 
 /// This view can wrap any content view and applies an alignment and max width.
-public struct OnboardingFlowContainerCenteredContent<Content: View>: View {
+public struct OnboardingFlowCenteredContent<Content: View>: View {
 
     /// Create a centered onboarding screen content view.
     ///
@@ -149,7 +149,7 @@ private extension OnboardingFlowContainer {
                                 pages: pages,
                                 pageIndex: $pageIndex
                             ) { info in
-                                OnboardingFlowContainerCenteredContent {
+                                OnboardingFlowCenteredContent {
                                     Text("Page \(info.pageIndex)")
                                 }
                             }
diff --git a/Sources/OnboardingKit/Flows/OnboardingFlowState.swift b/Sources/OnboardingKit/Flows/OnboardingFlowState.swift
diff --git a/Sources/OnboardingKit/Onboarding+CorrectBehavior.swift b/Sources/OnboardingKit/Onboarding+CorrectBehavior.swift
@@ -16,13 +16,13 @@ extension Onboarding {
     /// An example could be a puzzle game for kids, where an onboarding could
     /// trigger the pieces animate to their correct positions.
     ///
-    /// Call ``registerIncorrectBehavior()`` when the user does not
-    /// behave as intended, to present an onboarding after a certain number of
-    /// attempts, then call ``registerCorrectBehavior()`` when the user
-    /// behaves as intended, to reset the attempt count.
+    /// Call ``registerIncorrectBehavior(presentAfterSeconds:action:)``
+    /// when a user doesn't behave as intended, to automatically present a help
+    /// after a number of attempts. Call ``registerCorrectBehavior()``
+    /// when the user then behaves as intended, to reset the attempt count. The
+    /// onboarding can keep being used in case the user forgets.
     ///
-    /// Unlike ``Onboarding``, this onboarding will reset itself each time it's
-    /// presented.
+    /// Unlike ``Onboarding``, this will reset itself each time it's presented.
     open class CorrectBehavior: Delayed {
 
         /// Create a correct behavior onboarding.
diff --git a/Sources/OnboardingKit/OnboardingKit.docc/OnboardingKit.md b/Sources/OnboardingKit/OnboardingKit.docc/OnboardingKit.md
@@ -55,13 +55,17 @@ OnboardingKit is available under the MIT license.
 
 - ``OnboardingFlow``
 - ``OnboardingFlowContainer``
-- ``OnboardingFlowContainerCenteredContent``
+- ``OnboardingFlowCenteredContent``
 - ``OnboardingFlowState``
 
-### Flow Views
+### Pages
 
+- ``OnboardingPage``
 - ``OnboardingPageView``
 - ``OnboardingPageViewStyle``
+
+### Slideshows
+
 - ``OnboardingSlideshow``
 - ``OnboardingSlideshowConfiguration``
 - ``OnboardingSlideshowProgressView`` 
diff --git a/Sources/OnboardingKit/Pages/OnboardingPage.swift b/Sources/OnboardingKit/Pages/OnboardingPage.swift
@@ -1,5 +1,5 @@
 //
-//  OnboardingFlow+PageInfo.swift
+//  OnboardingPage.swift
 //  OnboardingKit
 //
 //  Created by Daniel Saidi on 2022-09-05.
@@ -10,7 +10,7 @@ import Foundation
 import SwiftUI
 
 /// This type defines page info for an onboarding page.
-public struct OnboardingFlowPage<PageModel>: OnboardingFlow.PageInfoProvider {
+public struct OnboardingPage<PageModel>: OnboardingFlow.PageInfoProvider {
 
     /// Create a page info value.
     ///
@@ -50,7 +50,7 @@ public struct OnboardingFlowPage<PageModel>: OnboardingFlow.PageInfoProvider {
     public let totalPageCount: Int
 }
 
-public extension OnboardingFlowPage {
+public extension OnboardingPage {
 
 /// Whether this page is the first page.
 var isFirstPage: Bool {
diff --git a/Sources/OnboardingKit/Pages/OnboardingPageView.swift b/Sources/OnboardingKit/Pages/OnboardingPageView.swift
@@ -15,8 +15,8 @@ import PageView
 /// This view can be used to show a collection of onboarding pages, with support
 /// for navigating with swipes, arrow keys, and edge taps.
 ///
-/// This view can be styled with ``SwiftUI/View/onboardingPageViewStyle(_:)``.
-public struct OnboardingPageView<PageModel, Page: View>: View {
+/// This view can be styled with ``SwiftUICore/View/onboardingPageViewStyle(_:)``.
+public struct OnboardingPageView<Model, Page: View>: View {
 
     /// Create an onboarding page view.
     ///
@@ -25,7 +25,7 @@ public struct OnboardingPageView<PageModel, Page: View>: View {
     ///   - pageIndex: The current page index.
     ///   - content: A page builder function.
     public init(
-        pages: [PageModel],
+        pages: [Model],
         pageIndex: Binding<Int>,
         @ViewBuilder content: @escaping PageBuilder
     ) {
@@ -34,10 +34,10 @@ public struct OnboardingPageView<PageModel, Page: View>: View {
         self.content = content
     }
 
-    public typealias PageInfo = OnboardingFlowPage<PageModel>
+    public typealias PageInfo = OnboardingPage<Model>
     public typealias PageBuilder = (PageInfo) -> Page
 
-    private let pages: [PageModel]
+    private let pages: [Model]
     private let content: PageBuilder
 
     @Binding
@@ -79,7 +79,7 @@ private extension OnboardingPageView {
     }
 
     func content(
-        for info: EnumeratedSequence<[PageModel]>.Element
+        for info: EnumeratedSequence<[Model]>.Element
     ) -> some View {
         content(
             .init(
diff --git a/Sources/OnboardingKit/Pages/OnboardingPageViewStyle.swift b/Sources/OnboardingKit/Pages/OnboardingPageViewStyle.swift
@@ -10,7 +10,7 @@ import SwiftUI
 
 /// This style can style ``OnboardingPageView`` views.
 ///
-/// This style can be applied with ``SwiftUI/View/onboardingPageViewStyle(_:)``.
+/// This style can be applied with ``SwiftUICore/View/onboardingPageViewStyle(_:)``.
 public struct OnboardingPageViewStyle {
 
     /// Create an onboarding page view style.
diff --git a/Sources/OnboardingKit/Previews/PreviewPage.swift b/Sources/OnboardingKit/Previews/PreviewPage.swift
@@ -10,7 +10,7 @@ import SwiftUI
 
 struct PreviewPage: View {
 
-    let info: OnboardingFlowPage<Int>
+    let info: OnboardingPage<Int>
 
     var body: some View {
         VStack(spacing: 30) {
diff --git a/Sources/OnboardingKit/Slideshows/OnboardingSlideshow.swift b/Sources/OnboardingKit/Slideshows/OnboardingSlideshow.swift
@@ -16,15 +16,14 @@ import PageView
 /// This slideshow slides through a set of onboarding slide views, with support for
 /// navigating with swipes, arrow keys, and edge taps.
 ///
-/// This view can be styled with ``SwiftUI/View/onboardingSlideshowStyle(_:)``.
-public struct OnboardingSlideshow<PageModel, Page: View>: View {
+/// This view can be styled with ``SwiftUICore/View/onboardingSlideshowStyle(_:)``.
+public struct OnboardingSlideshow<PageModel, PageView: View>: View {
 
     /// Create an onboarding slideshow.
     ///
     /// - Parameters:
     ///   - pages: The pages to present.
     ///   - pageIndex: The current page index.
-    ///   - config: The configuration to use, by default `.standard`.
     ///   - onStoryCompleted: The action to trigger at the end.
     ///   - content: A page content builder function.
     public init(
@@ -39,8 +38,8 @@ public struct OnboardingSlideshow<PageModel, Page: View>: View {
         self.content = content
     }
 
-    public typealias PageInfo = OnboardingFlowPage<PageModel>
-    public typealias PageBuilder = (PageInfo) -> Page
+    public typealias Page = OnboardingPage<PageModel>
+    public typealias PageBuilder = (Page) -> PageView
 
     private let pages: [PageModel]
     private let onStoryCompleted: () -> Void
@@ -92,7 +91,7 @@ private struct _OnboardingSlideshow<PageModel, Content: View>: View {
         .autoconnect()
     }
 
-    typealias PageInfo = OnboardingFlowPage<PageModel>
+    typealias PageInfo = OnboardingPage<PageModel>
     typealias ContentBuilder = (PageInfo) -> Content
 
     let pages: [PageModel]
diff --git a/Sources/OnboardingKit/Slideshows/OnboardingSlideshowConfiguration.swift b/Sources/OnboardingKit/Slideshows/OnboardingSlideshowConfiguration.swift
@@ -10,7 +10,7 @@ import SwiftUI
 
 /// This type can configure ``OnboardingSlideshow`` views.
 ///
-/// This type can be applied with ``SwiftUI/View/onboardingSlideshowConfiguration(_:)``.
+/// This type can be applied with ``SwiftUICore/View/onboardingSlideshowConfiguration(_:)``.
 public struct OnboardingSlideshowConfiguration {
 
     /// Create an onboarding slideshow configuration.
diff --git a/Sources/OnboardingKit/Slideshows/OnboardingSlideshowProgressView.swift b/Sources/OnboardingKit/Slideshows/OnboardingSlideshowProgressView.swift
diff --git a/Sources/OnboardingKit/Slideshows/OnboardingSlideshowStyle.swift b/Sources/OnboardingKit/Slideshows/OnboardingSlideshowStyle.swift
@@ -10,7 +10,7 @@ import SwiftUI
 
 /// This style can style ``OnboardingSlideshow`` views.
 ///
-/// This style can be applied with ``SwiftUI/View/onboardingSlideshowStyle(_:)``.
+/// This style can be applied with ``SwiftUICore/View/onboardingSlideshowStyle(_:)``.
 public struct OnboardingSlideshowStyle {
 
     /// Create an onboarding slideshow style.
diff --git a/Tests/OnboardingKitTests/Views/OnboardingFlowPageTests.swift b/Tests/OnboardingKitTests/Views/OnboardingFlowPageTests.swift
@@ -1,5 +1,5 @@
 //
-//  OnboardingFlowPageTests.swift
+//  OnboardingPageTests.swift
 //  OnboardingKitTests
 //
 //  Created by Daniel Saidi on 2018-06-18.
@@ -9,9 +9,9 @@
 import OnboardingKit
 import XCTest
 
-final class OnboardingFlowPageTests: XCTestCase {
+final class OnboardingPageTests: XCTestCase {
 
-    typealias Page = OnboardingFlowPage
+    typealias Page = OnboardingPage
 
     func test_isFirstPage_returnsCorrectResult() {
         let obj1 = Page(

Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ public struct OnboardingFlowContainer<Page, Content: View, Buttons: View>: View`
`66`	`66`	`}`
`67`	`67`
`68`	`68`	`/// This view can wrap any content view and applies an alignment and max width.`
`69`		`-public struct OnboardingFlowContainerCenteredContent<Content: View>: View {`
	`69`	`+public struct OnboardingFlowCenteredContent<Content: View>: View {`
`70`	`70`
`71`	`71`	`/// Create a centered onboarding screen content view.`
`72`	`72`	`///`
`@@ -149,7 +149,7 @@ private extension OnboardingFlowContainer {`
`149`	`149`	`pages: pages,`
`150`	`150`	`pageIndex: $pageIndex`
`151`	`151`	`) { info in`
`152`		`- OnboardingFlowContainerCenteredContent {`
	`152`	`+ OnboardingFlowCenteredContent {`
`153`	`153`	`Text("Page \(info.pageIndex)")`
`154`	`154`	`}`
`155`	`155`	`}`