https://github.com/nextdoor/ndrefresh

Flexible pull to refresh control for iOS, written in Swift.
https://github.com/nextdoor/ndrefresh

Last synced: 10 months ago
JSON representation

Flexible pull to refresh control for iOS, written in Swift.

• Host: GitHub
• URL: https://github.com/nextdoor/ndrefresh
• Owner: Nextdoor
• License: other
• Created: 2015-07-17T21:47:17.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2015-08-11T04:47:37.000Z (almost 11 years ago)
• Last Synced: 2025-04-10T03:33:36.586Z (over 1 year ago)
• Language: Swift
• Homepage:
• Size: 1.96 MB
• Stars: 10
• Watchers: 31
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# NDRefresh

![Apache](https://img.shields.io/hexpm/l/plug.svg) [![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Nextdoor/NDRefresh) [![Build Status](https://travis-ci.org/Nextdoor/NDRefresh.svg?branch=master)](https://travis-ci.org/Nextdoor/NDRefresh)

NDRefresh is a flexible custom pull-to-refresh control for [UIScrollView](https://developer.apple.com/library/ios/documentation/UIKit/Reference/UIScrollView_Class/) of iOS apps. It's written in Swift, but it can be used in both Swift and Objective-C projects.

## Demo

NDRefresh displays whatever view you define. 

Here's a demo using UIImageView:

![UIImageView](./assets/UIImageView.gif)

We discover that you get extremely flexible if you are using UIWebView, as you can push HTML/js/css snippets from your server side:

![UIImageView](./assets/UIWebView.gif)

Of course, you can put multiple views together to get creative:

![UIImageView](./assets/MultiView.gif)

## Usage

### Swift

(*Please see [NDRefreshSwiftExample](https://github.com/Nextdoor/NDRefresh/tree/master/NDRefreshSwiftExample) for an example app using NDRefresh, written in Swift*)

Step 1: Declare an object property in your `UIViewController`:

	

    var refreshCtrl: NDRefreshControl?

	

Step 2: In `viewDidLoad()` of your `UIViewController`, initialize a `UIView` and register closures to `refreshCtrl`:

    // Create a view. Make sure you set up its frame

    let refreshView = MyAwesomeView(frame: ...)

    

    // scrollView could be any subclass of UIScrollView, e.g., UITableView

    var refreshCtrl = NDRefreshControl(refreshView: refreshView, scrollView: scrollView)

    refreshCtrl?.renderIdleClosure = renderIdleHandler

    refreshCtrl?.renderRefreshClosure = renderRefreshHandler

    refreshCtrl?.renderPullingClosure = renderPullingHandler

    refreshCtrl?.renderReadyForRefreshClosure = renderReadyForRefreshHandler 

Step 3: `viewDidAppear()` of your `UIViewController`:

    

    refreshCtrl?.configureForRefresh()

    

Step 4: Implement closures:

    // All closures have the same function signature

    func renderIdleHandler(refreshControl: NDRefreshControl) {

        var refreshView = refreshControl.refreshView as! MyAwesomeView

            var scrollView = refreshControl.scrollView

        // Do something

    }

Optional step: Call this function whenever you want to programmatically pull to refresh: 

    refreshCtrl?.beginRefresh()

    

### Objective-C

(*Please see [NDRefreshObjcExample](https://github.com/Nextdoor/NDRefresh/tree/master/NDRefreshObjcExample) for an example app using NDRefresh, written in Objective-C*)

Step 1: Declare an object property in your `UIViewController`:

	

	@property (nonatomic, strong) NDRefreshControl *control;

	

Step 2: In `viewDidLoad()` of your `UIViewController`, initialize a `UIView` and register closures to `refreshCtrl`:

    // Create a view. Make sure you set up its frame

    MyAwesomeView *refreshView = [[MyAwesomeView alloc] initWithFrame ...]

    // scrollView could be any subclass of UIScrollView, e.g., UITableView    

    self.control = [[NDRefreshControl alloc] initWithRefreshView:refreshView scrollView:scrollView];

    self.control.renderIdleClosure = ^(NDRefreshControl *refreshControl) {

    };

    self.control.renderPullingClosure = ^(NDRefreshControl *refreshControl) {

    };

    self.control.renderReadyForRefreshClosure = ^(NDRefreshControl *refreshControl) {

    };

    self.control.renderRefreshClosure = ^(NDRefreshControl *refreshControl) {

        // This is to emulate expensive network request.

        dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(2 * NSEC_PER_SEC)), dispatch_get_main_queue(), ^{

            [refreshControl endRefresh];

        });

    };

Step 3: `viewDidAppear()` of your `UIViewController`:

    

    [self.control configureForRefresh];

Optional step: Call this function whenever you want to programmatically pull to refresh: 

    [self.control beginRefresh];

## Installation

### Carthage

NDRefresh is available through [Carthage](https://github.com/Carthage/Carthage), to install it simply add the following line to your Cartfile:

    	

    github "Nextdoor/NDRefresh"

### Manual installation

Add the `NDRefresh/NDRefresh/NDRefreshControl.swift` into your project.

## Requirements

* Xcode 6.3+

* iOS 8.0+

## License

    The Apache License 2.0

    Copyright 2015 Nextdoor.com Inc.

    Licensed under the Apache License, Version 2.0 (the "License");

    you may not use this file except in compliance with the License.

    You may obtain a copy of the License at

        http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software

    distributed under the License is distributed on an "AS IS" BASIS,

    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

    See the License for the specific language governing permissions and

    limitations under the License.