rlambertsen / vue-pagination-2

Vue.js 2 pagination component

Vue Pagination 2

Breaking change on version 1.5.0: Due to a growing number of options, many of the optional props moved into a dedicated options object

Click here to see it in action.

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.

• Dependencies
• Installation
  • NPM
  • Script tag
• Usage
• Handle page selection
  • Custom Event
  • Event Bus
  • Vuex

Dependencies

• Vue.js (>=2.0.0-rc.1). Required.
• CSS: Bootstrap 3 or Bootstrap 4 or Bulma.

Installation

NPM

npm install vue-pagination-2

import the script:

import {Pagination} from 'vue-pagination-2';

Script tag

Grab the minified version under dist/vue-pagination-2.min.js. It will export a global Pagination variable.

Usage

Register the component globally or locally:

Vue.component('pagination', Pagination);

OR

...
components: {
  Pagination
}
...

HTML:

<pagination :records="500" @paginate="myCallback"></pagination>

props:

• for string optional unique identifier for the component instance.

• records number required number of records

• per-page number optional records per page. Default: 25

• page number Initial Page. Default: 1

• vuex boolean optional Use vuex to manage state. Default: false

• options object optional:

  • chunk number max pages per chunk. Default: 10
  • chunksNavigation string Which method to use when navigating outside chunks boundries. Default: fixed. Options are:
    • scroll - the range of pages presented will incrementally change when navigating to a page outside the chunk (e.g 1-10 will become 2-11 once the user presses the next arrow to move to page 11).
    • fixed - navigation will occur between fixed chunks (e.g 1-10, 11-20, 21-30 etc.). Double arrows will be added to allow navigation to the beginning of the previous or next chunk.
  • theme string CSS theme used for styling. Supported: bootstrap3, bootstrap4,bulma. Default: bootstrap3.
  • format boolean Format numbers using a separating comma. Default: true
  • edgeNavigation Show links to first and last pages. Default: false
  • texts object optional

    • count 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

    • first First page text. Default: First

    • last last page text. Default: Last

  Note: if you want to display the page number rather than the records range, use {page} and {pages} as a placeholders. E.g: Showing page {page} out of {pages}

Handle page selection

Custom Event

When a page is selected a custom paginate event will be dispatched. Listen to it on the component and run your callback

Event bus

Note: To use this option you must:

A. Provide a unique identifier using the for prop B. Import the pagination event bus along with the component itself:

import {Pagination,PaginationEvent} from 'vue-pagination-2'

When a page is selected the bus will dispatched an event, 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
});

Vuex (>=2.0.0)

Note: To use this option you must provide a unique identifier using the for prop.

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

Custom Template

You can easily build your own template by copying src/Pagination.vue to your project as a starting point and modifying the contents to your needs.

Note:

• Be sure to modify the import path from:

import RenderlessPagination from './RenderlessPagination.js';

to:

import RenderlessPagination from 'vue-pagination-2/compiled/RenderlessPagination.js';

• Only modify the content under the RenderLessPagination wrapping component
• Do NOT remove any binding or event handlers