https://github.com/summerhf/zhrefresh
刷新控件
https://github.com/summerhf/zhrefresh
refreshcontrol swift4 uicollectionview uiscrollview uitableview
Last synced: 4 months ago
JSON representation
刷新控件
- Host: GitHub
- URL: https://github.com/summerhf/zhrefresh
- Owner: SummerHF
- License: mit
- Created: 2018-04-27T05:46:22.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-07-09T07:59:26.000Z (over 7 years ago)
- Last Synced: 2025-10-05T19:48:56.357Z (5 months ago)
- Topics: refreshcontrol, swift4, uicollectionview, uiscrollview, uitableview
- Language: Swift
- Size: 826 KB
- Stars: 22
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
ZHRefresh
Swift版的刷新控件, MJRefresh的翻版
## Contents
swift版的下拉刷新框架, 一行代码搞定上拉加载, 下拉刷新
* 开始使用
* [Features 【支持哪些控件刷新】](#Features)
* [Installation 【如何安装】](#Install)
* [Class structure 【类结构】](#structure)
* 常见API
* [ZHRefreshComponent.swift](#ZHRefreshComponent.swift)
* [ZHRefreshHeader.swift](#ZHRefreshHeader.swift)
* [ZHRefreshFooter.swift](#ZHRefreshFooter.swift)
* [ZHRefresh.swift](#ZHRefresh.swift)
* 使用例子
* [参考](#参考)
* [下拉刷新(仿QQ阅读)](#the_drop_down_qq_reader)
* [下拉刷新(默认)](#the_drop_down_default)
* [下拉刷新(动画图片)](#the_drop_down_animate)
* 由于demo较多, 就不一一截图了, 有需要的可以自行下载运行...
----------
### 支持哪些控件刷新
继承自UIScollView的类都可以使用.如
UIScrollView, UITableView, UICollectionView, WKWebView, UIWebView...
因为该框架是基于swift的, 所以请确保打开use_frameworks!的注释, 允许使用动态库.
```
pod 'ZHRefresh'
```
然后
```
pod install
```
在需要使用该框架的地方
```
import ZHRefresh
```
即可
---------------
### 类结构
```swift
/// 正在刷新的回调
public var refreshingBlock: ZHRefreshComponentRefreshingBlock?
/// 开始刷新后的回调(进入刷新状态后的回调)
public var beginRefreshingCompletionBlock: ZHRefreshComponentbeiginRefreshingCompletionBlock?
/// 结束刷新的回调
public var endRefreshingCompletionBlock: ZHRefreshComponentEndRefreshingCompletionBlock?
/// 回调对象
public weak var refreshTarget: AnyObject?
/// 回调方法
public var refreshAction: Selector?
```
```swift
/// 类方法, 快速的创建下拉刷新控件
public static func headerWithRefresing(target: AnyObject, action: Selector) -> ZHRefreshHeader
/// 类方法, 快速的创建带有正在刷新回调的下拉刷新控件
public static func headerWithRefreshing(block: @escaping ZHRefreshComponentRefreshingBlock) -> ZHRefreshHeader
/// 忽略多少scrollView的contentInset的top
public var ignoredScrollViewContentInsetTop: CGFloat = 0.0
/// 上一次下拉刷新成功的时间
public var lastUpdatedTime: Date?
```
```swift
/// 带有回调target和action的footer
static public func footerWithRefreshing(target: AnyObject, action: Selector) -> ZHRefreshFooter
/// 类方法, 创建footer
static public func footerWithRefreshing(block: @escaping ZHRefreshComponentRefreshingBlock) -> ZHRefreshFooter
/// 提示没有更多数据
public func endRefreshingWithNoMoreData()
/// 重置没有更多数据
public func resetNoMoreData()
```
```swift
/// header and footer
public extension UIScrollView {
/// header
@objc dynamic var header: ZHRefreshHeader? {
get {
return objc_getAssociatedObject(self, &ZHRefreshKeys.header) as? ZHRefreshHeader
}
set {
if let newHeader = newValue {
if let oldHeader = header {
/// 如果有旧值, 删除它
oldHeader.removeFromSuperview()
}
/// 添加新的
self.insertSubview(newHeader, at: 0)
/// 存储新值
objc_setAssociatedObject(self, &ZHRefreshKeys.header, newValue, objc_AssociationPolicy.OBJC_ASSOCIATION_ASSIGN)
}
}
}
/// footer
@objc dynamic var footer: ZHRefreshFooter? {
get {
return objc_getAssociatedObject(self, &ZHRefreshKeys.footer) as? ZHRefreshFooter
}
set {
if let newFooter = newValue {
if let oldFooter = footer {
/// 如果有旧值, 删除它
oldFooter.removeFromSuperview()
}
/// 添加新值
self.insertSubview(newFooter, at: 0)
/// 存储新值
objc_setAssociatedObject(self, &ZHRefreshKeys.footer, newValue, objc_AssociationPolicy.OBJC_ASSOCIATION_ASSIGN)
}
}
}
}
```
## 参考
请下载[源程序](https://github.com/SummerHF/ZHRefresh), 并打开附带的`demo`程序 `Example`->`ZHRefresh.xcworkspace`
* `MainViewController.swift` 主入口
* `CollectionViewController.swift` 提供`collectionView相关`的实例程序
* `TableViewController.swift`提供`tableView相关`的实例程序
* `WebViewController.swift`提供`webView相关`的实例程序
* `Example.swift`提供模型数据
具体结构如下图:
以下截屏皆取自`iPhoneX`
code:
```swift
// MARK: - 下拉刷新 默认样式
/// 添加刷新控件
self.tableView.header = ZHDIYQQReaderHeader.headerWithRefreshing { [weak self] in
guard let `self` = self else { return }
self.loadQQReaderNewData()
}
/// 开始刷新
self.tableView.header?.beginRefreshing()
/// 结束刷新
(self.tableView.header as? ZHDIYQQReaderHeader)?.endRefreshWith(success: true)
```
screenShots:
code:
```swift
// MARK: - 下拉刷新 默认样式
@objc func action01() {
/// 设置回调, 一旦进入刷新状态 就会调用block
self.tableView.header = ZHRefreshNormalHeader.headerWithRefreshing { [weak self] in
guard let `self` = self else { return }
self.loadNewData()
}
/// 进入刷新状态
self.tableView.header?.beginRefreshing()
}
```
screenShots:
code:
```swift
// MARK: - 下拉刷新 动态图片
@objc func action02() {
/// 一旦进入刷新状态 就会调用target的action, 也就是调用self的loadNewData
self.tableView.header = ZHRefreshChiBaoZiHeader.headerWithRefresing(target: self, action: #selector(loadNewData))
self.tableView.header?.beginRefreshing()
}
```
screenShots:
