OnboardKit
Swift 编写的 UIKit 应用程序的本地化用户引导
需求
- Swift 5.0
- Xcode 10
- iOS 11.0+
安装
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'
别忘了在你的目标文件中 import OnboardKit
使用
- 创建并填充一系列
OnboardPage
实例
let page = OnboardPage(title: "Welcome to OnboardKit",
imageName: "Onboarding1",
description: "OnboardKit helps you add onboarding to your iOS app")
- 创建一个
OnboardViewController
let onboardingViewController = OnboardViewController(pageItems: [pageOne, ...]])
- 展示视图控制器
onboardingVC.presentFrom(self, animated: true)
(请使用此便捷方法来确保以模态方式展示)
自定义
自定义字体和颜色
您可以通过更改默认颜色和字体来自定义启动仪式的外观。
- 使用所需的自定义样式属性初始化一个
AppearanceConfiguration
实例
let appearance = AppearanceConfiguration(tintColor: .orange,
titleColor: .red,
textColor: .white,
backgroundColor: .black,
imageContentMode: .scaleAspectFit,
titleFont: UIFont.boldSystemFont(ofSize: 32.0),
textFont: UIFont.boldSystemFont(ofSize: 17.0))
- 将
AppearanceConfiguration
实例作为参数传递,用于初始化OnboardViewController
let onboardingVC = OnboardViewController(pageItems: onboardingPages,
appearanceConfiguration: appearance)
可自定义的属性列表
tintColor
- 用于着色前进和操作按钮titleColor
- 用于设置标题颜色(未指定时使用textColor
)textColor
- 用于设置描述文本颜色backgroundColor
- 用于设置视图背景颜色imageContentMode
- 用于设置页面 imageView 的内容模式titleFont
- 用于设置标题字体(也用于操作按钮字体)textFont
- 用于设置描述文本字体(也用于前进按钮字体)advanceButtonStyling
- 用于自定义前进按钮的 blockactionButtonStyling
- 用于自定义操作按钮的 block
自定义按钮
要自定义每页引导流程中的前进和操作按钮的样式,您可以使用一个 ButtonStyling
闭包。
- 创建闭包
let advanceButtonStyling: OnboardViewController.ButtonStyling = { button in
button.setTitleColor(UIColor.lightGray, for: .normal)
button.titleLabel?.font = UIFont.systemFont(ofSize: 16.0, weight: .semibold)
}
- 将闭包传递到
AppearanceConfiguration
初始化器
let appearance = OnboardViewController.AppearanceConfiguration(tintColor: .orange,
advanceButtonStyling: advanceButtonStyling)
作者
Nikola Kirev
许可
OnboardKit 在 MIT 许可证下提供。有关更多信息,请参阅 LICENSE 文件。