Contents

danielsaidi/OnboardingKit

Create amazing onboarding experiences in SwiftUI.

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][Getting-Started] for more information.

Documentation

The online [documentation][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][Sponsors] to help me dedicate more time on my various [open-source tools][OpenSource]. 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][Website]
  • E-mail: [daniel.saidi@gmail.com][Email]
  • Bluesky: [@danielsaidi@bsky.social][Bluesky]
  • Mastodon: [@danielsaidi@mastodon.social][Mastodon]

License

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

[Email]: mailto:daniel.saidi@gmail.com [Website]: https://www.danielsaidi.com [GitHub]: https://www.github.com/danielsaidi [OpenSource]: https://danielsaidi.com/opensource [Sponsors]: https://github.com/sponsors/danielsaidi

[Bluesky]: https://bsky.app/profile/danielsaidi.bsky.social [Mastodon]: https://mastodon.social/@danielsaidi [Twitter]: https://twitter.com/danielsaidi

[Documentation]: https://danielsaidi.github.io/OnboardingKit [Getting-Started]: https://danielsaidi.github.io/OnboardingKit/documentation/onboardingkit/getting-started [License]: https://github.com/danielsaidi/OnboardingKit/blob/master/LICENSE

Package Metadata

Repository: danielsaidi/OnboardingKit

Homepage: https://danielsaidi.com/opensource

Stars: 1192

Forks: 49

Open issues: 1

Default branch: main

Primary language: swift

License: MIT

Topics: cocoapods, hint, ios, macos, onboarding, swift, swiftui, tutorial, tvos, visionos, watchos

README: README.md