Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jcavar/refresher
DEPRECATED: Pull to refresh in Swift
https://github.com/jcavar/refresher
pull-to-refresh swift xcode
Last synced: about 1 month ago
JSON representation
DEPRECATED: Pull to refresh in Swift
- Host: GitHub
- URL: https://github.com/jcavar/refresher
- Owner: jcavar
- License: mit
- Created: 2014-08-27T15:35:09.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2019-08-24T17:55:25.000Z (about 5 years ago)
- Last Synced: 2024-07-07T06:22:58.987Z (3 months ago)
- Topics: pull-to-refresh, swift, xcode
- Language: Swift
- Homepage:
- Size: 1.12 MB
- Stars: 873
- Watchers: 35
- Forks: 99
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## DEPRECATED
This library is no longer maintained.
I am not using it in any of my projects, and I, unfortunately, don't have time to maintain it in my free time.
Please [open an issue](https://github.com/jcavar/refresher/issues/new) if you are willing to become the new maintainer.
[](https://travis-ci.org/jcavar/refresher)
Refresher is pull to refresh library written in Swift. It provides easy to use UIScrollView methods to add pull to refresh to your view.
Refresher also supports custom animations.
## Usage
### Basic usage
```swift
tableView.addPullToRefreshWithAction {
NSOperationQueue().addOperationWithBlock {
sleep(2)
NSOperationQueue.mainQueue().addOperationWithBlock {
self.tableView.stopPullToRefresh()
}
}
}
```
### Custom animations
Refresher supports custom animations on `PullToRefreshView`. You need to create object that conforms to `PullToRefreshViewAnimator` protocol.
Then, just pass your custom animator in `addPullToRefrshWithAction`:
```swift
tableView.addPullToRefreshWithAction({
NSOperationQueue().addOperationWithBlock {
sleep(2)
NSOperationQueue.mainQueue().addOperationWithBlock {
self.tableView.stopPullToRefresh()
}
}
}, withAnimator: CustomAnimator())
```
Required methods that your custom object need to implement are:
* `func pullToRefreshAnimationDidStart(view: PullToRefreshView)`- Called when user releases finger and when loading actually starts. Start your animations here.
* `func pullToRefreshAnimationDidEnd(view: PullToRefreshView)` - Called when animation is over. Perform any necessary after animation cleanup here.
* `func pullToRefresh(view: PullToRefreshView, progressDidChange progress: CGFloat)` - Called while user is pulling scroll view. Useful if you want to implement some kind of progress like behaviour.
* `func pullToRefresh(view: PullToRefreshView, stateDidChange state: PullToRefreshViewState)` - Called when `PullToRefreshView` changes its state
### Custom views
You can use your own custom `UIView` subclass as pull to refresh view.
```swift
if let customSubview = NSBundle.mainBundle().loadNibNamed("CustomSubview", owner: self, options: nil).first as? CustomSubview {
tableView.addPullToRefreshWithAction({
NSOperationQueue().addOperationWithBlock {
sleep(2)
NSOperationQueue.mainQueue().addOperationWithBlock {
self.tableView.stopPullToRefresh()
}
}
}, withAnimator: customSubview)
}
```
Your custom subclass has to conform to `PullToRefreshViewDelegate`.
## Requirements
* Xcode 6
* iOS 8.0
## Installation
### Git submodule
1. Add Refresher as a git submodule into your top-level project directory or simply copy whole folder
2. Find `PullToRefresh.xcodeproj` and drag it into the file navigator of your app project.
3. In Xcode, navigate to the target configuration window by clicking on the blue project icon, and selecting the application target under the "Targets" heading in the sidebar.
4. Under "General" panel go to "Linked Frameworks and Libraries" and add `Refresher.framework`
### Framework
1. Simply download Refresher
2. Build it and you should find `Refresher.framework` under "Products" group.
3. Right click on it and select "Show in Finder" option.
4. Just drag and drop `Refresher.framework` to your project
### Cocoapods
1. Add `pod 'Refresher'` to your Podfile
2. Run `pod install`
## Examples
## Credits
Refresher is created by [Josip Ćavar](https://twitter.com/josip04) and inspired by [SVPullToRefresh](https://github.com/samvermette/SVPullToRefresh/). If you have suggestions or bug reports, feel free to send pull request or [create new issue](https://github.com/jcavar/refresher/issues/new).