shawnclovie / SpotPullRefresh

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

SpotPullRefresh

An easy way to use pull-to-refresh and pull-to-load-more. This repo was learn from MJRefresh, a famous pull-refresh component.

SwiftPackageManager Compatible

中文

Features

  • Pull Down from top to Refresh.
  • Pull Up from bottom to load more data.
  • Basic configuration to display refresh/load state.
  • Layout of pull views can be more diverse.
  • Text Easy to Localization.

Requirements

  • iOS 8.0+
  • Xcode 11
  • Swift 5.1

What kinds of controls to refresh can use it?

UIScrollView and all of subclass of it.

Installation

Swift Package Manager

Append dependence into your library's Package.swift

dependencies: [
.package(url: "https://github.com/shawnclovie/SpotPullRefresh", .branch("master")),
]

Or append with the URL and branch from menu "File - Swift Package - Add Package Dependency..."

Carthage

Append dependence into your Cartfile

github "shawnclovie/SpotPullRefresh" "master"

How to use

Please look code in SpotPullRefreshDemo/ViewController.swift for runnable example.

Kinds of controls

// Superclass of all other view
PullBaseView
  • Pull down Refresh
// Superclass of pull down refresh view
class PullRefreshView: PullBaseView

// View with state label and last updated time label
class PullRefreshStateView: PullRefreshView

// View with arrowView and indicator (show on loading, left of state label) 
class PullRefreshIndicationStateView: PullRefreshStateView

// View with imageView to present animation (show on loading)
class PullRefreshAnimationStateView: PullRefreshStateView

In your viewDidLoad():

let refresher = PullRefreshIndicationStateView { [weak self] in
	// do something like make URLRequest on sub thread
	...
	// after finished, notify refresher
	DispatchQueue.main.async {
		guard let self = self else {return}
		self.scrollView.spot_pullDownRefreshView?.endRefreshing()
	}
}
// do something to config refresher, e.g.
// setup arrowView, set image or add subviews (center to .zero)
// set stateTitleRenderer and lastUpdatedTimeTextRenderer of refresher for localization.
// refresher.lastUpdatedTimeLabelEnabled = true/false

scrollView.spot_pullDownRefreshView = refresher
  • Pull up Load more
// Superclass of pull up load view
class PullLoadView: PullBaseView

// View with state label
class PullLoadStateView: PullLoadView

// View with indicator (show on loading, left of state label) 
class PullLoadIndicationStateView: PullLoadStateView

// View with imageView to present animation (show on loading)
class PullLoadAnimationStateView: PullLoadStateView

In your viewDidLoad(), do almost same thing to make pull down view:

let moreDataLoader = PullLoadIndicationStateView { [weak self] in
	// do something like make URLRequest on sub thread
	...
	// after finished, notify moreDataLoader
	DispatchQueue.main.async {
		guard let self = self,
			let pullUp = self.tableView.spot_pullUpLoadView
			else {return}
		if /* did load all data and no more */ {
			pullUp.endRefreshingWithNoMoreData()
		} else {
			pullUp.endRefreshing()
		}
	}
}
// do something to config moreDataLoader, e.g.
// set moreDataLoader.stateTitleRenderer for localization.
scrollView.spot_pullUpLoadView = moreDataLoader

License

SpotPullRefresh is released under the MIT license.

About

License:MIT License


Languages

Language:Swift 100.0%