Customisable user onboarding for your iOS app
Clone or download
Latest commit 94cc0aa Oct 24, 2018

README.md

OnboardKit

Swift 4.2 Version License Carthage compatible Twitter

OnboardKit

Customizable user onboarding for your UIKit app in Swift

Requirements

  • Swift 4.2
  • Xcode 10
  • iOS 11.0+

Installation

Carthage

github "NikolaKirev/OnboardKit"

CocoaPods

use_frameworks!

# Latest release in CocoaPods
pod 'OnboardKit'

# Get the latest on master
pod 'OnboardKit', :git => 'https://github.com/NikolaKirev/OnboardKit.git', :branch => 'master'

Don't forget to import OnboardKit in the file you intend to use it.

Usage

  1. Create and populate a bunch of OnboardPage instances
let page = OnboardPage(title: "Welcome to OnboardKit",
                       imageName: "Onboarding1",
                       description: "OnboardKit helps you add onboarding to your iOS app")
  1. Create an OnboardViewController
let onboardingViewController = OnboardViewController(pageItems: [pageOne, ...]])
  1. Present the view controller
onboardingVC.presentFrom(self, animated: true)

(use this convenience method to make sure you present it modally)

Customization

Custom examples

You can customize the look of your onboarding by changing the default colors.

AppearanceConfiguration(tintColor: .orange,
                        titleColor: .red,
                        textColor: .white,
                        backgroundColor: .black,
                        titleFont: UIFont.boldSystemFont(ofSize: 32.0),
                        textFont: UIFont.boldSystemFont(ofSize: 17.0))

Author

Nikola Kirev

License

OnboardKit is available under the MIT license. See the LICENSE file for more info.