InAppSettingsKit 技术文档

1. 安装指南

使用 Swift Package Manager (SPM)

1. 在 Xcode 中，选择“File” → “Add Packages…”。
2. 输入 https://github.com/futuretap/InAppSettingsKit.git。

使用 CocoaPods

在 Podfile 中添加：

pod 'InAppSettingsKit'

然后运行 pod install。

使用 Carthage

在 Cartfile 中添加：

github "futuretap/InAppSettingsKit" "master"

2. 项目的使用说明

InAppSettingsKit (IASK) 是一个开源框架，用于在 iOS、Catalyst 或 visionOS 应用中轻松添加应用内设置。通常，iOS 应用使用 Settings.bundle 资源在“设置”应用中添加应用特定的设置。InAppSettingsKit 利用相同的 Settings.bundle，允许你在应用内呈现相同的设置界面。用户可以选择在何处更改设置。

IASK 不仅复制了系统设置的功能集，还支持大量额外的元素和配置选项。

3. 项目 API 使用文档

显示设置界面

要显示 InAppSettingsKit，实例化 IASKAppSettingsViewController 并将其推送到导航堆栈或嵌入为导航控制器的根视图控制器。

在 Swift 中使用代码：

let appSettingsViewController = IASKAppSettingsViewController()
navigationController.pushViewController(appSettingsViewController, animated: true)

在 Objective-C 中使用代码：

IASKAppSettingsViewController *appSettingsViewController = [[IASKAppSettingsViewController alloc] init];
[self.navigationController pushViewController:appSettingsViewController animated:YES];

通过 Storyboard：

• 拖放一个嵌入到导航控制器中的表视图控制器，并将其连接到应用 UI。
• 将表视图控制器类设置为 IASKAppSettingsViewController。
• 将表视图设置为“Grouped”样式。
• 如果你以模态方式呈现导航控制器：
  • 在表视图控制器中，将“Show Done Button”设置为“On”。
  • 设置代理以符合 IASKAppSettingsViewControllerDelegate。
  • 实现代理方法 -settingsViewControllerDidEnd: 并关闭视图控制器。

4. 项目安装方式

添加 Settings.bundle

1. 在项目中添加 Settings.bundle（File -> Add File -> Settings bundle）。
2. 编辑 Root.plist 以添加你的设置（参见 Apple 的文档 Schema File Root Content）。

自定义行为

要自定义行为，实现 IASKSettingsDelegate 并设置 IASKAppSettingsViewController 的 delegate 属性。对于高级自定义需求，支持对 IASKAppSettingsViewController 进行子类化。

动态重新配置

根据项目需求，可能需要在应用启动代码中进行一些更改。应用必须在运行时能够重新配置自身，以防用户更改设置。这可以通过在 -applicationDidFinishLaunching 以及 IASKAppSettingsViewController 的代理方法 -settingsViewControllerDidEnd: 中调用 -reconfigure 方法来实现。

5. 高级功能

自定义 inApp plists

设置 plist 可以是设备依赖的：Root~ipad.plist 将在 iPad 上使用，Root~iphone.plist 将在 iPhone 上使用。如果不存在，则使用 Root.plist。

InAppSettingsKit 增加了通过使用 .inApp.plist 来覆盖标准文件的可能性。或者，你可以创建一个完全独立的名为 InAppSettings.bundle 的包，而不是通常的 Settings.bundle。后一种方法在你想抑制“设置”应用中的设置时很有用。

隐私链接

如果应用在其 Info.plist 中包含用于各种隐私功能的用法键（如相机或位置访问），IASK 将在根设置页面的顶部显示一个“隐私”单元格。此单元格打开系统“设置”应用，并显示应用的设置面板，用户可以在其中管理隐私设置。