Skip to content

Commit cdb2eaa

Browse files
committed
update README.md
1 parent 5f40a45 commit cdb2eaa

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ react-native-animated-pagination-dot
44
Paginate component for React native simple dot with **moving animation**
55

66
-----
7-
![download](https://img.shields.io/npm/dm/react-native-animated-pagination-dot?logo=npm&style=flat-square)
8-
![npm version](https://img.shields.io/npm/v/react-native-animated-pagination-dot?style=flat-square)
9-
![stars](https://img.shields.io/github/stars/rouge3351/react-native-animated-pagination-dot?logo=github&style=flat-square)
7+
[![download](https://img.shields.io/npm/dm/react-native-animated-pagination-dot?logo=npm&style=flat-square)](https://www.npmjs.com/package/react-native-animated-pagination-dot)
8+
[![npm version](https://img.shields.io/npm/v/react-native-animated-pagination-dot?style=flat-square)](https://www.npmjs.com/package/react-native-animated-pagination-dot)
9+
[![stars](https://img.shields.io/github/stars/rouge3351/react-native-animated-pagination-dot?logo=github&style=flat-square)](https://github.com/rouge3351/react-native-animated-pagination-dot)
1010
-----
1111

1212
## Installation
@@ -56,19 +56,21 @@ export default ExampleDotPaginate;
5656
-----
5757
## Example
5858

59-
<img src="https://user-images.githubusercontent.com/4319422/91634767-df5c0880-ea2d-11ea-90f6-ae7bb4030325.gif" alt="Pagination Dot Demo" width="250"/>
59+
<img src="https://user-images.githubusercontent.com/4319422/92298858-39a61d80-ef88-11ea-85dd-e7a4a5c115dc.gif" alt="Pagination Dot Demo" width="320"/>
6060

6161
-----
6262
## API
6363

6464
### Props
6565

66-
| **Prop** | **Type** | **Description** |
67-
| --------------------------- | -------------------------------- | --------------------------------------------------- |
68-
| `curPage` | `number` | Pagination curernt Page |
69-
| `maxPage` | `number` | Total Page in Pagination |
70-
| `activeDotColor` | `string` | Active Dot Color. dot will control by opacity |
71-
| `sizeRatio` | `number`(default. 1.0) | Customize Dot Size. minimum value is 1.0 (recommend value is 1.0 ~ 2.0) |
66+
| **Prop** | **Type** | **Required(Default Value)** | **Description** |
67+
| --------------------------- | ----------------------------| ---------------------------- | --------------------------------------------------- |
68+
| `curPage` | `number` | required | Pagination curernt Page |
69+
| `maxPage` | `number` | required | Total Page in Pagination |
70+
| `activeDotColor` | `string` | required | Active Dot Color. dot will control by opacity |
71+
| `sizeRatio` | `number` | 0.1 | Customize Dot Size. minimum value is 1.0 (*recommend 1.0 ~ 2.0*) |
72+
| `vertical` | `boolean` | false | Dot direction |
73+
7274

7375

7476
## License

0 commit comments

Comments
 (0)