Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/CoderMJLee/MJRefresh

An easy way to use pull-to-refresh.
https://github.com/CoderMJLee/MJRefresh

objective-c refresh

Last synced: 7 days ago
JSON representation

An easy way to use pull-to-refresh.

Awesome Lists containing this project

README 

        
## MJRefresh

[![SPM supported](https://img.shields.io/badge/SPM-supported-4BC51D.svg?style=flat)](https://github.com/apple/swift-package-manager)

[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)

[![podversion](https://img.shields.io/cocoapods/v/MJRefresh.svg)](https://cocoapods.org/pods/MJRefresh)



* An easy way to use pull-to-refresh



[📜✍🏻**Release Notes**: more details](https://github.com/CoderMJLee/MJRefresh/releases)



## Contents



- New Features

    - [Support Flips in CollectionViewLayout](#SupportFlipsInCollectionViewLayout)

    - [Dynamic i18n Switching](#dynamic_i18n_switching)

    - [SPM Supported](#spm_supported)

    - [Swift Chaining Grammar Supported](#swift_chaining_grammar_supported)



* Getting Started

    * [Features【Support what kinds of controls to refresh】](#Support_what_kinds_of_controls_to_refresh)

    * [Installation【How to use MJRefresh】](#How_to_use_MJRefresh)

    * [Who's using【More than hundreds of Apps are using MJRefresh】](#More_than_hundreds_of_Apps_are_using_MJRefresh)

    * [Classes【The Class Structure Chart of MJRefresh】](#The_Class_Structure_Chart_of_MJRefresh)

* Comment API

	* [MJRefreshComponent.h](#MJRefreshComponent.h)

	* [MJRefreshHeader.h](#MJRefreshHeader.h)

	* [MJRefreshFooter.h](#MJRefreshFooter.h)

	* [MJRefreshAutoFooter.h](#MJRefreshAutoFooter.h)

	* [MJRefreshTrailer.h](#MJRefreshTrailer.h)

* Examples

    * [Reference](#Reference)

    * [The drop-down refresh 01-Default](#The_drop-down_refresh_01-Default)

    * [The drop-down refresh 02-Animation image](#The_drop-down_refresh_02-Animation_image)

    * [The drop-down refresh 03-Hide the time](#The_drop-down_refresh_03-Hide_the_time)

    * [The drop-down refresh 04-Hide status and time](#The_drop-down_refresh_04-Hide_status_and_time)

    * [The drop-down refresh 05-DIY title](#The_drop-down_refresh_05-DIY_title)

    * [The drop-down refresh 06-DIY the control of refresh](#The_drop-down_refresh_06-DIY_the_control_of_refresh)

    * [The pull to refresh 01-Default](#The_pull_to_refresh_01-Default)

    * [The pull to refresh 02-Animation image](#The_pull_to_refresh_02-Animation_image)

    * [The pull to refresh 03-Hide the title of refresh status](#The_pull_to_refresh_03-Hide_the_title_of_refresh_status)

    * [The pull to refresh 04-All loaded](#The_pull_to_refresh_04-All_loaded)

    * [The pull to refresh 05-DIY title](#The_pull_to_refresh_05-DIY_title)

    * [The pull to refresh 06-Hidden After loaded](#The_pull_to_refresh_06-Hidden_After_loaded)

    * [The pull to refresh 07-Automatic back of the pull01](#The_pull_to_refresh_07-Automatic_back_of_the_pull01)

    * [The pull to refresh 08-Automatic back of the pull02](#The_pull_to_refresh_08-Automatic_back_of_the_pull02)

    * [The pull to refresh 09-DIY the control of refresh(Automatic refresh)](#The_pull_to_refresh_09-DIY_the_control_of_refresh(Automatic_refresh))

    * [The pull to refresh 10-DIY the control of refresh(Automatic back)](#The_pull_to_refresh_10-DIY_the_control_of_refresh(Automatic_back))

    * [UICollectionView01-The pull and drop-down refresh](#UICollectionView01-The_pull_and_drop-down_refresh)

    * [UICollectionView02-The trailer refresh](#UICollectionView02-The_trailer_refresh)

    * [WKWebView01-The drop-down refresh](#WKWebView01-The_drop-down_refresh)

* [Hope](#Hope)



## New Features



### Support Flips In CollectionViewLayout



> Refer to [issue #1616](https://github.com/CoderMJLee/MJRefresh/issues/1616).

- Use `additionalFlipsViews` to append views that need to flip when collectionViewLayout flipsHorizontallyInOppositeLayoutDirection is `true`.

- Use `flipsHorizontallyInOppositeLayoutDirectionViews` to modify views as the same way above. **⚠️ BUT parent class may be affected. Use `additionalFlipsViews` instead.**



### Dynamic i18n Switching



Now `MJRefresh components` will be rerendered automatically with `MJRefreshConfig.default.language` setting.



#### Example



Go `i18n` folder and see lots of cases. Simulator example is behind `i18n tab` in right-top corner.



#### Setting language



```swift

MJRefreshConfig.default.language = "zh-hans"

```



#### Setting i18n file name



```swift

MJRefreshConfig.default.i18nFilename = "i18n File Name(not include type<.strings>)"

```



#### Setting i18n language bundle



```swift

MJRefreshConfig.default.i18nBundle = 

```



#### Adopting the feature in your DIY component



1. Just override `i18nDidChange` function and reset texts.



```swift

// must use this localization methods

Bundle.mj_localizedString(forKey: "")

// or

Bundle.mj_localizedString(forKey: "", value:"")



override func i18nDidChange() {

    // Reset texts function

    setupTexts()

    // Make sure to call super after resetting texts. It will call placeSubViews for applying new layout.

    super.i18nDidChange()

}

```



2. Receiving `MJRefreshDidChangeLanguageNotification` notification.



### SPM Supported



Released from [`3.7.1`](https://github.com/CoderMJLee/MJRefresh/releases/tag/3.7.1)



### Swift Chaining Grammar Supported



```swift

  // Example as MJRefreshNormalHeader

  func addRefreshHeader() {

      MJRefreshNormalHeader { [weak self] in

  	  // load some data

      }.autoChangeTransparency(true)

      .link(to: tableView)

  }

```



## Support what kinds of controls to refresh



* `UIScrollView`、`UITableView`、`UICollectionView`、`WKWebView`



## How to use MJRefresh

* Installation with CocoaPods：`pod 'MJRefresh'`

* Installation with [Carthage](https://github.com/Carthage/Carthage)：`github "CoderMJLee/MJRefresh"`

* Manual import：

    * Drag All files in the `MJRefresh` folder to project

    * Import the main file：`#import "MJRefresh.h"`



```objc

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

```



## More than hundreds of Apps are using MJRefresh



* More information of App can focus on：[M了个J-博客园](http://www.cnblogs.com/mjios/p/4409853.html)



## The Class Structure Chart of MJRefresh

![](http://images0.cnblogs.com/blog2015/497279/201506/132232456139177.png)

- `The class of red text` in the chart：You can use them directly

    - The drop-down refresh control types

        - Normal：`MJRefreshNormalHeader`

        - Gif：`MJRefreshGifHeader`

    - The pull to refresh control types

        - Auto refresh

            - Normal：`MJRefreshAutoNormalFooter`

            - Gif：`MJRefreshAutoGifFooter`

        - Auto Back

            - Normal：`MJRefreshBackNormalFooter`

            - Gif：`MJRefreshBackGifFooter`

    

- `The class of non-red text` in the chart：For inheritance，to use DIY the control of refresh



- About how to DIY the control of refresh，You can refer the Class in below Chart



  



## MJRefreshComponent.h

```objc

/** The Base Class of refresh control */

@interface MJRefreshComponent : UIView

#pragma mark -  Control the state of Refresh 



/** BeginRefreshing */

- (void)beginRefreshing;

/** EndRefreshing */

- (void)endRefreshing; 

/** IsRefreshing */

- (BOOL)isRefreshing;



#pragma mark - Other

/** According to the drag ratio to change alpha automatically */

@property (assign, nonatomic, getter=isAutomaticallyChangeAlpha) BOOL automaticallyChangeAlpha;

@end

```



## MJRefreshHeader.h

```objc

@interface MJRefreshHeader : MJRefreshComponent

/** create header */

+ (instancetype)headerWithRefreshingBlock:(MJRefreshComponentRefreshingBlock)refreshingBlock;

/** create header */

+ (instancetype)headerWithRefreshingTarget:(id)target refreshingAction:(SEL)action;



/** This key is used to storage the time that the last time of drown-down successfully */

@property (copy, nonatomic) NSString *lastUpdatedTimeKey;

/** The last time of drown-down successfully */

@property (strong, nonatomic, readonly) NSDate *lastUpdatedTime;



/** Ignored scrollView contentInset top */

@property (assign, nonatomic) CGFloat ignoredScrollViewContentInsetTop;

@end

```



## MJRefreshFooter.h

```objc

@interface MJRefreshFooter : MJRefreshComponent

/** create footer */

+ (instancetype)footerWithRefreshingBlock:(MJRefreshComponentRefreshingBlock)refreshingBlock;

/** create footer */

+ (instancetype)footerWithRefreshingTarget:(id)target refreshingAction:(SEL)action;



/** NoticeNoMoreData */

- (void)noticeNoMoreData;

/** ResetNoMoreData（Clear the status of NoMoreData ） */

- (void)resetNoMoreData;



/** Ignored scrollView contentInset bottom */

@property (assign, nonatomic) CGFloat ignoredScrollViewContentInsetBottom;

@end

```



## MJRefreshAutoFooter.h

```objc

@interface MJRefreshAutoFooter : MJRefreshFooter

/** Is Automatically Refresh(Default is Yes) */

@property (assign, nonatomic, getter=isAutomaticallyRefresh) BOOL automaticallyRefresh;



/** When there is much at the bottom of the control is automatically refresh(Default is 1.0，Is at the bottom of the control appears in full, will refresh automatically) */

@property (assign, nonatomic) CGFloat triggerAutomaticallyRefreshPercent;

@end

```



##  MJRefreshTrailer.h

```objc

@interface MJRefreshTrailer : MJRefreshComponent



/** 创建trailer */

+ (instancetype)trailerWithRefreshingBlock:(MJRefreshComponentAction)refreshingBlock;

/** 创建trailer */

+ (instancetype)trailerWithRefreshingTarget:(id)target refreshingAction:(SEL)action;



/** 忽略多少scrollView的contentInset的right */

@property (assign, nonatomic) CGFloat ignoredScrollViewContentInsetRight;



@end

```



## Reference

```objc

* Due to there are more functions of this framework，Don't write specific text describe its usage

* You can directly reference examples MJTableViewController、MJCollectionViewController、MJWebViewController，More intuitive and fast.

```




## The drop-down refresh 01-Default



```objc

self.tableView.mj_header = [MJRefreshNormalHeader headerWithRefreshingBlock:^{

   //Call this Block When enter the refresh status automatically 

}];

或

// Set the callback（Once you enter the refresh status，then call the action of target，that is call [self loadNewData]）

self.tableView.mj_header = [MJRefreshNormalHeader headerWithRefreshingTarget:self refreshingAction:@selector(loadNewData)];



// Enter the refresh status immediately

[self.tableView.mj_header beginRefreshing];

```

![(下拉刷新01-普通)](http://images0.cnblogs.com/blog2015/497279/201506/141204343486151.gif)



## The drop-down refresh 02-Animation image

```objc

// Set the callback（一Once you enter the refresh status，then call the action of target，that is call [self loadNewData]）

MJRefreshGifHeader *header = [MJRefreshGifHeader headerWithRefreshingTarget:self refreshingAction:@selector(loadNewData)];

// Set the ordinary state of animated images

[header setImages:idleImages forState:MJRefreshStateIdle];

// Set the pulling state of animated images（Enter the status of refreshing as soon as loosen）

[header setImages:pullingImages forState:MJRefreshStatePulling];

// Set the refreshing state of animated images

[header setImages:refreshingImages forState:MJRefreshStateRefreshing];

// Set header

self.tableView.mj_header = header;

```

![(下拉刷新02-动画图片)](http://images0.cnblogs.com/blog2015/497279/201506/141204402238389.gif)



## The drop-down refresh 03-Hide the time

```objc

// Hide the time

header.lastUpdatedTimeLabel.hidden = YES;

```

![(下拉刷新03-隐藏时间)](http://images0.cnblogs.com/blog2015/497279/201506/141204456132944.gif)



## The drop-down refresh 04-Hide status and time

```objc

// Hide the time

header.lastUpdatedTimeLabel.hidden = YES;



// Hide the status

header.stateLabel.hidden = YES;

```

![(下拉刷新04-隐藏状态和时间0)](http://images0.cnblogs.com/blog2015/497279/201506/141204508639539.gif)



## The drop-down refresh 05-DIY title

```objc

// Set title

[header setTitle:@"Pull down to refresh" forState:MJRefreshStateIdle];

[header setTitle:@"Release to refresh" forState:MJRefreshStatePulling];

[header setTitle:@"Loading ..." forState:MJRefreshStateRefreshing];



// Set font

header.stateLabel.font = [UIFont systemFontOfSize:15];

header.lastUpdatedTimeLabel.font = [UIFont systemFontOfSize:14];



// Set textColor

header.stateLabel.textColor = [UIColor redColor];

header.lastUpdatedTimeLabel.textColor = [UIColor blueColor];

```

![(下拉刷新05-自定义文字)](http://images0.cnblogs.com/blog2015/497279/201506/141204563633593.gif)



## The drop-down refresh 06-DIY the control of refresh

```objc

self.tableView.mj_header = [MJDIYHeader headerWithRefreshingTarget:self refreshingAction:@selector(loadNewData)];

// Implementation reference to MJDIYHeader.h和MJDIYHeader.m

```

![(下拉刷新06-自定义刷新控件)](http://images0.cnblogs.com/blog2015/497279/201506/141205019261159.gif)



## The pull to refresh 01-Default

```objc

self.tableView.mj_footer = [MJRefreshAutoNormalFooter footerWithRefreshingBlock:^{

    //Call this Block When enter the refresh status automatically

}];

或

// Set the callback（Once you enter the refresh status，then call the action of target，that is call [self loadMoreData]）

self.tableView.mj_footer = [MJRefreshAutoNormalFooter footerWithRefreshingTarget:self refreshingAction:@selector(loadMoreData)];

```

![(上拉刷新01-默认)](http://images0.cnblogs.com/blog2015/497279/201506/141205090047696.gif)



## The pull to refresh 02-Animation image

```objc

// Set the callback（Once you enter the refresh status，then call the action of target，that is call [self loadMoreData]）

MJRefreshAutoGifFooter *footer = [MJRefreshAutoGifFooter footerWithRefreshingTarget:self refreshingAction:@selector(loadMoreData)];



// Set the refresh image

[footer setImages:refreshingImages forState:MJRefreshStateRefreshing];



// Set footer

self.tableView.mj_footer = footer;

```

![(上拉刷新02-动画图片)](http://images0.cnblogs.com/blog2015/497279/201506/141205141445793.gif)



## The pull to refresh 03-Hide the title of refresh status

```objc

// Hide the title of refresh status

footer.refreshingTitleHidden = YES;

// If does have not above method，then use footer.stateLabel.hidden = YES;

```

![(上拉刷新03-隐藏刷新状态的文字)](http://images0.cnblogs.com/blog2015/497279/201506/141205200985774.gif)



## The pull to refresh 04-All loaded

```objc

//Become the status of NoMoreData

[footer noticeNoMoreData];

```

![(上拉刷新04-全部加载完毕)](http://images0.cnblogs.com/blog2015/497279/201506/141205248634686.gif)



## The pull to refresh 05-DIY title

```objc

// Set title

[footer setTitle:@"Click or drag up to refresh" forState:MJRefreshStateIdle];

[footer setTitle:@"Loading more ..." forState:MJRefreshStateRefreshing];

[footer setTitle:@"No more data" forState:MJRefreshStateNoMoreData];



// Set font

footer.stateLabel.font = [UIFont systemFontOfSize:17];



// Set textColor

footer.stateLabel.textColor = [UIColor blueColor];

```

![(上拉刷新05-自定义文字)](http://images0.cnblogs.com/blog2015/497279/201506/141205295511153.gif)



## The pull to refresh 06-Hidden After loaded

```objc

//Hidden current control of the pull to refresh

self.tableView.mj_footer.hidden = YES;

```

![(上拉刷新06-加载后隐藏)](http://images0.cnblogs.com/blog2015/497279/201506/141205343481821.gif)



## The pull to refresh 07-Automatic back of the pull01

```objc

self.tableView.mj_footer = [MJRefreshBackNormalFooter footerWithRefreshingTarget:self refreshingAction:@selector(loadMoreData)];

```

![(上拉刷新07-自动回弹的上拉01)](http://images0.cnblogs.com/blog2015/497279/201506/141205392239231.gif)



## The pull to refresh 08-Automatic back of the pull02

```objc

MJRefreshBackGifFooter *footer = [MJRefreshBackGifFooter footerWithRefreshingTarget:self refreshingAction:@selector(loadMoreData)];



// Set the normal state of the animated image

[footer setImages:idleImages forState:MJRefreshStateIdle];

//  Set the pulling state of animated images（Enter the status of refreshing as soon as loosen）

[footer setImages:pullingImages forState:MJRefreshStatePulling];

// Set the refreshing state of animated images

[footer setImages:refreshingImages forState:MJRefreshStateRefreshing];



// Set footer

self.tableView.mj_footer = footer;

```

![(上拉刷新07-自动回弹的上拉02)](http://images0.cnblogs.com/blog2015/497279/201506/141205441443628.gif)



## The pull to refresh 09-DIY the control of refresh(Automatic refresh)

```objc

self.tableView.mj_footer = [MJDIYAutoFooter footerWithRefreshingTarget:self refreshingAction:@selector(loadMoreData)];

// Implementation reference to MJDIYAutoFooter.h和MJDIYAutoFooter.m

```

![(上拉刷新09-自定义刷新控件(自动刷新))](http://images0.cnblogs.com/blog2015/497279/201506/141205500195866.gif)



## The pull to refresh 10-DIY the control of refresh(Automatic back)

```objc

self.tableView.mj_footer = [MJDIYBackFooter footerWithRefreshingTarget:self refreshingAction:@selector(loadMoreData)];

// Implementation reference to MJDIYBackFooter.h和MJDIYBackFooter.m

```

![(上拉刷新10-自定义刷新控件(自动回弹))](http://images0.cnblogs.com/blog2015/497279/201506/141205560666819.gif)



## UICollectionView01-The pull and drop-down refresh

```objc

// The drop-down refresh

self.collectionView.mj_header = [MJRefreshNormalHeader headerWithRefreshingBlock:^{

   //Call this Block When enter the refresh status automatically 

}];



// The pull to refresh

self.collectionView.mj_footer = [MJRefreshAutoNormalFooter footerWithRefreshingBlock:^{

   //Call this Block When enter the refresh status automatically

}];

```

![(UICollectionView01-上下拉刷新)](http://images0.cnblogs.com/blog2015/497279/201506/141206021603758.gif)



## UICollectionView02-The trailer refresh

```objc

// The trailer refresh

self.collectionView.mj_trailer = [MJRefreshNormalTrailer trailerWithRefreshingBlock:^{

   //Call this Block When enter the refresh status automatically 

}];



```

![(UICollectionView02-左拉刷新)](Gif/trailer_refresh.gif)



## WKWebView01-The drop-down refresh

```objc

//Add the control of The drop-down refresh

self.webView.scrollView.mj_header = [MJRefreshNormalHeader headerWithRefreshingBlock:^{

   //Call this Block When enter the refresh status automatically

}];

```

![(UICollectionView01-上下拉刷新)](http://images0.cnblogs.com/blog2015/497279/201506/141206080514524.gif)



## Remind

* ARC

* iOS>=9.0

* iPhone \ iPad screen anyway



## 寻求志同道合的小伙伴



- 因本人工作忙，没有太多时间去维护MJRefresh，在此向广大框架使用者说声：非常抱歉！😞

- 现寻求志同道合的小伙伴一起维护此框架，有兴趣的小伙伴可以[发邮件](mailto:[email protected])给我，非常感谢😊

- 如果一切OK，我将开放框架维护权限（github、pod等）

- 目前已经找到3位小伙伴(＾－＾)V