CTHelp
关于 CTHelp
CTHelp 是一个针对 iOS/Swift 4.2+ 的帮助系统
安装
CTHelp 通过 CocoaPods 提供。要安装它,只需将以下行添加到您的 Podfile 中
pod 'CTHelp'
快速开始
在您的视图中添加一个按钮,并将操作链接到设置并显示 CTHelp 视图控制器的函数。
以下是一个示例函数,它将创建 3 张帮助卡 + 2 个默认项(链接到网站和帮助电子邮件)
注意:直到您上传图像并将其与项目中的相应名称('SomeFullSizedImage', 'SomeSmallImage' 和 'CompanyLogo')交换,否则不会显示任何图像。
直到替换为有效的条目,电子邮件地址和网站链接将无法使用。
func showCTHelp() {
let ctHelp = CTHelp()
// Optional values to set colors
// ctHelp.ctBgViewColor = .white
// ctHelp.ctTitleColor = .darkText
// ctHelp.ctHelpTextColor = .darkGray
// ctHelp.ctActionButtonBGColor = UIColor(red: 28/255, green: 136/255, blue: 197.255, alpha: 1)
// ctHelp.ctActionButtonTextColor = .white
ctHelp.new(CTHelpItem(title:"No Text-Image Only",
helpText: "",
imageName:"SomeFullSizedImage"))
ctHelp.new(CTHelpItem(title:"Text and Image",
helpText: "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
imageName:"SomeSmallImage"))
ctHelp.new(CTHelpItem(title:"No Image-Text Only",
helpText: "Eu tempor suscipit dis sed. Tortor velit orci bibendum mattis non metus ornare consequat. Condimentum habitasse dictumst eros nibh rhoncus non pulvinar fermentum. Maecenas convallis gravida facilisis. Interdum, conubia lacinia magnis duis nec quisque.Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
imageName:""))
// Optional addition of two default cards
// Use only if you wish to change the strings presented in the two default cards
// ctHelp.ctWebButtonTitle = ""
// ctHelp.ctWebHelpText = ""
// ctHelp.ctContactTitle = ""
// ctHelp.ctContactHelpText = ""
// ctHelp.ctIncludeDataText = ""
// ctHelp.ctContactButtonTitle = ""
// Email data
// ctHelp.ctEmailSubject = ""
// ctHelp.ctEmailAttachNote = ""
// ctHelp.ctEmailBody = ""
// Email alert
// ctHelp.ctDataAlertTitle = ""
// ctHelp.ctDataAlertMessage = ""
// ctHelp.ctDataAlertActionNo = ""
// ctHelp.ctDataAlertActionYes = ""
ctHelp.appendDefaults(companyName: "Your Company Name", emailAddress: "[email protected]", data: nil, webSite: "https://www.yourWebsite.com", companyImageName: "CompanyLogo")
ctHelp.presentHelp(from: self)
}
可选的颜色值让您可以更改 CTHelpView 的 4 个不同组件
因此,取消注释并更改一些或所有值可以改变您帮助卡的的外观。
可选字符串值
您可以选择覆盖两个默认卡片(网页和电子邮件联系)上使用的字符串。以下是如何将它们进行匹配。如果您不更改这些字符串,文本将如所示显示,除非是您的公司和应用程序名称,这些通过函数调用传递。
更多文档
阅读Medium博客查看完整文档和设置CTHelp的技巧。包括YouTube视频链接。
https://medium.com/@stewartlynch/adding-help-to-your-ios-app-7d53053fb563
作者
StewartLynch, [email protected]
许可
CTHelp遵循MIT许可。有关更多信息,请参阅LICENSE文件。