SVProgressHUD 技术文档

1. 安装指南

Swift Package Manager

使用 Swift Package Manager (SwiftPM) 可以简化 Swift 代码的分布式管理。

要在项目中集成 SVProgressHUD，请按照以下步骤操作：

1. 在 Xcode 中，选择 文件 > 添加包依赖。
2. 输入以下包仓库 URL：https://github.com/SVProgressHUD/SVProgressHUD.git
3. 选择合适的版本（例如特定版本、分支或提交）。
4. 将 SVProgressHUD 添加到您的目标依赖中。

SVProgressHUD 需要 Swift 工具版本 5.3 或更高。

CocoaPods

CocoaPods 是一个 Objective-C 的依赖管理工具，它自动化并简化了在项目中使用第三方库的过程。

首先，在您的 Podfile 中添加以下行：

pod 'SVProgressHUD'

如果您想使用 SVProgressHUD 的最新功能，请使用正常的外部源依赖。

pod 'SVProgressHUD', :git => 'https://github.com/SVProgressHUD/SVProgressHUD.git'

这会直接从 master 分支拉取。

然后，安装 SVProgressHUD 到您的项目中：

pod install

Carthage

Carthage 是一个去中心化的依赖管理器，它构建您的依赖并提供二进制框架。

要在 Xcode 项目中使用 Carthage 集成 SVProgressHUD，请在您的 Cartfile 中指定：

github "SVProgressHUD/SVProgressHUD"

运行 carthage bootstrap 来在您的仓库 Carthage 目录中构建框架。然后您可以在目标的 carthage copy-frameworks 构建阶段中包含它。更多相关信息，请查看 Carthage 的文档。

手动安装

• 将 SVProgressHUD/SVProgressHUD 文件夹拖入您的项目。
• 确保 SVProgressHUD.bundle 被添加到 Targets->Build Phases->Copy Bundle Resources。
• 将 QuartzCore 框架添加到您的项目中。

2. 项目使用说明

SVProgressHUD 是一个单例模式（即不需要显式分配和实例化；直接调用 [SVProgressHUD method] / SVProgressHUD.method()）。

请明智地使用 SVProgressHUD！仅在您确实需要在用户前进之前执行任务时使用它。不恰当的使用案例包括：下拉刷新、无限滚动、发送消息。

在您的应用中使用 SVProgressHUD 通常如下所示：

Objective-C：

[SVProgressHUD show];
dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
    // 耗时任务
    dispatch_async(dispatch_get_main_queue(), ^{
        [SVProgressHUD dismiss];
    });
});

Swift：

SVProgressHUD.show()
DispatchQueue.global(qos: .default).async {
    // 耗时任务
    DispatchQueue.main.async {
        SVProgressHUD.dismiss()
    }
}

显示 HUD

您可以使用以下方法之一来显示不确定任务的状态：

+ (void)show;
+ (void)showWithStatus:(NSString*)string;

如果您希望 HUD 反映任务的进度，请使用以下方法之一：

+ (void)showProgress:(CGFloat)progress;
+ (void)showProgress:(CGFloat)progress status:(NSString*)status;

隐藏 HUD

HUD 可以使用以下方法之一来隐藏：

+ (void)dismiss;
+ (void)dismissWithDelay:(NSTimeInterval)delay;

如果您想堆叠 HUD，可以平衡每次显示调用：

+ (void)popActivity;

当 popActivity 调用次数与显示调用次数相匹配时，HUD 将被隐藏。

或者在稍后显示带有状态信息的图像。显示时间取决于 minimumDismissTimeInterval 和给定字符串的长度。

+ (void)showInfoWithStatus:(NSString*)string;
+ (void)showSuccessWithStatus:(NSString*)string;
+ (void)showErrorWithStatus:(NSString*)string;
+ (void)showImage:(UIImage*)image status:(NSString*)string;

3. 项目 API 使用文档

SVProgressHUD 提供了多种方法来显示和隐藏 HUD，以及自定义其外观和行为。

• show: 显示一个没有状态的 HUD。
• showWithStatus: 显示一个带有指定状态的 HUD。
• showProgress: 显示一个带有进度条的 HUD。
• showProgress:status: 显示一个带有进度条和指定状态的 HUD。
• dismiss: 隐藏 HUD。
• dismissWithDelay: 在指定的延迟后隐藏 HUD。
• popActivity: 平衡显示调用，以堆叠 HUD。

更多方法和详细说明，请参考 SVProgressHUD.h 头文件。

4. 项目安装方式

请参考上述“安装指南”部分，选择适合您项目的安装方式：Swift Package Manager、CocoaPods、Carthage 或手动安装。