marty-suzuki / springindicator

SpringIndicator is indicator and PullToRefresh. Inspired by Material design components.

SpringIndicator

Appetize's Demo

• Refresher is a simple as UIRefreshControl.

• Don't need to add a UIScrollView delegate.

• Demo gif
  

• Image capture
  

Requirements

• Swift 3.1
• iOS 7.0 or later
• tvOS 9.0 or later

How to Install SpringIndicator

iOS 8+, tvOS

Cocoapods

Add the following to your Podfile:

pod "SpringIndicator"
use_frameworks!

Note: the use_frameworks! is required for pods made in Swift.

Carthage

Add the following to your Cartfile:

github "KyoheiG3/SpringIndicator"

iOS 7

Just add everything in the SpringIndicator.swift file to your project.

Usage

import

If target is ios8.0 or later, please import the SpringIndicator.

import SpringIndicator

Example

Add Code

let indicator = SpringIndicator(frame: CGRect(x: 100, y: 100, width: 60, height: 60))
view.addSubview(indicator)
indicator.startAnimation()

Refresher

let refreshControl = SpringIndicator.Refresher()
refreshControl.addTarget(self, action: "onRefresh", forControlEvents: .ValueChanged)
scrollView.addSubview(refreshControl)

Exit refresh

refreshControl.endRefreshing()

Can use Interface Builder

Variable

Indicator

@IBInspectable var animating: Bool

• Start the animation automatically in drawRect.

@IBInspectable var lineWidth: CGFloat

• Line thickness.

@IBInspectable var lineColor: UIColor

• Line Color.
• Default is gray.

@@IBInspectable var lineCap: Bool

• Cap style.
• Options are round or square. true is round.
• Default is false.

@IBInspectable var rotateDuration: Double

• Rotation duration.
• Default is 1.5.

@IBInspectable var strokeDuration: Double

• Stroke duration.
• Default is 0.7.

Refresher

let indicator: SpringIndicator

• Refresher Indicator.

var refreshing: Bool

• Refreshing status.

Function

Indicator

func isSpinning() -> Bool

• During stroke animation is true.

func startAnimation(_ expand: Bool = default)

• If start from a state in spread is true.

func stopAnimation(_ waitAnimation: Bool, completion: ((SpringIndicator.SpringIndicator) -> Swift.Void)? = default)

• true is wait for stroke animation.

func strokeRatio(_ ratio: CGFloat)

• between 0.0 and 1.0.

Refresher

func endRefreshing()

• Must be explicitly called when the refreshing has completed.

LICENSE

Under the MIT license. See LICENSE file for details.