1
1
# [ Tiny Pagination] ( https://github.com/coderdiaz/vue-tiny-pagination ) · ; [ ![ NPMVERSION] ( https://img.shields.io/npm/v/vue-tiny-pagination.svg?style=flat-square )] ( http://npmjs.com/package/vue-tiny-pagination ) [ ![ GITHUBSTARS] ( https://img.shields.io/github/stars/coderdiaz/vue-tiny-pagination.svg?style=flat-square )] ( https://github.com/coderdiaz/vue-tiny-pagination/stargazers ) [ ![ BUILD] ( https://travis-ci.org/coderdiaz/vue-tiny-pagination.svg?branch=master&style=flat-square )] ( https://travis-ci.org/coderdiaz/vue-tiny-pagination ) [ ![ DOWNLOADS] ( https://img.shields.io/npm/dt/vue-tiny-pagination.svg?style=flat-square )] ( https://npmjs.com/package/vue-tiny-pagination )
2
2
A Vue component for create a tiny paginate
3
3
4
- # Install/Usage
4
+ ## Install/Usage
5
5
<!-- Replace the docs for usage the plugin -->
6
6
``` sh
7
7
# Install with npm
@@ -51,7 +51,7 @@ import { TinyPagination } from 'vue-tiny-pagination';
51
51
Vue .component (' custom-name' , TinyPagination);
52
52
```
53
53
54
- ## Usage in browser
54
+ ### Usage in browser
55
55
<!-- Write an example for use the plugin in browser from CDN -->
56
56
In browser you can use Unpkg, Jsdelivr, CDN.js, etc.
57
57
``` sh
@@ -62,9 +62,9 @@ https://unpkg.com/vue-tiny-pagination@latest/dist/vue-tiny-pagination.js
62
62
https://cdn.jsdelivr.net/npm/vue-tiny-pagination@latest/dist/vue-tiny-pagination.min.js
63
63
```
64
64
65
- # Documentation
65
+ ## Documentation
66
66
<!-- Add all documentation about the plugin: props, events, etc -->
67
- ## Props
67
+ ### Props
68
68
| Name| Description| Type| Default| Required|
69
69
| ---| ---| ---| ---| ---|
70
70
| total| A number of total items| Number| -| true|
@@ -74,14 +74,14 @@ https://cdn.jsdelivr.net/npm/vue-tiny-pagination@latest/dist/vue-tiny-pagination
74
74
| limits| Prop to set a default limits to page sizes.| Array| [ 10, 15, 20,50,100] | false|
75
75
| showLimit| Prop to disable the limit selector| Boolean| true| false|
76
76
77
- ## Events
77
+ ### Events
78
78
| Event| Description|
79
79
| ---| ---|
80
80
| tiny: change-page | Get the current page from pagination ` payload: { page: 1 } ` |
81
81
| tiny: change-limit | Get the current limit from pagination ` payload: { limit: 1 } ` |
82
82
83
- # Community
83
+ ## Community
84
84
All feedback and suggestions are welcome!
85
85
86
- # License
86
+ ## License
87
87
This is a open-source software licensed under the [ MIT license] ( https://raw.githubusercontent.com/coderdiaz/vue-tiny-pagination/master/LICENSE )
0 commit comments