OSCoachmarkView 0.1.8

OSCoachmarkView 0.1.8

Aamir Anwar 维护。



Alt Text

OSCoachmarkView [开发中]

Maintainability Test Coverage Build Status Carthage compatible GitHub license

一个用于在 iOS 应用中显示教练标记的轻量级框架。纯 Swift 构建👨‍💻

Alt Text

展示

标准列表教练标记

一种紧凑型教练标记,通常用于列表视图。以下是这个样子的演示:

Alt Text

Appstore 教练标记

类似于在应用商店产品页面上使用的教练标记。

Alt Text

安装

TODO 在此处添加 Cocoapods 和 Carthage

用法

您可以使用预设的教练标记(使用OSListCoachmarkGenerator)或以相同方式创建任何自定义视图。下面是如何在教练标记中嵌入您的自定义视图的示例。

let view = CustomCoachmarkView()
let coachmarkView = OSCoachmarkView()
coachmarkView.attachedView = view

上述自定义教练标记的大小将基于自动布局(受最小/最大限制约束),以相对于视图的位置。您可以通过编写自己的逻辑来显示/隐藏教练标记,或者使用OSCoachmarkPresenter来进行操作。以下是示例代码:

let coachmarkPresenter = OSCoachmarkPresenter()
coachmarkPresenter.view = coachmarkView
coachmarkPresenter.attachToView(self.view, anchor: .bottom)

OSCoachmarkPresenter对象可以用两种方式将教练标记附加到某个视图上——顶部和底部。所有动画和展示逻辑都由它处理,您只需根据您选择的任何逻辑调用show()和hide()即可。

// Show
self.coachmarkPresenter.show()

//Hide
self.coachmarkPresenter.hide()

请检查示例文件夹中的Xcode项目,其中包含所有三个类在作用下的演示。🚀

附加功能

  • 在OSListCoachmarkView中增加了模糊支持。
  • OSListCoachmarkView中的可选加载器。

文档

您可以在OSCoachmarkView/docs/index.html下找到参考文档。

要求

  • iOS 11.0+
  • Xcode 9
  • Swift 4

贡献

欢迎所有帮助。可以打开一个问题,甚至也可以提交一个pull request。😀

作者

Aamir Anwar @aamiranwarr 欢迎在twitter上联系我!

许可

OSListCoachmark遵循MIT许可发布。详情请查看LICENSE

待办

  • 抽象出表示器逻辑
  • 为顶部和底部模式添加动画选项
  • 添加模糊支持
  • 使用工厂模式创建示例教练标识
  • 添加Cocoapod/Carthage支持
  • 完善README
  • 添加Travis支持
  • 生成文档