best-react-pagination 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -13
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -28,18 +28,23 @@ const YourComponent: FC = () => {
|
|
|
28
28
|
};
|
|
29
29
|
```
|
|
30
30
|
|
|
31
|
+
#### Example https://codesandbox.io/s/lingering-breeze-gh2dk
|
|
32
|
+
|
|
31
33
|
## Props
|
|
32
34
|
|
|
33
|
-
| Name | Type
|
|
34
|
-
| -------------------
|
|
35
|
-
| `paginationStart` | `Number`
|
|
36
|
-
| `currentIndex` | `Number`
|
|
37
|
-
| `totalPages` | `Number`
|
|
38
|
-
| `setIndex` | `React.
|
|
39
|
-
| `isDefaultStyles` | `Boolean`
|
|
40
|
-
| `wrapperClass` | `String`
|
|
41
|
-
| `itemListClass` | `String`
|
|
42
|
-
| `itemClass` | `String`
|
|
43
|
-
| `selectedItemClass` | `String`
|
|
44
|
-
| `disableItemClass` | `String`
|
|
45
|
-
| `className` | `String`
|
|
35
|
+
| Name | Type | Description |
|
|
36
|
+
| ------------------- |----------------------------------| ---------------------------------------------------------------------- |
|
|
37
|
+
| `paginationStart` | `Number` | **Required.** The number of start pages on your logic (0 or 1). |
|
|
38
|
+
| `currentIndex` | `Number` | **Required.** The current index from hook useState of pages displayed. |
|
|
39
|
+
| `totalPages` | `Number` | **Required.** The range of pages displayed. |
|
|
40
|
+
| `setIndex` | `React.SetStateAction<number>` | **Required.** The dispatch from hook useState |
|
|
41
|
+
| `isDefaultStyles` | `Boolean` | **Default true** |
|
|
42
|
+
| `wrapperClass` | `String` | Css class |
|
|
43
|
+
| `itemListClass` | `String` | Css class |
|
|
44
|
+
| `itemClass` | `String` | Css class |
|
|
45
|
+
| `selectedItemClass` | `String` | Css class |
|
|
46
|
+
| `disableItemClass` | `String` | Css class |
|
|
47
|
+
| `className` | `String` | **Field for styled-component** |
|
|
48
|
+
|
|
49
|
+
### Remark
|
|
50
|
+
For rewrite default styles - use !important in your css
|