https://github.com/andreamazz/GearRefreshControl

A custom animation for the UIRefreshControl
https://github.com/andreamazz/GearRefreshControl

Last synced: 3 months ago
JSON representation

A custom animation for the UIRefreshControl

• Host: GitHub
• URL: https://github.com/andreamazz/GearRefreshControl
• Owner: andreamazz
• License: mit
• Created: 2015-03-18T14:47:51.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-08-28T06:52:23.000Z (about 7 years ago)
• Last Synced: 2024-04-14T15:07:05.968Z (7 months ago)
• Language: Swift
• Size: 549 KB
• Stars: 617
• Watchers: 13
• Forks: 51
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-ios - GearRefreshControl - A custom animation for the UIRefreshControl. (UI / Activity Indicator)
• awesome-ios-star - GearRefreshControl - A custom animation for the UIRefreshControl. (UI / Activity Indicator)

README

        


  



[![CocoaPods](https://cocoapod-badges.herokuapp.com/v/GearRefreshControl/badge.svg)](http://cocoapods.org/?q=gearrefreshcontrol)

[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)

![Swift 3.0](https://img.shields.io/badge/swift-3.0-orange.svg)

A custom animation for the UIRefreshControl. Inspired by this [Dribble shot](https://dribbble.com/shots/1974767-gear-powered-pull-to-refresh-animation?list=animated&sort=popular&timeframe=now&offset=19) and [this tutorial](http://www.jackrabbitmobile.com/design/ios-custom-pull-to-refresh-control/).



  

    

  



# Screenshot

![GearRefreshControl](https://raw.githubusercontent.com/andreamazz/GearRefreshControl/master/assets/screenshot.gif)

# Usage

Install through [CocoaPods](http://cocoapods.org)

```

pod 'GearRefreshControl', '~> 1.0.0'

use_frameworks!

```

Setup your `refreshControl`:

```swift

override func viewDidLoad() {

    super.viewDidLoad()

    gearRefreshControl = GearRefreshControl(frame: self.view.bounds)

    gearRefreshControl.addTarget(self, action: #selector(ViewController.refresh), for: UIControlEvents.valueChanged)

    self.refreshControl = gearRefreshControl

}

```

Update state:

```swift

override func scrollViewDidScroll(_ scrollView: UIScrollView) {

    gearRefreshControl.scrollViewDidScroll(scrollView)

}

```

Stop the animation on completion:

```swift

self.gearRefreshControl.endRefreshing()

```

## Customization

You can customize the color of the control by setting the `gearTintColor` property:

```swift

gearRefreshControl.gearTintColor = .red

```

Checkout the sample project for the full implementation.

# Author

[Andrea Mazzini](https://twitter.com/theandreamazz). I'm available for freelance work, feel free to contact me.

Want to support the development of [these free libraries](https://cocoapods.org/owners/734)? Buy me a coffee ☕️ via [Paypal](https://www.paypal.me/andreamazzini).  

# Contributors

Thanks to [everyone](https://github.com/andreamazz/GearRefreshControl/graphs/contributors) kind enough to submit a pull request.

# MIT License

	Copyright (c) 2017 Andrea Mazzini. All rights reserved.

	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.