LeveyHUD 项目技术文档

1. 安装指南

环境要求

• iOS 开发环境
• Xcode 最新版本
• 支持 iOS 8.0 及以上版本

安装步骤

1. 打开终端，进入你的项目目录。
2. 使用 CocoaPods 安装 LeveyHUD：

   pod 'LeveyHUD'
   

3. 在终端中运行以下命令安装依赖：

   pod install
   

4. 打开生成的 .xcworkspace 文件，开始使用 LeveyHUD。

2. 项目的使用说明

基本使用

LeveyHUD 是一个简单的 HUD（Heads-Up Display）库，用于在 iOS 应用中显示加载提示、完成提示等。以下是基本的使用方法：

显示 HUD

[[LeveyHUD sharedHUD] appearWithText:@"Loading..."];

隐藏 HUD

[[LeveyHUD sharedHUD] disappear];

延迟隐藏 HUD

[[LeveyHUD sharedHUD] delayDisappear:1.0f withText:@"Done."];

示例代码

// 显示加载提示
[[LeveyHUD sharedHUD] appearWithText:@"正在加载..."];

// 延迟 2 秒后隐藏，并显示完成提示
[[LeveyHUD sharedHUD] delayDisappear:2.0f withText:@"加载完成"];

3. 项目 API 使用文档

sharedHUD

• 描述: 获取 LeveyHUD 的单例实例。
• 返回值: LeveyHUD 实例。

appearWithText:

• 描述: 显示 HUD，并显示指定的文本。
• 参数:
  • text: 要显示的文本字符串。
• 示例:

  [[LeveyHUD sharedHUD] appearWithText:@"Loading..."];
  

disappear

• 描述: 立即隐藏 HUD。
• 示例:

  [[LeveyHUD sharedHUD] disappear];
  

delayDisappear:withText:

• 描述: 延迟指定时间后隐藏 HUD，并显示指定的文本。
• 参数:
  • delay: 延迟时间（秒）。
  • text: 隐藏时要显示的文本字符串。
• 示例:

  [[LeveyHUD sharedHUD] delayDisappear:1.0f withText:@"Done."];
  

4. 项目安装方式

使用 CocoaPods 安装

1. 在 Podfile 中添加以下内容：

   pod 'LeveyHUD'
   

2. 运行以下命令安装依赖：

   pod install
   

3. 打开生成的 .xcworkspace 文件，开始使用 LeveyHUD。

手动安装

1. 下载 LeveyHUD 项目源码。
2. 将源码文件拖入你的 Xcode 项目中。
3. 在需要使用 LeveyHUD 的文件中导入头文件：

   #import "LeveyHUD.h"
   

4. 开始使用 LeveyHUD。

---

通过以上文档，您可以轻松安装和使用 LeveyHUD 项目，并了解其 API 的使用方法。希望这篇文档能帮助您更好地理解和使用该项目。