Update README.md
This commit is contained in:
Looping
parent
cc360cc06f
commit
0e975cef85
|
|
@ -1,7 +1,7 @@
|
|||
Pod::Spec.new do |s|
|
||||
s.name = "RCPageControl"
|
||||
s.version = "0.1"
|
||||
s.summary = "Yet another page control for iOS, with awesome animation powered by facebook pop library and highly customizable UI."
|
||||
s.summary = "Yet another page control for iOS, with awesome animation powered by facebook pop library."
|
||||
s.homepage = "https://github.com/RidgeCorn/RCPageControl"
|
||||
s.license = { :type => "MIT", :file => "LICENSE" }
|
||||
s.authors = { "Looping" => "www.looping@gmail.com" }
|
||||
|
|
|
|||
168
README.md
168
README.md
|
|
@ -1,4 +1,166 @@
|
|||
RCPageControl
|
||||
=============
|
||||
# RCPageControl
|
||||
|
||||
Yet another UI page control for iOS
|
||||
[](https://github.com/RidgeCorn/RCPageControl/blob/master/LICENSE)
|
||||
[](https://github.com/RidgeCorn/RCPageControl)
|
||||
[](https://github.com/RidgeCorn/RCPageControl)
|
||||
[](https://travis-ci.org/RidgeCorn/RCPageControl)
|
||||
|
||||
Yet another page control for iOS, with awesome animation powered by Facebook `pop` library.
|
||||
|
||||
<img src="https://github.com/RidgeCorn/RCPageControl/raw/master/RCPageControlDemo.gif" alt="RCPageControlDemo" width="320" height="568" />
|
||||
|
||||
|
||||
**Any idea to make this more awesome? Please feel free to open an issue or make a PR.**
|
||||
|
||||
|
||||
|
||||
## Requirements
|
||||
* Xcode 6.1 or higher
|
||||
* iOS 6.0 or higher
|
||||
* ARC
|
||||
* [pop animation library](https://github.com/facebook/pop)
|
||||
|
||||
|
||||
|
||||
## Run Example
|
||||
|
||||
In your terminal,
|
||||
|
||||
``` bash
|
||||
cd [workspace]/RCPageControl/RCPageControlExample
|
||||
pod install
|
||||
```
|
||||
|
||||
Then,
|
||||
|
||||
``` bash
|
||||
open RCPageControlExample.xcworkspace
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
|
||||
The recommended approach for installating `RCPageControl` is via the [CocoaPods](http://cocoapods.org/) package manager.
|
||||
|
||||
In your `Podfile`, add a line shows below:
|
||||
|
||||
``` bash
|
||||
pod 'RCPageControl'
|
||||
```
|
||||
|
||||
Then,
|
||||
|
||||
``` bash
|
||||
pod update
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
The API of `RCPageControl` is highly similar
|
||||
as `UIPageControl`.
|
||||
|
||||
|
||||
|
||||
### First of all
|
||||
|
||||
```objective-c
|
||||
#import <RCPageControl.h>
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Initialization
|
||||
|
||||
|
||||
#### Using `initWithFrame:`
|
||||
|
||||
```objective-c
|
||||
RCPageControl *pageControl = [RCPageControl initWithFrame:CGRectMake(0, 0, 100, 10)];
|
||||
```
|
||||
|
||||
|
||||
#### Using `initWithNumberOfPages:`
|
||||
|
||||
```objective-c
|
||||
RCPageControl *pageControl = [RCPageControl initWithNumberOfPages:5];
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Callback
|
||||
|
||||
|
||||
#### Using `UIControlEvent`
|
||||
|
||||
```objective-c
|
||||
[pageControl addTarget:self action:@selector(changePage:) forControlEvents:UIControlEventValueChanged];
|
||||
```
|
||||
|
||||
|
||||
#### Using `RCCurrentPageChangedBlock`
|
||||
|
||||
```objective-c
|
||||
[pageControl setCurrentPageChangedBlock:^(RCPageControl *pageControl) {
|
||||
//Code here
|
||||
}];
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Properties
|
||||
|
||||
Just list new properties of `RCPageControl`.
|
||||
|
||||
|
||||
#### indicatorDotGap
|
||||
The distance between two dots from their edges. Default value is `10.f`, cannot be smaller than `2.f`.
|
||||
|
||||
|
||||
#### indicatorDotWidth
|
||||
The width of dot, you may assume that the dot is likes a circle. Default value is `4.f`, cannot be smaller than `2.f`.
|
||||
|
||||
|
||||
#### animationSpeed & animationBounciness
|
||||
We use `POPSpringAnimation` for dots animation. See [POPSpringAnimation.h](https://github.com/facebook/pop/blob/master/pop/POPSpringAnimation.h) for more info.
|
||||
|
||||
|
||||
#### animationDuration
|
||||
The duration for `UIView animation`. Using in `_indicatorIndexLabel` animation. Only available when `hideCurrentPageIndex` is setting to `NO`. Default is `0.6f`. We will using `POPBasicAnimation` for next released version.
|
||||
|
||||
|
||||
#### animationScaleFactor
|
||||
The dot scale factor. Using to calculate the width of current dot. Default is `2`.
|
||||
|
||||
|
||||
#### hideCurrentPageIndex
|
||||
When set to `YES`, the `Page Index Label` will be hidden. Default is `NO`. The displayed page is start from `1`.
|
||||
|
||||
|
||||
#### disableAnimation
|
||||
When set to `YES`, all indicator dots' changing animation will be disabled. Default is `NO`.
|
||||
|
||||
|
||||
#### pageIndicatorTintColor
|
||||
The dot background color. Default is `[UIColor lightTextColor]`.
|
||||
|
||||
|
||||
#### currentPageIndicatorTintColor
|
||||
The current dot background color. Default is `[UIColor whiteColor]`.
|
||||
|
||||
|
||||
#### currentPageIndexTextTintColor
|
||||
The `Page Index Label`'s `TextColor`. Default is `[UIColor darkTextColor]`.
|
||||
|
||||
|
||||
#### currentPageIndexTextFont
|
||||
The `Page Index Label`'s `Font`. Default is `[UIFont systemFontOfSize:0]`. The font size will automatically adjusts by the value of `indicatorDotWidth` and `animationScaleFactor`
|
||||
|
||||
|
||||
|
||||
## License
|
||||
|
||||
RCPageControl is available under the MIT license. See the [LICENSE](https://github.com/RidgeCorn/RCPageControl/blob/master/LICENSE) file for more info.
|
||||
|
|
|
|||
Loading…
Reference in New Issue