GHSideBarNav 项目技术文档

1. 安装指南

系统要求

• 操作系统: Mac OS 10.7+ (Lion)
• 开发工具: Xcode 4.2.1+
• iOS版本: iOS 5.0+

安装步骤

1. 下载项目: 从GitHub下载或克隆GHSideBarNav项目到本地。
2. 导入项目: 将项目导入到你的Xcode工作区。
3. 配置ARC: 确保你的项目启用了ARC（Automatic Reference Counting）。

2. 项目的使用说明

核心组件

• GHRevealViewController: 主视图控制器，负责管理侧边栏和主内容面板的切换。
• GHSidebarSearchViewController: 搜索视图控制器，负责处理搜索功能。
• GHSidebarSearchViewControllerDelegate: 搜索视图控制器的代理，用于处理搜索结果。

使用步骤

1. 复制核心组件: 将GHRevealViewController、GHSidebarSearchViewController和GHSidebarSearchViewControllerDelegate复制到你的项目中。
2. 集成到AppDelegate: 使用GHAppDelegate作为模板，将GHRevealViewController集成到你的项目的主窗口中，并传递你自己的头文件、控制器和cellInfos。
3. 实现搜索代理: 实现GHSidebarSearchViewControllerDelegate，处理搜索结果（例如调用Web服务），并对选中的搜索结果进行处理。
4. 自定义外观: 修改颜色和外观，使其符合你的项目配色方案。

3. 项目API使用文档

GHRevealViewController

• 方法:
  • initWithNibName:bundle:: 初始化视图控制器。
  • setRootViewController:: 设置主内容面板的根视图控制器。
  • setSidebarViewController:: 设置侧边栏的视图控制器。

GHSidebarSearchViewController

• 方法:
  • initWithNibName:bundle:: 初始化搜索视图控制器。
  • searchWithString:: 使用给定的字符串进行搜索。

GHSidebarSearchViewControllerDelegate

• 协议方法:
  • sidebarSearchResults:: 返回搜索结果。
  • sidebarDidSelectSearchResult:: 当用户选择搜索结果时调用。

4. 项目安装方式

手动安装

1. 下载项目: 从GitHub下载或克隆GHSideBarNav项目。
2. 导入项目: 将项目导入到你的Xcode工作区。
3. 配置项目: 确保项目启用了ARC，并且符合系统要求。

CocoaPods安装

1. 添加依赖: 在Podfile中添加以下依赖：

   pod 'GHSideBarNav', '~> 1.0'
   

2. 安装依赖: 运行pod install命令安装依赖。
3. 集成项目: 打开生成的.xcworkspace文件，开始使用GHSideBarNav。

通过以上步骤，你可以成功安装并使用GHSideBarNav项目，实现类似Facebook iOS应用的侧边栏导航功能。