https://github.com/mlbonniec/onboardingkit

Apple TipKit like architecture onboarding view Swift Package.
https://github.com/mlbonniec/onboardingkit

ios library onboarding swift swiftui tipkit

Last synced: 2 months ago
JSON representation

Apple TipKit like architecture onboarding view Swift Package.

• Host: GitHub
• URL: https://github.com/mlbonniec/onboardingkit
• Owner: mlbonniec
• License: mit
• Created: 2023-11-15T13:35:25.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2024-05-20T22:24:58.000Z (8 months ago)
• Last Synced: 2024-05-21T00:51:32.080Z (8 months ago)
• Topics: ios, library, onboarding, swift, swiftui, tipkit
• Language: Swift
• Homepage:
• Size: 2.06 MB
• Stars: 20
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Cover](https://github.com/mlbonniec/OnBoardingKit/assets/29955402/db543528-b91e-4d28-ab30-e7a9e92272de)

*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](https://github.com/lascic/uionboarding) Swift Package.

OnBoardingKit behavior is inspired by the new [TipKit](https://developer.apple.com/documentation/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`.

```swift

struct OnBoardingDemo: OnBoarding {

  // …

}

Text("Hello, World!")

  .presentOnBoarding(OnBoardingDemo(), action: {})

```

# Documentation

You can find the full documentation on the [wiki](https://github.com/mlbonniec/OnBoardingKit/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](./LICENSE) for more details.