GTEmptyView 1.0.0

GTEmptyView 1.0.0

×

Maintained by liuxc.

GTEmptyView 1.0.0

  • By
  • liuxc123

GTEmptyView

  • 不需要遵循协议，不需要设置代理，不需要实现代理方法，只需这一句代码，就可为一个UITableViwe/UICollectionView集成空白页面占位图。
self.tableView.gt_emptyView = [MyDIYEmpty diyNoDataEmpty];
  • 一句话集成LoadingView
self.tableView.gt_loadingView = [MyDIYLoading diyImageArrayLoading];

注:除UITableViwe/UICollectionView外，这些View(包括UIScrollView)没有DataSource，代码层面无法判断有无数据，需手动管理显示隐藏，调用示例请移步示例9

特点 描述
与项目完全解耦 在需要集成的界面中加入一行代码即可集成，与原代码没有一点耦合度
0学习成本 无需关心视图的显示隐藏时机，只需加入一行代码即可，框架监听了系统刷新UI的方法，其内部计算后自动进行显示隐藏
调用简单 利用分类+runtime，使调用非常简便
高度自定义   利用继承特性，可对框架进行二次封装，使自定义更简便
支持全部的刷新方法  reload...、insert...、delete...等方法。你的项目中调用这些刷新方法时，该框架都会自动根据DataSource自动进行计算判断是否显示emptyView

目录

一-效果展示

           

二-集成方式

        1. Cocoapods方式集成: pod 'GTEmptyView'
    使用时导入头文件 #import <GTEmptyView/GTEmptyViewHeader.h>    
    2. 手动下载集成: 将GTEmptyView文件夹，导入你的工程
    使用时导入头文件：#import "GTEmptyViewHeader.h"

三-使用参考示例

1-一行代码集成空内容视图

//框架方法
self.tableView.gt_emptyView = [GTEmptyView emptyViewWithImageStr:@"noData"
                                                        titleStr:@"暂无数据，点击重新加载"
                                                       detailStr:@""];

PS:可对库进行二次封装，调用更简洁（二次封装方法在下面的示例5中会讲到）

//二次封装方法，调用简洁
self.tableView.gt_emptyView = [MyDIYEmpty diyNoDataEmpty];

完全低耦合，在你的项目中加入这一行代码就可集成
不管项目中是reloadData方法刷UI还是insert、delete等方式刷UI,不需做其他任何操作，只需这一行代码就可实现以下效果

2-一行代码集成加载内容视图

//框架方法
self.tableView.gt_loadingView = [GTLoadingView loadingViewWithLoadingAnimationType:GTLoadingAnimationTypeDot
titleStr:@"加载中"];

PS:可对库进行二次封装，调用更简洁（二次封装方法在下面的示例5中会讲到）

//二次封装方法，调用简洁
self.tableView.gt_emptyView = [MyDIYEmpty diyNoDataEmpty];

完全低耦合，在你的项目中加入这一行代码就可集成
不管项目中是reloadData方法刷UI还是insert、delete等方式刷UI,不需做其他任何操作，只需这一行代码就可实现以下效果

3-自由选择空内容元素

    交互事件可选择SEL或block方式
    self.tableView.gt_emptyView = [GTEmptyView emptyActionViewWithImageStr:@"noData"
                                                              titleStr:@"无数据"
                                                             detailStr:@"请稍后再试!"
                                                           btnTitleStr:@"重新加载"
                                                                target:target
                                                                action:action];
    self.tableView.gt_emptyView = [GTEmptyView emptyActionViewWithImageStr:@"noData"
                                                              titleStr:@""
                                                             detailStr:@""
                                                           btnTitleStr:@""
                                                         btnClickBlock:^{}];
    //    imageStr    : 占位图片
    //    titleStr    : 标题
    //    detailStr   : 详细描述
    //    btnTitleStr : 按钮标题

框架提供四个元素，传入相应元素的字符串即可显示对应元素（按钮的显示前提是传入target，action或btnClickBlock） 可根据项目需求，自由进行组合，如下只展示了部分组合效果

4-自定义空内容元素

特殊情况下，如果空内容状态布局不满足需求时，可进行自定义
通过方法+ (instancetype)emptyViewWithCustomView:(UIView *)customView;
传入一个View 即可创建一个自定义的emptyView

self.tableView.gt_emptyView = [GTEmptyView emptyViewWithCustomView:customView];

5-自定义元素的UI样式

这里自定义UI样式需要很多代码，别担心，在示例5中会讲解二次封装的方式，封装后调用时就只需要一行代码了 ^_^

//初始化一个emptyView
 GTEmptyView *emptyView = [GTEmptyView emptyActionViewWithImageStr:@"noData"
                                                           titleStr:@"无数据"
                                                          detailStr:@"请稍后再试!"
                                                        btnTitleStr:@"重新加载"
                                                      btnClickBlock:^{}];
//元素竖直方向的间距
emptyView.subViewMargin = 20.f;
//标题颜色
emptyView.titleLabTextColor = MainColor(90, 180, 160);
    //描述字体
emptyView.detailLabFont = [UIFont systemFontOfSize:17];
//按钮背景色
emptyView.actionBtnBackGroundColor = MainColor(90, 180, 160);

//设置空内容占位图
self.tableView.gt_emptyView = emptyView;

这里只列举了一些常用的属性，更多属性请到GTEmptyView.h查看

6-二次封装

第5小节的示例代码，修改emptyView的样式需要一个个属性单独去改，如果项目中每个界面都这么写就显得很麻烦，而且不易维护
解决办法是对库进行二次封装，二次封装后，对UI样式单独管理，方便维护

1)新建一个类继承自GTEmptyView，例如demo中的MyDIYEmpty
2)重写- (void)prepare 方法，并修改想要改变的元素的UI样式
- (void)prepare{
    [super prepare];
    
    self.titleLabFont = [UIFont systemFontOfSize:25];
    self.titleLabTextColor = MainColor(90, 180, 160);
    
    self.detailLabFont = [UIFont systemFontOfSize:17];
    self.detailLabTextColor = MainColor(180, 120, 90);
    self.detailLabMaxLines = 5;
    
    self.actionBtnBackGroundColor = MainColor(90, 180, 160);
    self.actionBtnTitleColor = [UIColor whiteColor];
}

操作上面的两步就可实现对样式的单独管理
调用方法不变，只是调用的类变成了MYDiyEmpty

self.tableView.gt_emptyView = [MyDIYEmpty emptyActionViewWithImageStr:@"noData"
                                                             titleStr:@"无数据"
                                                            detailStr:@"请稍后再试!"
                                                          btnTitleStr:@"重新加载"
                                                        btnClickBlock:^{}];
3)进一步封装显示的元素内容，比如无数据状态图、无网络状态图

在MyDIYEmpty.h定义方法+ (instancetype)diyNoDataEmpty;
在MyDIYEmpty.m实现方法

+ (instancetype)diyNoDataEmpty{
    return [MyDIYEmpty emptyViewWithImageStr:@"nodata"
                                    titleStr:@"暂无数据"
                                   detailStr:@"请检查您的网络连接是否正确!"];
}

经过3步封装，自定义了UI样式，使管理更方便，使调用更简洁
self.tableView.gt_emptyView = [MyDIYEmpty diyNoDataEmpty];                                                        

7-延迟显示emptyView

如示例1图，框架自动根据DataSource计算是否显示emptyView，在空页面发起网络请求时，DataSource肯定为空，会自动显示emptyView，有的产品需求可能不希望这样，希望发起请求时暂时隐藏emptyView。 本框架提供了两个方法可实现此需求，两个方法都是scrollView的分类，调用非常方便           

 /**
   一般用于开始请求网络时调用，gt_startLoading调用时会暂时隐藏emptyView
   当调用gt_endLoading方法时，gt_endLoading方法内部会根据当前的tableView/collectionView的
   DataSource来自动判断是否显示emptyView
 */
- (void)gt_startLoading;

 /**
   在想要刷新emptyView状态时调用
   注意:gt_endLoading 的调用时机，有刷新UI的地方一定要等到刷新UI的方法之后调用，
   因为只有刷新了UI，view的DataSource才会更新，故调用此方法才能正确判断是否有内容。
 */
- (void)gt_endLoading;

*注意点:使用这两个方法，请先将emptyView的autoShowEmptyView属性置为NO，关闭自动显隐

以下是调用示例（具体细节可参看demo中的demo2）

//1.先设置样式
self.tableView.gt_emptyView = [MyDIYEmpty diyNoDataEmpty];
//2.关闭自动显隐（此步可封装进自定义类中，相关调用就可省去这步）
self.tableView.gt_emptyView.autoShowEmptyView = NO;
//3.网络请求时调用
[self.tableView gt_startLoading];
//4.刷新UI时调用（保证在刷新UI后调用）
[self.tableView gt_endLoading];

8-特殊需求，手动控制emptyView的显示隐藏

在某些特殊界面下，有的tableView/collectionView有固定的一些死数据，其它的数据根据网络加载，这时根据以上的示例方法可能达不到这需求。
本框架提供另外的两个方法来解决这个问题。

/**
 手动调用显示emptyView
 */
- (void)gt_showEmptyView;

/**
 手动调用隐藏emptyView
 */
- (void)gt_hideEmptyView;

*注意点:使用这两个方法，请先将emptyView的autoShowEmptyView属性置为NO，关闭自动显隐

以下是调用示例（具体细节可参看demo中的demo4）

//1.先设置样式
self.tableView.gt_emptyView = [MyDIYEmpty diyNoDataEmpty];
//2.关闭自动显隐（此步可封装进自定义类中，相关调用就可省去这步）
self.tableView.gt_emptyView.autoShowEmptyView = NO;
//3.显示emptyView
[self.tableView gt_showEmptyView];
//4.隐藏emptyView
[self.tableView gt_hideEmptyView];

9-scrollView调用示例

普通View的调用和scrollView一致 因scrollView没有DataSource，代码层面无法判断scrollView上有无数据，所以scrollView想要实现占位图， 还需通过两个方法来手动控制emptyView的显示和隐藏。 以下是调用示例

//1.先设置样式
self.scrollView.gt_emptyView = [MyDIYEmpty diyNoDataEmpty];
//2.显示emptyView
[self.scrollView gt_showEmptyView];
//3.隐藏emptyView
[self.scrollView gt_hideEmptyView];

Author

liuxc123, [email protected]

License

GTEmptyView is available under the MIT license. See the LICENSE file for more info.