OnboardingKit icon indicating copy to clipboard operation
OnboardingKit copied to clipboard

SwiftUI library for handling onboarding

OnboardingKit

Swift Package Manager GitHub stars GitHub forks GitHub contributors Pull Requests Badge Issues Badge

Description

OnboardingKit is a SwiftUI library for handling onboarding.


Requirements

  • iOS: 17.0 or later.
  • macOS: 14.0 or later.

Installation

You can install OnboardingKit using the Swift Package Manager.

  1. In Xcode, select "File" > "Add Package Dependencies".
  2. Copy & paste the following into the "Search or Enter Package URL" search bar.
https://github.com/JamesSedlacek/OnboardingKit.git
  1. Xcode will fetch the repository & the "OnboardingKit" library will be added to your project.

Usage

  1. Create an Onboarding Configuration.
import OnboardingKit
import SwiftUI

extension OnboardingConfiguration {
    static let prod = Self.init(privacyUrlString: "",
                                accentColor: .green,
                                features: [])
}

  1. Add .showOnboardingIfNeeded() to the root view in your project.
import OnboardingKit
import SwiftUI

@main
struct ExampleApp: App {
    var body: some Scene {
        ContentView()
            .showOnboardingIfNeeded(using: .prod)
    }
}

Author

James Sedlacek, find me on X/Twitter or LinkedIn