关于 OnboardingKit

OnboardingKit 是一个 Swift SDK，可以帮助你用 Swift 和 SwiftUI 创建引导体验。

OnboardingKit 有不同的引导类型。标准的 Onboarding 会立即显示，并且只显示一次，而其他类型可能需要多次尝试呈现，一定数量的“不正确”操作等等。

OnboardingKit 还具有本地化实用程序，如 LocalizedOnboarding，以及 UI 组件，如 OnboardingPageView 和 OnboardingSlideshow。

安装

OnboardingKit 可以使用 Swift Package Manager 安装

https://github.com/danielsaidi/OnboardingKit.git

入门

在 OnboardingKit 中，一个 Onboarding 决定了引导体验的状态和行为。您可以使用各种引导类型来获得不同的行为。

下面的代码展示了如何使用标准的引导来呈现首次启动引导表单

import OnboardingKit
import SwiftUI

struct ContentView: View {

    @State
    private var isOnboardingPresented: Bool
    
    private let onboarding = Onboarding(id: "welcome") 

    var body: some View {
        Text("Hello, world")
            .task(tryPresentOnboarding)
            .sheet(isPresented: $isOnboardingPresented) {
                ...
            }
    }
    
    func tryPresentOnboarding() {
        onboarding.tryPresent { 
            isOnboardingPresented = true
        }
    }
}

引导将遵守其自身的规则并记住任何先前的呈现，因此只有在引导有意义时，tryPresent 才会触发。

有关更多信息，请参阅在线入门指南。

文档

在线文档包含更多信息、文章、代码示例等。

演示应用程序

Demo 文件夹包含一个让你探索该库的应用程序。

支持我的工作

你可以在 GitHub Sponsors 上赞助我，或者联系我以获得付费支持，以帮助支持我的开源项目。

你的支持使我能够投入更多精力到这些项目中，使它们尽可能做到最好。

联系方式

如果你有任何问题或想以任何方式贡献，请随时联系我

许可

OnboardingKit 在 MIT 许可下可用。有关更多信息，请参阅 LICENSE 文件。