PullToRefresher 版本 3.3

PullToRefresher 版本 3.3

测试已测试
语言语言 SwiftSwift
许可证 MIT
发布最后发布2020年4月
SPM支持 SPM

Yalantis 维护。



PullToRefresher 版本 3.3

可定制的 PullToRefresh

此组件实现了纯拉的刷新逻辑,您可以使用它来开发自己的拉刷新动画,如下所示。

Yalantis

需求

  • iOS 8.0+
  • Swift 5.0 (v 3.2+)
  • Swift 4.2 (v 3.1+)
  • Swift 3 (v. 2.0+)
  • Swift 2 (v. 1.4)

安装

使用 CocoaPods

use_frameworks!
pod 'PullToRefresher'

使用 Carthage

github "Yalantis/PullToRefresh"

使用方法

首先,导入 PullToRefresh

import PullToRefresh

创建 PullToRefresh 的最简单方法

let refresher = PullToRefresh()

它将创建一个带有简单视图的默认拉取刷新,其中包含单个 UIActivitiIndicatorView。要将刷新器添加到您的 UIScrollView 子类中

tableView.addPullToRefresh(refresher) {
    // action to be performed (pull data from some source)
}

⚠️不要忘记在释放视图控制器时移除拉取刷新。⚠️

deinit {
    tableView.removeAllPullToRefresh()
}

操作完成且您想隐藏刷新器时

tableView.endRefreshing()

您也可以以编程方式启动刷新

tableView.startRefreshing()

尽管如此,您可能不会使用这个组件。 UITableViewControllerUICollectionViewController 已经有了一种简单的刷新类型。开发自己的拉取刷新控制可能更有趣。

在包含分区的 UITableView 中的使用方法

遗憾的是,目前不支持具有分区的 UITableView。但您可以通过两个步骤解决这个问题

  1. 创建您自己的 PullToRefresh(请参见以下说明)。
  2. 将其 shouldBeVisibleWhileScrolling 属性设置为 true。这使得您在滚动表格时始终可见。

⚠️默认情况下,PullToRefresh 具有透明背景,这会导致不受欢迎的叠加行为。⚠️

禁用/启用

您可以在运行时禁用/启用刷新器

yourRefresher.setEnable(isEnabled: false)

创建自定义 PullToRefresh

要创建一个自定义的刷新器,您需要使用两个对象初始化 PullToRefresh 类。

  • refreshView 是用于添加到您的滚动视图的 UIView 对象。
  • animator 是一个对象,根据 PullToRefresh 的状态对 refreshView 上的元素进行动画处理。
let awesomeRefresher = PullToRefresh(refresherView: yourView, animator: yourAnimator)

创建自定义 PullToRefresh 的步骤

  1. 使用 *.xib 创建自定义 UIView,并添加所有要动画的图像作为子视图,然后通过出口固定它们。
class RefreshView: UIView {

    @IBOutlet private var imageView: UIImageView!
  
    // and others
}
  1. 创建一个符合 RefreshViewAnimator 协议的 Animator 对象,它可以由您自定义的视图进行初始化。
class Animator: RefreshViewAnimator {

    private let refreshView: RefreshView
    
    init(refreshView: RefreshView) {
        self.refreshView = refreshView
    }

    func animate(state: State) {
        // animate refreshView according to state
    }
}
  1. 根据 RefreshViewAnimator 协议,您的动画器应该实现 animateState 方法。每当 PullToRefresh 对象的状态发生变化时,此方法就会被调用。有以下四种状态:
public enum State: Equatable, CustomStringConvertible {
    
    case initial
    case releasing(progress: CGFloat)
    case loading
    case finished
}
  • Initial - 刷新器准备好被拉动。
  • Releasing - 刷新器正在释放状态(由用户或程序释放)。此状态包含一个表示从 0 到 1 释放进度的双精度值。
  • Loading - 刷新器处于加载状态。
  • Finished - 加载完成。

根据您的动画器从 PullToRefresh 得到的状态,它必须对 refreshView 中的元素进行动画处理。

func animate(state: State) {
    switch state {
      case .initial: // do inital layout for elements
      case .releasing(let progress): // animate elements according to progress
      case .loading: // start loading animations
      case .finished: // show some finished state if needed
    }
}

将动画的魔法放在取消注释的行中。

  1. 出于方便起见,您可以继承自 PullToRefresh,并为您的刷新器创建单独的类
class AwesomePullToRefresh: PullToRefresh {

    convenience init() {
        let refreshView = Bundle(for: type(of: self)).loadNibNamed("RefreshView", owner: nil, options: nil)!.first as! RefreshView
        let animator = Animator(refreshView: refreshView)
        self.init(refreshView: refreshView, animator: animator)
    }
}
  1. 最后,将刷新器添加到 UIScrollView 子类。
tableView.addPullToRefresh(refresher) {
    // action to be performed (pull data from some source)
}

祝您快乐! :)

通知我们!

如果您向我们的项目发送您使用我们的组件的链接,我们将非常高兴。只需发送电子邮件到 [email protected]。如有关于动画的任何问题或建议,也请告知我们。

编者按。我们将发布更多的代码中的美妙事物,以及一篇关于如何将 iOS (Android) 的 UI 制作得比更好更好的教程。敬请期待!

许可

The MIT License (MIT)

Copyright © 2018 Yalantis

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.