OnboardingKit is a SwiftUI library for handling onboarding.
- iOS: 17.0 or later.
- macOS: 14.0 or later.
You can install OnboardingKit using the Swift Package Manager.
- In Xcode, select "File" > "Add Package Dependencies".
- Copy & paste the following into the "Search or Enter Package URL" search bar.
https://github.com/JamesSedlacek/OnboardingKit.git
- Xcode will fetch the repository & the "OnboardingKit" library will be added to your project.
- Create an
Onboarding Configuration.
import OnboardingKit
import SwiftUI
extension OnboardingConfiguration {
static let prod = Self.init(privacyUrlString: "",
accentColor: .green,
features: [])
}- 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)
}
}James Sedlacek, find me on X/Twitter or LinkedIn
OnboardingKit is available under the MIT license.
Copyright (c) 2023 James Sedlacek
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.