OnboardFlow
示例
要运行示例项目,请克隆该仓库,然后首先从 Example 目录运行 pod install
。
需求
安装
OnboardFlow 通过 CocoaPods 提供。要安装它,只需将以下行添加到您的 Podfile 中
pod 'OnboardFlow'
如何使用
创建 onboarding 控制器
别忘了导入 OnboardFlow
,然后你可以直接
let onboardingController = OnboardFlowViewController()
// Use the previously created ViewController
onboardingController.controllers = [ViewController()]
如果你想显示 onboarding 控制器底部的点
onboardingController.showPageControl = true // default is false
默认情况下,OnboardFlowViewController
不允许滑动切换页面,但如果你想
onboardingController.enableSwipe = true // default is false
OnboardFlowViewController
还有一个 onboardingDelegate
,它可以在 onboarding 应该结束时非常有用
onboardingController.onboardingDelegate = self
然后你可以在你主要的控制器上创建一个扩展
extension MainViewController: OnboardFlowViewControllerDelegate {
func finishOnboarding() {
/**
This will be called once the last controller call `done`
*/
}
}
这样就完成了,你可以根据自己的意愿显示该控制器。
创建 onboarding 步骤的控制器
OnboardFlowViewController
中的每一页都必须是一个 UIViewController
,其中添加了 OnboardFlowCompletableController
协议和必需的 delegate
。
import UIKit
import OnboardFlow
class ViewController: UIViewController, OnboardFlowCompletableController {
var completableDelegate: OnboardFlowCompletableControllerDelegate?
override func viewDidLoad() {
super.viewDidLoad()
}
}
如果没有允许滑动,为了让 OnboardFlowViewController
知道你已完成该控制器,调用 delegate
的 done
方法,以便 OnboardFlowViewController
继续执行
self.completableDelegate?.done(controller: self)
完成 onboarding 流程
一旦到达流程的末尾,让该控制器调用其 OnboardFlowCompletableControllerDelegate
的 done
方法。
作者
johnoppenheimer, [email protected]
许可
OnboardFlow 在 MIT 许可下可用。有关更多信息,请参阅 LICENSE 文件。