https://github.com/jamessedlacek/onboardingkit

SwiftUI library for handling onboarding
https://github.com/jamessedlacek/onboardingkit

onboarding onboarding-screen swift swift-package-manager swiftui swiftui-components

Last synced: 6 months ago
JSON representation

SwiftUI library for handling onboarding

• Host: GitHub
• URL: https://github.com/jamessedlacek/onboardingkit
• Owner: JamesSedlacek
• License: mit
• Created: 2023-12-31T18:59:42.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2025-03-11T00:40:39.000Z (7 months ago)
• Last Synced: 2025-03-28T14:06:13.926Z (6 months ago)
• Topics: onboarding, onboarding-screen, swift, swift-package-manager, swiftui, swiftui-components
• Language: Swift
• Homepage:
• Size: 715 KB
• Stars: 215
• Watchers: 3
• Forks: 15
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# OnboardingKit

[![Swift Package Manager](https://img.shields.io/badge/Swift%20Package%20Manager-compatible-brightgreen.svg)](https://github.com/apple/swift-package-manager)

[![GitHub stars](https://img.shields.io/github/stars/JamesSedlacek/OnboardingKit.svg)](https://github.com/JamesSedlacek/OnboardingKit/stargazers)

[![GitHub forks](https://img.shields.io/github/forks/JamesSedlacek/OnboardingKit.svg?color=blue)](https://github.com/JamesSedlacek/OnboardingKit/network)

[![GitHub contributors](https://img.shields.io/github/contributors/JamesSedlacek/OnboardingKit.svg?color=blue)](https://github.com/JamesSedlacek/OnboardingKit/network)







  



## Description

`OnboardingKit` is a SwiftUI library for handling onboarding. 





## Requirements

- **iOS**: 17.0 or later.

- **macOS**: 14.0 or later.




## Installation

You can install `OnboardingKit` using the Swift Package Manager.

1. In Xcode, select "File" > "Add Package Dependencies".

2. Copy & paste the following into the "Search or Enter Package URL" search bar.

```

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

```

4. Xcode will fetch the repository & the "OnboardingKit" library will be added to your project.




## Supported Languages

This project currently supports the following languages:

- **English (en)**

- **German (de)**




## Usage

1. Create an `Onboarding Configuration`.

```swift

import OnboardingKit

import SwiftUI

extension OnboardingConfiguration {

    static let prod = Self.init(privacyUrlString: "",

                                accentColor: .green,

                                features: [])

}

```




2. Add `.showOnboardingIfNeeded()` to the root view in your project.

```swift

import OnboardingKit

import SwiftUI

@main

struct ExampleApp: App {

    var body: some Scene {

        ContentView()

            .showOnboardingIfNeeded(using: .prod)

    }

}

```




## Author

James Sedlacek, find me on [X/Twitter](https://twitter.com/jsedlacekjr) or [LinkedIn](https://www.linkedin.com/in/jamessedlacekjr/)