MJRefresh
- An easy way to use pull-to-refresh
- 用法簡單的下拉刷新框架:一行代碼搞定
Contents
- Getting Started
- 常見API
- Examples
- 期待
<a id="支持哪些控件的刷新"></a>支持哪些控件的刷新
-
UIScrollView
、UITableView
、UICollectionView
湃窍、UIWebView
<a id="如何使用MJRefresh"></a>如何使用MJRefresh
- cocoapods導(dǎo)入:
pod 'MJRefresh'
- 手動導(dǎo)入:
- 將
MJRefresh
文件夾中的所有文件拽入項目中
- 導(dǎo)入主頭文件:
#import "MJRefresh.h"
Base Custom
MJRefresh.bundle MJRefresh.h
MJRefreshConst.h MJRefreshConst.m
UIScrollView+MJExtension.h UIScrollView+MJExtension.m
UIScrollView+MJRefresh.h UIScrollView+MJRefresh.m
UIView+MJExtension.h UIView+MJExtension.m
<a id="已經(jīng)超過上百個App正在使用MJRefresh"></a>已經(jīng)超過上百個App正在使用MJRefresh
<a id="MJRefresh類結(jié)構(gòu)圖"></a>MJRefresh類結(jié)構(gòu)圖
- 圖中
紅色文字的類
:可以直接拿來用
- 下拉刷新控件的種類
- 默認(Normal):
MJRefreshNormalHeader
- 動圖(Gif):
MJRefreshGifHeader
- 上拉刷新控件的種類
- 自動刷新(Auto)
- 默認(Normal):
MJRefreshAutoNormalFooter
- 動圖(Gif):
MJRefreshAutoGifFooter
- 自動回彈(Back)
- 默認(Normal):
MJRefreshBackNormalFooter
- 動圖(Gif):
MJRefreshBackGifFooter
- 圖中
非紅色文字的類
:拿來繼承,用于自定義刷新控件
- 關(guān)于如何自定義刷新控件畅涂,可以參考下圖的類
<a id="MJRefreshComponent.h"></a>MJRefreshComponent.h
/** 刷新控件的基類 */
@interface MJRefreshComponent : UIView
#pragma mark - 刷新狀態(tài)控制
/** 進入刷新狀態(tài) */
- (void)beginRefreshing;
/** 結(jié)束刷新狀態(tài) */
- (void)endRefreshing;
/** 是否正在刷新 */
- (BOOL)isRefreshing;
#pragma mark - 其他
/** 根據(jù)拖拽比例自動切換透明度 */
@property (assign, nonatomic, getter=isAutomaticallyChangeAlpha) BOOL automaticallyChangeAlpha;
@end
<a id="MJRefreshHeader.h"></a>MJRefreshHeader.h
@interface MJRefreshHeader : MJRefreshComponent
/** 創(chuàng)建header */
+ (instancetype)headerWithRefreshingBlock:(MJRefreshComponentRefreshingBlock)refreshingBlock;
/** 創(chuàng)建header */
+ (instancetype)headerWithRefreshingTarget:(id)target refreshingAction:(SEL)action;
/** 這個key用來存儲上一次下拉刷新成功的時間 */
@property (copy, nonatomic) NSString *lastUpdatedTimeKey;
/** 上一次下拉刷新成功的時間 */
@property (strong, nonatomic, readonly) NSDate *lastUpdatedTime;
/** 忽略多少scrollView的contentInset的top */
@property (assign, nonatomic) CGFloat ignoredScrollViewContentInsetTop;
@end
<a id="MJRefreshFooter.h"></a>MJRefreshFooter.h
@interface MJRefreshFooter : MJRefreshComponent
/** 創(chuàng)建footer */
+ (instancetype)footerWithRefreshingBlock:(MJRefreshComponentRefreshingBlock)refreshingBlock;
/** 創(chuàng)建footer */
+ (instancetype)footerWithRefreshingTarget:(id)target refreshingAction:(SEL)action;
/** 提示沒有更多的數(shù)據(jù) */
- (void)endRefreshingWithNoMoreData;
/** 重置沒有更多的數(shù)據(jù)(消除沒有更多數(shù)據(jù)的狀態(tài)) */
- (void)resetNoMoreData;
/** 忽略多少scrollView的contentInset的bottom */
@property (assign, nonatomic) CGFloat ignoredScrollViewContentInsetBottom;
/** 自動根據(jù)有無數(shù)據(jù)來顯示和隱藏(有數(shù)據(jù)就顯示香到,沒有數(shù)據(jù)隱藏) */
@property (assign, nonatomic) BOOL automaticallyHidden;
@end
<a id="MJRefreshAutoFooter.h"></a>MJRefreshAutoFooter.h
@interface MJRefreshAutoFooter : MJRefreshFooter
/** 是否自動刷新(默認為YES) */
@property (assign, nonatomic, getter=isAutomaticallyRefresh) BOOL automaticallyRefresh;
/** 當?shù)撞靠丶霈F(xiàn)多少時就自動刷新(默認為1.0挑童,也就是底部控件完全出現(xiàn)時闪水,才會自動刷新) */
@property (assign, nonatomic) CGFloat triggerAutomaticallyRefreshPercent;
@end
<a id="參考"></a>參考
* 由于這個框架的功能較多糕非,就不寫具體文字描述其用法
* 大家可以直接參考示例中的MJTableViewController、MJCollectionViewController敦第、MJWebViewController,更為直觀快速
<a id="下拉刷新01-默認"></a>下拉刷新01-默認
self.tableView.header = [MJRefreshNormalHeader headerWithRefreshingBlock:^{
// 進入刷新狀態(tài)后會自動調(diào)用這個block
}];
或
// 設(shè)置回調(diào)(一旦進入刷新狀態(tài)店量,就調(diào)用target的action芜果,也就是調(diào)用self的loadNewData方法)
self.tableView.header = [MJRefreshNormalHeader headerWithRefreshingTarget:self refreshingAction:@selector(loadNewData)];
// 馬上進入刷新狀態(tài)
[self.tableView.header beginRefreshing];
<a id="下拉刷新02-動畫圖片"></a>下拉刷新02-動畫圖片
// 設(shè)置回調(diào)(一旦進入刷新狀態(tài),就調(diào)用target的action融师,也就是調(diào)用self的loadNewData方法)
MJRefreshGifHeader *header = [MJRefreshGifHeader headerWithRefreshingTarget:self refreshingAction:@selector(loadNewData)];
// 設(shè)置普通狀態(tài)的動畫圖片
[header setImages:idleImages forState:MJRefreshStateIdle];
// 設(shè)置即將刷新狀態(tài)的動畫圖片(一松開就會刷新的狀態(tài))
[header setImages:pullingImages forState:MJRefreshStatePulling];
// 設(shè)置正在刷新狀態(tài)的動畫圖片
[header setImages:refreshingImages forState:MJRefreshStateRefreshing];
// 設(shè)置header
self.tableView.mj_header = header;
<a id="下拉刷新03-隱藏時間"></a>下拉刷新03-隱藏時間
// 隱藏時間
header.lastUpdatedTimeLabel.hidden = YES;
<a id="下拉刷新04-隱藏狀態(tài)和時間"></a>下拉刷新04-隱藏狀態(tài)和時間
// 隱藏時間
header.lastUpdatedTimeLabel.hidden = YES;
// 隱藏狀態(tài)
header.stateLabel.hidden = YES;
<a id="下拉刷新05-自定義文字"></a>下拉刷新05-自定義文字
// 設(shè)置文字
[header setTitle:@"Pull down to refresh" forState:MJRefreshStateIdle];
[header setTitle:@"Release to refresh" forState:MJRefreshStatePulling];
[header setTitle:@"Loading ..." forState:MJRefreshStateRefreshing];
// 設(shè)置字體
header.stateLabel.font = [UIFont systemFontOfSize:15];
header.lastUpdatedTimeLabel.font = [UIFont systemFontOfSize:14];
// 設(shè)置顏色
header.stateLabel.textColor = [UIColor redColor];
header.lastUpdatedTimeLabel.textColor = [UIColor blueColor];
<a id="下拉刷新06-自定義刷新控件"></a>下拉刷新06-自定義刷新控件
self.tableView.mj_header = [MJDIYHeader headerWithRefreshingTarget:self refreshingAction:@selector(loadNewData)];
// 具體實現(xiàn)參考MJDIYHeader.h和MJDIYHeader.m
<a id="上拉刷新01-默認"></a>上拉刷新01-默認
self.tableView.mj_footer = [MJRefreshAutoNormalFooter footerWithRefreshingBlock:^{
// 進入刷新狀態(tài)后會自動調(diào)用這個block
}];
或
// 設(shè)置回調(diào)(一旦進入刷新狀態(tài)右钾,就調(diào)用target的action,也就是調(diào)用self的loadMoreData方法)
self.tableView.mj_footer = [MJRefreshAutoNormalFooter footerWithRefreshingTarget:self refreshingAction:@selector(loadMoreData)];
<a id="上拉刷新02-動畫圖片"></a>上拉刷新02-動畫圖片
// 設(shè)置回調(diào)(一旦進入刷新狀態(tài)旱爆,就調(diào)用target的action舀射,也就是調(diào)用self的loadMoreData方法)
MJRefreshAutoGifFooter *footer = [MJRefreshAutoGifFooter footerWithRefreshingTarget:self refreshingAction:@selector(loadMoreData)];
// 設(shè)置刷新圖片
[footer setImages:refreshingImages forState:MJRefreshStateRefreshing];
// 設(shè)置尾部
self.tableView.mj_footer = footer;
<a id="上拉刷新03-隱藏刷新狀態(tài)的文字"></a>上拉刷新03-隱藏刷新狀態(tài)的文字
// 隱藏刷新狀態(tài)的文字
footer.refreshingTitleHidden = YES;
// 如果沒有上面的方法,就用footer.stateLabel.hidden = YES;
<a id="上拉刷新04-全部加載完畢"></a>上拉刷新04-全部加載完畢
// 變?yōu)闆]有更多數(shù)據(jù)的狀態(tài)
[footer endRefreshingWithNoMoreData];
<a id="上拉刷新05-自定義文字"></a>上拉刷新05-自定義文字
// 設(shè)置文字
[footer setTitle:@"Click or drag up to refresh" forState:MJRefreshStateIdle];
[footer setTitle:@"Loading more ..." forState:MJRefreshStateRefreshing];
[footer setTitle:@"No more data" forState:MJRefreshStateNoMoreData];
// 設(shè)置字體
footer.stateLabel.font = [UIFont systemFontOfSize:17];
// 設(shè)置顏色
footer.stateLabel.textColor = [UIColor blueColor];
<a id="上拉刷新06-加載后隱藏"></a>上拉刷新06-加載后隱藏
// 隱藏當前的上拉刷新控件
self.tableView.mj_footer.hidden = YES;
<a id="上拉刷新07-自動回彈的上拉01"></a>上拉刷新07-自動回彈的上拉01
self.tableView.mj_footer = [MJRefreshBackNormalFooter footerWithRefreshingTarget:self refreshingAction:@selector(loadMoreData)];
<a id="上拉刷新08-自動回彈的上拉02"></a>上拉刷新08-自動回彈的上拉02
MJRefreshBackGifFooter *footer = [MJRefreshBackGifFooter footerWithRefreshingTarget:self refreshingAction:@selector(loadMoreData)];
// 設(shè)置普通狀態(tài)的動畫圖片
[footer setImages:idleImages forState:MJRefreshStateIdle];
// 設(shè)置即將刷新狀態(tài)的動畫圖片(一松開就會刷新的狀態(tài))
[footer setImages:pullingImages forState:MJRefreshStatePulling];
// 設(shè)置正在刷新狀態(tài)的動畫圖片
[footer setImages:refreshingImages forState:MJRefreshStateRefreshing];
// 設(shè)置尾部
self.tableView.mj_footer = footer;
<a id="上拉刷新09-自定義刷新控件(自動刷新)"></a>上拉刷新09-自定義刷新控件(自動刷新)
self.tableView.mj_footer = [MJDIYAutoFooter footerWithRefreshingTarget:self refreshingAction:@selector(loadMoreData)];
// 具體實現(xiàn)參考MJDIYAutoFooter.h和MJDIYAutoFooter.m
<a id="上拉刷新10-自定義刷新控件(自動回彈)"></a>上拉刷新10-自定義刷新控件(自動回彈)
self.tableView.mj_footer = [MJDIYBackFooter footerWithRefreshingTarget:self refreshingAction:@selector(loadMoreData)];
// 具體實現(xiàn)參考MJDIYBackFooter.h和MJDIYBackFooter.m
<a id="UICollectionView01-上下拉刷新"></a>UICollectionView01-上下拉刷新
// 下拉刷新
self.collectionView.mj_header = [MJRefreshNormalHeader headerWithRefreshingBlock:^{
// 進入刷新狀態(tài)后會自動調(diào)用這個block
}];
// 上拉刷新
self.collectionView.mj_footer = [MJRefreshAutoNormalFooter footerWithRefreshingBlock:^{
// 進入刷新狀態(tài)后會自動調(diào)用這個block
}];
(UICollectionView01-上下拉刷新)
<a id="UIWebView01-下拉刷新"></a>UIWebView01-下拉刷新
// 添加下拉刷新控件
self.webView.scrollView.mj_header = [MJRefreshNormalHeader headerWithRefreshingBlock:^{
// 進入刷新狀態(tài)后會自動調(diào)用這個block
}];
(UICollectionView01-上下拉刷新)
提醒
- 本框架純ARC怀伦,兼容的系統(tǒng)>=iOS6.0脆烟、iPhone\iPad橫豎屏