Rename slide view types

Author: danielsaidi

RELEASE_NOTES.md

@@ -1,6 +1,15 @@
 # Release Notes
 
 
+## 6.1
+
+### 🗑 Deprecations
+
+* `TutorialSlideView` has been renamed to `TutorialPageView`.
+* `TutorialSlideViewStyle` has been renamed to `TutorialPageViewStyle`.
+
+
+
 ## 6.0
 
 Tutti is renamed to OnboardingKit.

Sources/OnboardingKit/OnboardingKit.docc/OnboardingKit.md

@@ -76,5 +76,5 @@ OnboardingKit is available under the MIT license.
 
 ### UI
 
-- ``TutorialSlideView``
-- ``TutorialSlideViewStyle``
+- ``TutorialPageView``
+- ``TutorialPageViewStyle``

Sources/OnboardingKit/Tutorials/LocalizedTutorial.swift

@@ -56,7 +56,8 @@ open class LocalizedTutorial: Tutorial<TutorialPage> {
         resourceName: ResourceNameResolver = LocalizedTutorial.resourceName,
         resourceKeySeparator: ResourceKeySeparator = ".",
         pageResolver: @escaping (TutorialId, PageIndex, ResourceNameResolver, ResourceKeySeparator) -> TutorialPage,
-        translator: @escaping Translator = { NSLocalizedString($0, comment: "") }) {
+        translator: @escaping Translator = { NSLocalizedString($0, comment: "") }
+    ) {
         var index = 0
         var pages = [TutorialPage]()
         var titleKey = resourceName(id, index, pageIndicationKey, resourceKeySeparator)
@@ -93,7 +94,8 @@ public extension LocalizedTutorial {
         pageIndicationKey: String = "title",
         resourceName: ResourceNameResolver = LocalizedTutorial.resourceName,
         resourceKeySeparator: ResourceKeySeparator = ".",
-        translator: @escaping Translator = { NSLocalizedString($0, comment: "") }) {
+        translator: @escaping Translator = { NSLocalizedString($0, comment: "") }
+    ) {
         self.init(
             id: id,
             pageIndicationKey: pageIndicationKey,
@@ -114,7 +116,8 @@ public extension LocalizedTutorial {
         for tutorialId: TutorialId,
         at pageIndex: PageIndex,
         resourceKey: ResourceKey,
-        resourceKeySeparator: ResourceKeySeparator) -> ResourceName {
+        resourceKeySeparator: ResourceKeySeparator
+    ) -> ResourceName {
         let key = resourceKey.trimmingCharacters(in: .whitespaces)
         var segments = ["tutorial", tutorialId, "\(pageIndex)"]
         if key.count > 0 { segments.append(key) }
@@ -129,7 +132,8 @@ public extension LocalizedTutorial {
         for tutorialId: TutorialId,
         at pageIndex: PageIndex,
         resourceName: ResourceNameResolver = LocalizedTutorial.resourceName,
-        resourceKeySeparator: ResourceKeySeparator) -> TutorialPage {
+        resourceKeySeparator: ResourceKeySeparator
+    ) -> TutorialPage {
         let separator = resourceKeySeparator
         let titleKey = resourceName(tutorialId, pageIndex, "title", separator)
         let title = NSLocalizedString(titleKey, comment: "")

Sources/OnboardingKit/Tutorials/TutorialPageInfo.swift

@@ -10,6 +10,8 @@ import Foundation
 
 /**
  This type can be used to provide info about a tutorial page.
+ 
+ 
 
  This struct can be used in various scenarios, to be able to
  extend the provided page information later without changing

Sources/OnboardingKit/UI/TutorialSlideView.swift renamed to Sources/OnboardingKit/UI/TutorialPageView.swift

@@ -1,5 +1,5 @@
 //
-//  TutorialSlideView.swift
+//  TutorialPageView.swift
 //  OnboardingKit
 //
 //  Created by Daniel Saidi on 2022-09-04.
@@ -12,12 +12,12 @@ import UIKit
 
 /**
  This view renders tutorial pages in a `TabView` with a page
- style applied, which lets the user swipe throught the pages.
+ style applied, which lets the user swipe through pages.
 
  This view is currently only available on `iOS`.
  */
 @available(iOS 14.0, *)
-public struct TutorialSlideView<PageType: TutorialPage, PageViewType: View>: View {
+public struct TutorialPageView<PageType: TutorialPage, PageViewType: View>: View {
 
     /**
      Create a tutorial page flow that renders tutorial pages
@@ -26,13 +26,13 @@ public struct TutorialSlideView<PageType: TutorialPage, PageViewType: View>: Vie
      - Parameters:
        - tutorial: The tutorial to present.
        - pageIndex: The current page.
-       - style: The style to apply, by default ``TutorialSlideViewStyle/standard``.
+       - style: The style to apply, by default ``TutorialPageViewStyle/standard``.
        - pageView: A function used to build a view for each page.
      */
     public init(
         tutorial: Tutorial<PageType>,
         pageIndex: Binding<Int>,
-        style: TutorialSlideViewStyle = .standard,
+        style: TutorialPageViewStyle = .standard,
         @ViewBuilder pageView: @escaping PageViewBuilder
     ) {
         self.tutorial = tutorial
@@ -65,7 +65,7 @@ public struct TutorialSlideView<PageType: TutorialPage, PageViewType: View>: Vie
 }
 
 @available(iOS 15.0, *)
-struct TutorialSlideView_Previews: PreviewProvider {
+struct TutorialPageView_Previews: PreviewProvider {
 
     struct Preview: View {
 
@@ -83,7 +83,7 @@ struct TutorialSlideView_Previews: PreviewProvider {
         ])
 
         var body: some View {
-            TutorialSlideView(
+            TutorialPageView(
                 tutorial: tutorial,
                 pageIndex: $pageIndex
             ) { page, info in

Sources/OnboardingKit/UI/TutorialSlideViewStyle.swift renamed to Sources/OnboardingKit/UI/TutorialPageViewStyle.swift

@@ -1,5 +1,5 @@
 //
-//  TutorialSlideViewStyle.swift
+//  TutorialPageViewStyle.swift
 //  OnboardingKit
 //
 //  Created by Daniel Saidi on 2022-09-04.
@@ -9,11 +9,11 @@
 import SwiftUI
 
 /**
- This style can be used to style ``TutorialSlideView`` views
+ This style can be used to style ``TutorialPageView`` views
  with custom colors.
  */
 @available(iOS 13.0, *)
-public struct TutorialSlideViewStyle {
+public struct TutorialPageViewStyle {
 
     /**
      Create a tutorial slide view style.
@@ -38,13 +38,13 @@ public struct TutorialSlideViewStyle {
 }
 
 @available(iOS 13.0, *)
-public extension TutorialSlideViewStyle {
+public extension TutorialPageViewStyle {
 
     /**
      This standard style applies a primary tint color to the
      indicators, with less opacity to non-current indicators.
      */
-    static var standard = TutorialSlideViewStyle(
+    static var standard = TutorialPageViewStyle(
         pageIndicatorTintColor: .primary.opacity(0.3),
         currentPageIndicatorTintColor: .primary)
 }

Sources/OnboardingKit/_Deprecated/TutorialSlideView.swift

@@ -0,0 +1,11 @@
+#if os(iOS)
+import Foundation
+
+@available(iOS 14.0, *)
+@available(*, deprecated, renamed: "TutorialPageView")
+public typealias TutorialSlideView = TutorialPageView
+
+@available(iOS 14.0, *)
+@available(*, deprecated, renamed: "TutorialPageViewStyle")
+public typealias TutorialSlideViewStyle = TutorialPageViewStyle
+#endif