HelpKit 为 Apple 平台的开发者提供向其应用程序添加帮助屏幕的功能。 它使用 SwiftUI 构建，因此可以从 SwiftUI 应用程序本地显示，或者在 UIKit 应用程序中使用 UIHostingController 显示。
该项目已本地化为多种语言，并且按钮将自动适应您应用程序的主题颜色。
- iOS/iPadOS 15.0+
- macOS 13.0+
- tvOS 16.0+
- visionOS 1.0+
- watchOS 8.0+
- Xcode 15.0+
可以通过 Xcode 中的 Swift Package Manager 将 HelpKit 添加到您的应用程序。 像这样添加到您的项目
dependencies: [
.package(url: "https://github.com/adamfootdev/HelpKit.git", from: "1.0.0")
]
要开始使用该框架，您需要首先导入它
import HelpKit
这是一个包含配置 HelpKit 所需所有相关详细信息的结构体。 可以像这样创建它
let configuration = HKConfiguration(
displayMode: .navigation,
topicSections: topicSections
) {
print("Get Support")
}
这是一个包含有关帮助主题部分详细信息的结构体。 可以像这样创建它
let topicSection = HKTopicSection(
"Topic Section",
topics: topics
)
这是一个包含有关帮助主题详细信息的结构体。 可以像这样创建它
let topic = HKTopic(
"Topic",
iconSystemImage: "questionmark.circle",
iconTint: .red,
content: "Some content here…",
contentImage: Image("image"),
links: links,
keywords: ["keyword"]
)
这是一个包含有关帮助链接详细信息的结构体。 可以像这样创建它
let topic = HKLink(
"Website",
url: URL(string: "https://www.example.com")!
)
使用以下方法创建视图的实例
HelpView(configuration: configuration)
向您的应用程序添加“关于”屏幕。
向您的应用程序添加功能列表屏幕。