<p align="center"> <img src="Resources/Icon-Badge.png" alt="Project Icon" width="250" /> </p> <p align="center"> <img src="https://img.shields.io/github/v/release/danielsaidi/OnboardingKit?color=%2300550&sort=semver" alt="Version" /> <img src="https://img.shields.io/badge/Swift-6.1-orange.svg" alt="Swift 6.1" /> <a href="https://danielsaidi.github.io/OnboardingKit"><img src="https://img.shields.io/badge/documentation-web-blue.svg" alt="Documentation" /></a> <a href="https://github.com/danielsaidi/OnboardingKit/blob/master/LICENSE"><img src="https://img.shields.io/github/license/danielsaidi/OnboardingKit" alt="MIT License" /></a> </p>

OnboardingKit

OnboardingKit is SwiftUI SDK that helps you create amazing onboarding experiences on all major Apple platforms.

<p align="center"> <img src="https://github.com/danielsaidi/OnboardingKit/releases/download/8.2.0/OnboardingKit-Demo.gif" width=350 /> </p>

OnboardingKit has different Onboarding types, powerful onboarding view components like OnboardingPageView and OnboardingSlideshow, an OnboardingScreen that can wrap any onboarding flow, and much more.

Installation

OnboardingKit can be installed with the Swift Package Manager:

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

Getting started

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:

• Onboarding is presented right away, and only once.
• Onboarding.Conditional is presented when a certain condition returns true.
• Onboarding.CorrectBehavior is presented when a user is not behaving as intended.
• Onboarding.Delayed is presented after a certain number of presentation attempts.

OnboardingKit has various onboarding flows, and convenient ways to handle page state, for instance:

• An OnboardingPageView can be used to present manually scrolling pages.
• An OnboardingSlideshow can be used to present an automatically progressing slideshow.
• An OnboardingIntroScreen can be used to present a welcome screen on first app launch.

See the online getting started guide for more information.

Documentation

The online documentation has more information, articles, code examples, etc.

Demo Application

The Demo folder has an app that lets you explore the library.

Support My Work

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.

Contact

Feel free to reach out if you have questions or if you want to contribute in any way:

• Website: danielsaidi.com
• E-mail: daniel.saidi@gmail.com
• Bluesky: @danielsaidi@bsky.social
• Mastodon: @danielsaidi@mastodon.social

License

OnboardingKit is available under the MIT license. See the LICENSE file for more info.