Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/KyoheiG3/SpringIndicator
SpringIndicator is indicator and PullToRefresh. Inspired by Material design components.
https://github.com/KyoheiG3/SpringIndicator
Last synced: about 2 months ago
JSON representation
SpringIndicator is indicator and PullToRefresh. Inspired by Material design components.
- Host: GitHub
- URL: https://github.com/KyoheiG3/SpringIndicator
- Owner: KyoheiG3
- License: mit
- Created: 2015-03-05T17:35:02.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2020-09-21T23:50:36.000Z (over 4 years ago)
- Last Synced: 2024-11-16T04:06:55.301Z (2 months ago)
- Language: Swift
- Homepage:
- Size: 139 KB
- Stars: 272
- Watchers: 10
- Forks: 33
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - SpringIndicator - SpringIndicator is indicator and PullToRefresh. Inspired by Material design components.【 [Preview](https://user-images.githubusercontent.com/5707132/55774407-f49a6500-5acf-11e9-9e36-9248e89d7ff1.gif) 】 (OOM-Leaks-Crash / HUD-Indicator)
README
# SpringIndicator
[](https://github.com/Carthage/Carthage)
[](http://cocoadocs.org/docsets/SpringIndicator)
[](http://cocoadocs.org/docsets/SpringIndicator)
[](http://cocoadocs.org/docsets/SpringIndicator)
#### [Appetize's Demo](https://appetize.io/app/taw1k1486yhxqy35gv7jrver7g)
* Refresher is a simple as UIRefreshControl.
* Don't need to add a UIScrollView delegate.
## Requirements
- Swift 5
- iOS 8.0 or later
- tvOS 9.0 or later
## How to Install SpringIndicator
#### Cocoapods
Add the following to your `Podfile`:
```Ruby
pod "SpringIndicator"
```
#### Carthage
Add the following to your `Cartfile`:
```Ruby
github "KyoheiG3/SpringIndicator"
```
### Swift Package Manager
To install BulletinBoard using the [Swift Package Manager](https://swift.org/package-manager/), add this dependency to your Package.swift file:
```swift
.package(url: "https://github.com/KyoheiG3/SpringIndicator.git", from: "5.1.0")
```
## Usage
### Example
Add Code
```swift
let indicator = SpringIndicator(frame: CGRect(x: 100, y: 100, width: 60, height: 60))
view.addSubview(indicator)
indicator.start()
```
RefreshIndicator
```swift
let refreshControl = RefreshIndicator()
refreshControl.addTarget(self, action: "onRefresh", forControlEvents: .ValueChanged)
scrollView.addSubview(refreshControl)
```
Exit refresh
```swift
refreshControl.endRefreshing()
```
Can use Interface Builder
### Variable
#### Indicator
```swift
@IBInspectable var animating: Bool
```
* Start the animation automatically in `drawRect`.
```swift
@IBInspectable var lineWidth: CGFloat
```
* Line thickness.
```swift
@IBInspectable var lineColor: UIColor
```
* Line Color.
* Default is `gray`.
```swift
var lineColors: [UIColor]
```
* Line Colors.
* Can change some colors during rotation.
* If set, `lineColor` is not used.
```swift
@IBInspectable var lineCap: Bool
```
* Cap style.
* Options are `round` or `square`. true is `round`.
* Default is `false`.
```swift
@IBInspectable var rotateDuration: Double
```
* Rotation duration.
* Default is `1.5`.
#### RefreshIndicator
```swift
let indicator: SpringIndicator
```
* Indicator for refresh control.
```swift
var isRefreshing: Bool
```
* Refreshing status.
### Function
#### Indicator
```swift
var isSpinning: Bool
```
* During stroke animation is `true`.
```swift
func start()
```
* Start animating.
```swift
func stop(with: Bool = default, completion: ((SpringIndicator) -> Swift.Void)? = default)
```
* Stop animating.
* If true, waiting for stroke animation.
```swift
func strokeRatio(_ ratio: CGFloat)
```
* between `0.0` and `1.0`.
#### Refresher
```swift
func endRefreshing()
```
* Must be explicitly called when the refreshing has completed.
## Author
#### Kyohei Ito
- [GitHub](https://github.com/kyoheig3)
- [Twitter](https://twitter.com/kyoheig3)
Follow me 🎉
## LICENSE
Under the MIT license. See LICENSE file for details.