This is a Fork from matfish2/vue-pagination-2 which uses Bootstrap CSS.
Note: This package is for use with Vuejs 2. For version 1 please use v-pagination instead.
Simple, generic and non-intrusive pagination component for Vue.js version 2. Presentation is based on Bulma CSS.
- Vue.js (>=2.0.0-rc.1). Required.
- Bulma (CSS). Optional.
npm install vue-pagination-2-bulma
import the script:
import {Pagination, PaginationEvent} from 'vue-pagination-2';
Vue.component('pagination', Pagination);
OR
...
components: {
Pagination
}
...
HTML:
<pagination for="some-entity" :records="500"></pagination>
props:
-
for
string
required
unique identifier for the component instance. -
records
number
required
number of records -
per-page
number
optional
records per page. Default:25
-
chunk
number
optional
max pages per chunk. Default:10
-
vuex
boolean
optional
Use vuex to manage state -
modifiers
string
optional
bulma pagination modifiers, e.g. 'is-right is-medium' -
count-text
string
optional
total records text. It can consist of up to 3 parts, divided by|
.- First part: used when there are multiple pages
- Second part: used when there is only one page
- Third part: used when there is only one record.
Default:
Showing {from} to {to} of {count} records|{count} records|One record
When a page is selected an event will be dispatched, using the unique id for the component. Listen to it on your bus and respond accordingly:
PaginationEvent.$on('vue-pagination::some-entity', function(page) {
// display the relevant records using the page param
});
The component will register a module on your store using the for
prop as the name.
The module will have a page
property that will contain the current page.
vue-devtools will give you a nice overview of the data structure.
If you want to latch on to an existing module on your store, use its name in the for
prop and manuaully add the following to you store:
{
myModule:{
state:{
```
page: 1
```
},
mutations: {
```
['myModule/PAGINATE'](state, page) {
state.page = page
}
```
}
}
To programmatically set the page apply a ref
identifier to the component and use one of the following methods:
setPage(page)
next()
prev()
nextChunk()
prevChunk()
All methods return true
if the page is legal and was thus set, or false
otherwise.
totalPages
totalChunks
currentChunk