Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/silentcloud/react-native-page-control

Page Control for React Native, like iOS UIPageControl, APIs are same as UIPageControl
https://github.com/silentcloud/react-native-page-control

Last synced: 28 days ago
JSON representation

Page Control for React Native, like iOS UIPageControl, APIs are same as UIPageControl

Lists

README

        

# react-native-page-control

Page Control for React Native, like iOS UIPageControl, APIs are same as UIPageControl

## Installation

```bash
$ npm install react-native-page-control --save
```

## Demo

![page control demo](http://silentcloud.github.io/upload/pagecontrol.gif)

## Example

```jsx
import PageControl from 'react-native-page-control';

```

## API (props)

| Prop | Required | Default | Type | Description |
| :------------ |:---:|:---------------:| :---------------:| :-----|
| numberOfPages | YES | `0` | `number` | The number of pages the receiver shows (as dots) |
| currentPage | NO | `0` | `number` |The current page, shown by the receiver as a white dot |
| hidesForSinglePage | NO | `false` | `bool` | A Boolean value that controls whether the page control is hidden when there is only one page |
| pageIndicatorTintColor | NO | `gray` | `string` | The tint color to be used for the page indicator. |
| currentPageIndicatorTintColor | NO |`white` | `string` | The tint color to be used for the current page indicator. |
| indicatorStyle | NO | `{}` | `object` | style for the page indicator |
| currentIndicatorStyle | NO |`{}` | `object` | style for the current page indicator. |
| onPageIndicatorPress | NO | function(index){} | `func` | page indicator press hook function. `param: index` current press indicator index|

## Development

```bash
$ yarn
$ npm run init
$ npm run start
$ react-native run-ios
```