Skip to content

Latest commit

 

History

History
258 lines (190 loc) · 8.52 KB

README_CN.md

File metadata and controls

258 lines (190 loc) · 8.52 KB
Raw

logo

Infinity

基本介绍

Infinity是基于Swift3.0的为UIScrollView快速集成下拉刷新和上拉加载更多的开源库。Infinity有以下几个优点：

  1. 灵活性：完全支持自定义交互动画
  2. 易用性：一句代码集成/移除 下拉刷新功能
  3. 低伤害性：对UIScrollView的行为不造成影响，让你放心使用UIScrollView相关功能。

运行效果图 更多

screen1 screen1 screen1 screen1 screen1

集成

Carthaga

将下面代码添加到你的Cartfile里面

github "DanisFabric/Infninity"

手动添加

  1. 下载工程文件
  2. 将Infinity文件夹添加到你的工程里就OK了

使用方法

下拉刷新

集成的过程分为两步：

  1. 为下拉刷新操作指定动画(Infinity提供了基本的刷新动画)
  2. 将创建的动画指定给UIScrollView
let animator = DefaultRefreshAnimator(frame: CGRect(x: 0, y: 0, width: 24, height: 24))
tableView.fty.pullToRefresh.add(animator: animator) { [unowned self] in
            DispatchQueue.main.asyncAfter(deadline: .now() + 2) {
                print("end refreshing")
                self.tableView.fty.pullToRefresh.end()
            }
        }

停止刷新

tableView.fty.pullToRefresh.end()

移除

tableView.fty.pullToRefresh.remove()

代码触发刷新操作

tableView.fty.pullToRefresh.begin()

上拉加载更多

集成过程与【下拉刷新】完全相同

let animator = DefaultInfiniteAnimator(frame: CGRect(x: 0, y: 0, width: 30, height: 30))
tableView.fty.infiniteScroll.add(animator: animator) { [unowned self] in
            DispatchQueue.main.asyncAfter(deadline: .now() + 1.5) {
                self.tableView.fty.infiniteScroll.end()
            }
        }

停止

tableView.fty.infiniteScroll.end()

移除

tableView.fty.infiniteScroll.remove()

代码触发加载更多

tableView.fty.infiniteScroll.begin()

最佳实践

何时集成 & 移除组件

  • 在UIViewController的viewDidLoad方法里集成组件(推荐)
  • 在UIViewController的deinit里移除组件(必须)
	override func viewDidLoad() {
        super.viewDidLoad()

        let animator = DefaultRefreshAnimator(frame: CGRect(x: 0, y: 0, width: 24, height: 24))
				tableView.fty.pullToRefresh.add(animator: animator) { [unowned self] in
					// 耗时操作（数据库读取，网络读取）
					self.tableView.fty.pullToRefresh.end()	// 调用此方法来停止刷新的动画
				}

        let animator = DefaultInfiniteAnimator(frame: CGRect(x: 0, y: 0, width: 30, height: 30))
				tableView.fty.infiniteScroll.add(animator: animator) { [unowned self] in
					// 耗时操作（数据库读取，网络读取）
					self.tableView.fty.infiniteScroll.end()
				}
    }

    deinit {
			tableView.fty.pullToRefresh.remove()
			tableView.fty.infiniteScroll.remove()

			// 或者使用下面这句代码，和上面代码效果相同
			tableView.fty.clear()
    }

循环引用

weak-reference

如图，存在一个循环引用的链条，所以需要保证action->self 的引用为unowned的弱引用，self才能够得到正确的释放

automaticallyAdjustsScrollViewInsets

UIViewController有automaticallyAdjustsScrollViewInsets属性，当其为true时，viewController内的UIScrollView的contentInset会被自动调整为合适的值（自动调整的依据为UIViewController是否包含于UINavigationController和UITabBarController中）。这种自动调整会为下拉刷新带来一些意想不到的BUG。PullToRefresh等被使用较多的第三方库会出现进入新的viewController后回弹失效的问题。

Infinity为了彻底解决这个问题以及让用户能够清楚地知晓其scrollView的contentInset值。所以默认将automaticallyAdjustsScrollViewInsets设置为false。

推荐开发者自己设置scrollView的contentInset。

tableView.automaticallyAdjustsScrollViewInsets = false
tableView.contentInset = UIEdgeInsets(top: 64, left: 0, bottom: 0, right: 0)

绑定 VS 集成

下面代码是add和bind方法的定义，由定义可以看出，bind和add操作的参数是完全相同的。而实际上，add和bind操作唯一的区别就是：

  • add操作会将animator作为UIView添加到UIScrollView上。
  • bind操作不会对animator做任何事，只负责将下拉刷新/加载更多 的信息发给animator
// PullToRefresh
public func add(height: CGFloat = 60.0, animator: CustomPullToRefreshAnimator, action:(()->Void)?)
public func bind(height: CGFloat = 60.0, toAnimator: CustomPullToRefreshAnimator, action:(()->Void)?)

//InfinityScroll
public func add(height: CGFloat = 80.0, animator: CustomInfinityScrollAnimator, action: (() -> Void)?)
public func bind(height: CGFloat = 80.0, toAnimator: CustomInfinityScrollAnimator, action: (() -> Void)?)

bind操作提供了更多的灵活性。可以在示例项目里查看具体效果。

自定义动画

Infinity的动画是面向协议的：

public protocol CustomPullToRefreshAnimator {
    func animateState(state: PullToRefreshState)
}
public protocol CustomInfinityScrollAnimator {
    func animateState(state: InfinityScrollState)
}

你唯一要做的，就是实现对应的协议的animateState方法。根据具体的state来做动画就可以了。

下面来实现一个具体的animator看看动画实现多么简单：

class TextAnimator: UIView, CustomPullToRefreshAnimator {
    var textLabel = UILabel()

    override init(frame: CGRect) {
        super.init(frame: frame)

        textLabel.frame = self.bounds
        self.addSubview(textLabel)
    }
    required init?(coder aDecoder: NSCoder) {
        fatalError("init(coder:) has not been implemented")
    }
    func animateState(state: PullToRefreshState) {
        switch state {
        case .None:
            textLabel.text = "Pull Me To Refresh"
        case .Releasing(let progress):
            textLabel.text = String(progress)
        case .Loading:
            textLabel.text = "Loading ......."
        }
    }
}
// 在UIViewController的viewDidLoad使用TextAnimator
let animator = TextAnimator(frame: CGRect(x: 0, y: 0, width: 200, height: 24))
tableView.fty.pullToRefresh.add(animator: animator){ [unowned self] in
	// 耗时操作（数据库读取，网络读取）
	self.tableView.fty.pullToRefresh.end()
}

是不是很简单啊。而因为bind操作的存在，你甚至能够用任意类型来做animator，不一定要继承UIView。

其他

infinityStickToContent

  • true: 底部footer忽略contentInset.bottom距离，而直接紧跟在UIScrollView的content后面
  • false: 底部footer留出contentInset.bottom的距离。
  • 默认为true, 一般情况下使用默认就OK了。

联系方式

Email : DanisFabric

License

The MIT License (MIT)

Copyright © 2015 DanisFabric

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.