52

GitHub - NikolaKirev/OnboardKit: Customisable user onboarding for your iOS app

 5 years ago
source link: https://github.com/NikolaKirev/OnboardKit
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.

README.md

OnboardKit

Swift 4.2 Version License Carthage compatible Twitter

OnboardKit

Customizable user onboarding for your UIKit app in Swift

68747470733a2f2f6d656469612e67697068792e636f6d2f6d656469612f336f686a5638674447336b453564625753492f67697068792e676966

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.


report

Recommend

About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK