Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/0xwdg/onboardingkit
OnboardingKit is a SwiftUI package that helps you create onboarding experiences for your app. It provides a set of views that you can use to create a welcome screen, a what's new screen, and a set of onboarding screens.
https://github.com/0xwdg/onboardingkit
0xwdg hacktoberfest onboarding onboardingkit spm swift swiftlang swiftui
Last synced: 24 days ago
JSON representation
OnboardingKit is a SwiftUI package that helps you create onboarding experiences for your app. It provides a set of views that you can use to create a welcome screen, a what's new screen, and a set of onboarding screens.
- Host: GitHub
- URL: https://github.com/0xwdg/onboardingkit
- Owner: 0xWDG
- License: mit
- Created: 2024-06-21T13:09:32.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-09-21T15:17:22.000Z (2 months ago)
- Last Synced: 2024-10-15T13:12:04.235Z (about 1 month ago)
- Topics: 0xwdg, hacktoberfest, onboarding, onboardingkit, spm, swift, swiftlang, swiftui
- Language: Swift
- Homepage: https://0xwdg.github.io/OnboardingKit/
- Size: 1.9 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# OnboardingKit
OnboardingKit is a SwiftUI package that helps you create onboarding experiences for your app. It provides a set of views that you can use to create a welcome screen, a what's new screen, and a set of onboarding screens. You can customize the views by providing your own content and colors. OnboardingKit also provides a helper class that you can use to get information about your app, such as the app name, version number, and build number.
[](https://swiftpackageindex.com/0xWDG/OnboardingKit)
[](https://swiftpackageindex.com/0xWDG/OnboardingKit)
[](https://swift.org/package-manager)
## Requirements
- Swift 5.9+ (Xcode 15+)
- iOS 13+, macOS 10.15+
## Installation
Install using Swift Package Manager
```swift
dependencies: [
.package(url: "https://github.com/0xWDG/OnboardingKit.git", branch: "main"),
],
targets: [
.target(name: "MyTarget", dependencies: [
.product(name: "OnboardingKit", package: "OnboardingKit"),
]),
]
```
And import it:
```swift
import OnboardingKit
```
## Welcome View Usage
```swift
import OnboardingKit
struct TabbarView: View {
@State
private var showWelcomeScreen = {
if UserDefaults.standard.bool(forKey: "hasSeenIntroduction") {
return false
}
return true
}()
private var features: [WelcomeCell] = [
WelcomeCell(
image: "star",
title: "Welcome",
subtitle: "To %APP_NAME%"
)
]
var body: some View {
TabView {
// Your tabview Code.
}
.sheet(isPresented: $showWelcomeScreen) {
WelcomeScreen(show: $showWelcomeScreen, items: features) {
UserDefaults.standard.setValue(true, forKey: "hasSeenIntroduction")
}
}
}
}
```
## What's New View Usage
```swift
import OnboardingKit
struct TabbarView: View {
@State
private var showWhatsNew = { // This is to show it only on a different version
if let dictionary = Bundle.main.infoDictionary,
let dVersion = dictionary["CFBundleShortVersionString"] as? String,
let whatsNew = UserDefaults.standard.value(forKey: "whatsNew") as? String,
whatsNew == dVersion {
return false
}
return true
}()
var body: some View {
TabView {
// Your tabview Code.
}
.sheet(isPresented: $showWhatsNew) {
WhatsNew(
show: $showWhatsNew,
text: "This is new!"
) {
if let dictionary = Bundle.main.infoDictionary,
let dVersion = dictionary["CFBundleShortVersionString"] as? String {
UserDefaults.standard.setValue(dVersion, forKey: "whatsNew")
}
}
}
}
}
```
### Dynamic replacements in text
| Key | Replacement |
| --------------- | ----------------------------------------------------------------------------------------------- |
| `%DEVICE_APPS%` | SF Device icon with apps name (if supported, only iPad and iPhone are supported at this moment) |
| `%DEVICE_TYPE%` | SF Device icon name |
| `%APP_NAME%` | The app's name |
| `%APP_VERSION%` | The App's version number |
| `%APP_BUILD%"` | The App's build number |
## Contact
We can get in touch via [Twitter/X](https://twitter.com/0xWDG), [Discord](https://discordapp.com/users/918438083861573692), [Mastodon](https://mastodon.social/@0xWDG), [Email](mailto:[email protected]), [Website](https://wesleydegroot.nl).