mlbonniec / onboardingkit

Apple TipKit like architecture onboarding view Swift Package.

All of these views are original Apple views, recreated using the library.

OnBoardingKit

OnBoardingKit is a configurable on boarding screen view for SwiftUI. It's inspired by on boarding views on Apple native apps, and UIOnboarding Swift Package.

OnBoardingKit behavior is inspired by the new TipKit library from Apple.

Note

OnBoardingKit is available on iOS 15 and later.

Quick Start

To create an on boarding view, you simply have to create a struct conforming to the OnBoarding protocol. Then, it's very easy to display it with the OnBoardingView.

struct OnBoardingDemo: OnBoarding {
  // …
}

Text("Hello, World!")
  .presentOnBoarding(OnBoardingDemo(), action: {})

Documentation

You can find the full documentation on the wiki.

License

This project is licensed under MIT.

Important

If you're using this project into yours, you must incluse the license and copyright notice

See LICENSE for more details.

onboardingkit's Issues

Banner aspect ratio image is not responsive

The image is distorded when using a banner image style with a non-square aspect ratio (such as 2)

Create a modifier to present if needed

Description

In addition to the OnBoardingView, a modifier could be created to present the view only if needed.
It'll show the view only if it has never been showed to the user.

Example

The modifier could be used like below.

var body: some View {
  ContentView()
    .presentOnBoardingIfNeeded(SomeOnBoarding(), animate: true)
}

Create multiple modifiers

Some modifiers could be created to affect the OnBoardingView view.

• setVerticalAlignment(.leading | .center | .trailing)
• enableAnimations()

Normal software license

Please use a license like MIT or BSD - you can find ones of these that also require attribution. CC isn't well established for software and many orgs cannot use

Title does not wrap when too long

Description

When the title is long, the Text element is not wrapping, and the text stays on one line.

Screenshots

Add animations on OnBoardingView

Some animations can be added

• Image
• Features
• Notice