Vue Pagination 2

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 bootstrap.

• Dependencies
• Installation
• Usage
• Handle page selection
  • Event Bus
  • Vuex

Dependencies

• Vue.js (>=2.0.0-rc.1). Required.
• Bootstrap (CSS). Optional.

Installation

Compile the code using a module bundler, such as webpack or browserify, and the vue jsx transform

npm install vue-pagination-2

import the script:

import VuePagination from 'vue-pagination-2';

If you are not using Vuex, import the event bus:

import bus from 'vue-pagination-2/src/bus'

Usage

Register the component(s)

Vue.use(VuePagination, [useVuex])

The second parameter is a boolean, which tells the plugin how to manange state. If you are using the bus option you can simply omit it.

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

• 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

Handle page selection

Event bus

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:

  bus.$on('vue-pagination::some-entity', function(page) {
      // display the relevant records using the page param
  });

Vuex (>=2.0.0)

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
          }
      ```
    }
  }

Programmatic Manipulation

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.

Computed Properties

• totalPages
• totalChunks
• currentChunk