AboutKit

Feature Graphic Platform

AboutKit 为 Apple 平台的开发者提供向其应用添加“关于”屏幕的功能。它使用 SwiftUI 构建,因此可以从 SwiftUI 应用原生显示,或者在 UIKit 应用中使用 UIHostingController 显示。

此功能已本地化为多种语言,并且按钮会自动适应应用的强调色。

对于之前使用 AboutKit 显示功能列表的用户,请使用 FeaturesKit

  1. 要求
  2. 集成
  3. 用法
  4. 其他包

要求

集成

Swift Package Manager

可以通过 Xcode 中的 Swift Package Manager 将 AboutKit 添加到您的应用。 像这样添加到您的项目

dependencies: [
    .package(url: "https://github.com/adamfootdev/AboutKit.git", from: "3.0.0")
]

用法

要开始使用该框架,您需要首先导入它

import AboutKit

AKConfiguration

这是一个包含配置 AboutKit 所需的所有相关详细信息的结构体。 它可以这样创建

let configuration = AKConfiguration(
    app: app, 
    otherApps: otherApps, 
    showShareApp: .always, 
    showWriteReview: .always
)

AKMyApp

这是一个包含有关当前应用详细信息的结构体。 它可以这样创建

let app = AKMyApp(
    id: "123456789", 
    name: "Example App", 
    appIcon: UIImage(named: "app-icon"), 
    developer: developer, 
    email: "exampleapp@example.com", 
    websiteURL: URL(string: "https://www.example.com")!, 
    profiles: [profile], 
    privacyPolicyURL: URL(string: "https://www.example.com/privacy-policy")!, 
    termsOfUseURL: URL(string: "https://www.example.com/terms-of-use")!, 
    testFlightURL: URL(string: "https://www.example.com/testflight")!, 
    acknowledgements: acknowledgements
)

如果未提供应用图标的值,将尝试根据提供的应用 ID 从 App Store 下载一个。 应用 ID 可以在 App Store Connect 中找到,也可以从应用的 URL 中找到,例如 https://apps.apple.com/app/id123456789

AKDeveloper

这是一个包含有关当前应用的开发者详细信息的结构体。 它可以这样创建

let developer = AKDeveloper(
    id: "987654321", 
    name: "App Developer", 
    profiles: [profile]
)

开发者 ID 可以通过找到包含您所有应用的 App Store 页面来找到,例如 https://apps.apple.com/developer/id987654321

AKProfile

这是一个包含有关与开发者或应用本身相关的社交媒体个人资料的详细信息的结构体。 它支持多个平台,例如 X 和 Mastodon。 它可以这样创建

let profile = AKProfile(
    username: "appdeveloper", 
    platform: .reddit
)

AKOtherApp

这是一个结构体,包含用于显示您拥有的另一个应用的详细信息,并且希望在“关于”屏幕上的列表中显示该应用。 您可以按如下方式创建一个:

let otherApp = AKOtherApp(
    id: "543216789",
    name: "Other App",
    appIcon: UIImage(named: "app-icon")
)

如果未提供应用图标的值,将尝试根据提供的应用 ID 从 App Store 下载一个。 应用 ID 可以在 App Store Connect 中找到,也可以从应用的 URL 中找到,例如 https://apps.apple.com/app/id123456789

AKAcknowledgements

这是一个包含有关您想要鸣谢的框架和人员的详细信息的结构体。 您可以按如下方式创建一个:

let acknowledgements = AKAcknowledgements(
    people: [person],
    frameworks: [framework]
)

AKPersonAcknowledgement

这是一个包含有关您想要鸣谢的人员的详细信息的结构体。 您可以按如下方式创建一个:

let person = AKPersonAcknowledgement(
    name: "App Developer",
    details: "Some details about this person!",
    profiles: [profile]
)

AKFrameworkAcknowledgement

这是一个包含有关您想要鸣谢的框架的详细信息的结构体。 您可以按如下方式创建一个:

let framework = AKFrameworkAcknowledgement(
    name: "Framework",
    details: "Some details about this framework!",
    links: [.productPage(URL(string: "https://www.example.com")!)]
)

AboutAppView

使用以下代码创建视图的实例

AboutAppView(configuration: configuration)

其他包

FeaturesKit

向您的应用添加功能列表屏幕。

HelpKit

向您的应用添加帮助屏幕。