OnboardingKit is SwiftUI SDK that helps you create amazing onboarding experiences on all major Apple platforms.
OnboardingKit has different Onboarding types, powerful onboarding view components like OnboardingPageView and OnboardingSlideshow, an OnboardingScreen that can wrap any onboarding flow, and much more.
OnboardingKit can be installed with the Swift Package Manager:
https://github.com/danielsaidi/OnboardingKit.git
You can become a sponsor to help me dedicate more time on my various open-source tools. Every contribution, no matter the size, makes a real difference in keeping these tools free and actively developed.
OnboardingKit has various onboarding types and views that can be used to tailor an app's onboarding behavior.
The various Onboarding types defines unique onboarding experience behaviors, for instance:
Onboardingis presented right away, and only once.ConditionalOnboardingis presented when a certain condition returnstrue.CorrectBehaviorOnboardingis presented when a user is not behaving as intended.DelayedOnboardingis presented after a certain number of presentation attempts.
OnboardingKit has views that can be used to present onboarding flows, as well as ways to handle page state.
- An
OnboardingPageViewcan be used to show a set of pages in a horizontal page view. - An
OnboardingSlideshowcan be used to show a set of pages in a slideshow that auto-slides forward. - An
OnboardingScreencan be used to wrap any onboarding flow in a frame with additional controls. - An
OnboardingPageStatecan be used to manage page state for all views.
All views support all major Apple platforms (iOS, macOS, tvOS, watchOS & visionOS).
See the online getting started guide for more information.
The online documentation has more information, articles, code examples, etc.
The Demo folder has an app that lets you explore the library.
Feel free to reach out if you have questions or if you want to contribute in any way:
- Website: danielsaidi.com
- E-mail: [email protected]
- Bluesky: @[email protected]
- Mastodon: @[email protected]
OnboardingKit is available under the MIT license. See the LICENSE file for more info.