Pagination

import { WuiPagination, WuiQuickPagination } from "@wui/wui-vue/lib/pagination";

Description

Quick first, previous, next, last, and page buttons for pagination control of another component (such as <wui-table> or lists).

Overview

<wui-pagination> is a custom input component that provides a current page number input control. The value should be bound via v-model in your app. Page numbers are indexed from 1. The number of pages is computed from the provided prop values for total-rows and per-page.

wui-quick-pagination is a lightweight version with only the prev and next button controls.

Example Usage with <wui-table>:

<template>
  <div class="overflow-auto">
    <wui-pagination
      v-model="currentPage"
      :total-rows="rows"
      :per-page="perPage"
      aria-controls="my-table"
    ></wui-pagination>

    <p class="m-t-15">Current Page: { currentPage }</p>

    <wui-table
      id="my-table"
      :items="items"
      :per-page="perPage"
      :current-page="currentPage"
      small
    ></wui-table>
  </div>
</template>

<script>
  export default {
    data() {
      return {
        perPage: 3,
        currentPage: 1,
        items: [
          { id: 1, first_name: "Fred", last_name: "Flintstone" },
          { id: 2, first_name: "Wilma", last_name: "Flintstone" },
          { id: 3, first_name: "Barney", last_name: "Rubble" },
          { id: 4, first_name: "Betty", last_name: "Rubble" },
          { id: 5, first_name: "Pebbles", last_name: "Flintstone" },
          { id: 6, first_name: "Bamm Bamm", last_name: "Rubble" },
          { id: 7, first_name: "The Great", last_name: "Gazzoo" },
          { id: 8, first_name: "Rockhead", last_name: "Slate" },
          { id: 9, first_name: "Pearl", last_name: "Slaghoople" },
        ],
      };
    },
    computed: {
      rows() {
        return this.items.length;
      },
    },
  };
</script>

<!-- wui-pagination.vue -->

Customizing appearance

<wui-pagination> supports several props/slots that allow you to customize the appearance. All *-text props are text-only and strip out HTML but you can use their equally named slot counterparts for that.

Limiting the number of displayed buttons

To restrict the number of page buttons (including the ellipsis, but excluding the first, prev, next, and last buttons) shown, use the limit prop to specify the desired number of page buttons (including the ellipsis, if shown). The default limit is 5. The minimum supported value is 3. When limit is set to 3, no ellipsis indicators will be shown for practical purposes.

The first and last buttons can be optionally shown by setting the hide-goto-end-buttons prop to false (as the default for WUI is true).

The showing of the ellipsis can be optionally disabled by setting the hide-ellipsis prop.

Small screen support

On smaller screens (i.e. mobile), some of the <wui-pagination> buttons will be hidden to minimize the potential of the pagination interface wrapping onto multiple lines:

• The ellipsis indicators will be hidden on screens xs and smaller.
• Page number buttons will be limited to a maximum of 3 visible on xs screens and smaller.

This ensures that no more than 3 page number buttons are visible, along with the goto first, prev, next, and last buttons.

Button content

For a full list of all available slots see the Slots section below.

<template>
  <div class="overflow-auto">
    <!-- Use text in props -->
    <wui-pagination
      v-model="currentPage"
      :total-rows="rows"
      :per-page="perPage"
      first-text="First"
      prev-text="Prev"
      next-text="Next"
      last-text="Last"
    ></wui-pagination>

    <!-- Use emojis in props -->
    <wui-pagination
      v-model="currentPage"
      :total-rows="rows"
      :per-page="perPage"
      first-text="⏮"
      prev-text="⏪"
      next-text="⏩"
      last-text="⏭"
      class="mt-4"
    ></wui-pagination>

    <!-- Use HTML and sub-components in slots -->
    <wui-pagination
      v-model="currentPage"
      :total-rows="rows"
      :per-page="perPage"
      class="mt-4"
    >
      <template #first-text><span class="text-success">First</span></template>
      <template #prev-text><span class="text-danger">Prev</span></template>
      <template #next-text><span class="text-warning">Next</span></template>
      <template #last-text><span class="text-info">Last</span></template>
      <template #ellipsis-text>
        <wui-spinner class="v-align--middle" />
      </template>
      <template #page="{ page, active }">
        <b v-if="active">{ page }</b>
        <i v-else>{ page }</i>
      </template>
    </wui-pagination>
  </div>
</template>

<script>
  export default {
    data() {
      return {
        rows: 100,
        perPage: 10,
        currentPage: 1,
      };
    },
  };
</script>

<!-- wui-pagination-appearance.vue -->

The slot page is always scoped, while the slots first-text, prev-text, next-text and last-text are optionally scoped. The ellipsis-text slot is not scoped.

Scoped variables properties available to the page slot:

Scoped variables properties available to the first-text, prev-text, next-text and last-text slots:

Goto first/last button type

If you prefer to have buttons with the first and last page number to go to the corresponding page, use the first-number and last-number props.

<template>
  <div class="overflow-auto">
    <div>
      <h6>Goto first button number</h6>
      <wui-pagination
        v-model="currentPage"
        :total-rows="rows"
        :per-page="perPage"
        first-number
      ></wui-pagination>
    </div>

    <div class="m-t-15">
      <h6>Goto last button number</h6>
      <wui-pagination
        v-model="currentPage"
        :total-rows="rows"
        :per-page="perPage"
        last-number
      ></wui-pagination>
    </div>

    <div class="m-t-15">
      <h6>Goto first and last button number</h6>
      <wui-pagination
        v-model="currentPage"
        :total-rows="rows"
        :per-page="perPage"
        first-number
        last-number
      ></wui-pagination>
    </div>
  </div>
</template>

<script>
  export default {
    data() {
      return {
        rows: 100,
        perPage: 1,
        currentPage: 5,
      };
    },
  };
</script>

<!-- wui-pagination-goto-first-last-number.vue -->

Alignment

By default the pagination component is left aligned. Change the alignment to center, right (right is an alias for end), or fill by setting the prop align to the appropriate value.

<template>
  <div class="overflow-auto">
    <div>
      <h6>Left alignment (default)</h6>
      <wui-pagination v-model="currentPage" :total-rows="rows"></wui-pagination>
    </div>

    <div class="m-t-15">
      <h6 class="text-center">Center alignment</h6>
      <wui-pagination
        v-model="currentPage"
        :total-rows="rows"
        align="center"
      ></wui-pagination>
    </div>

    <div class="m-t-15">
      <h6 class="text-right">Right (end) alignment</h6>
      <wui-pagination
        v-model="currentPage"
        :total-rows="rows"
        align="right"
      ></wui-pagination>
    </div>

    <div class="m-t-15">
      <h6 class="text-center">Fill alignment</h6>
      <wui-pagination
        v-model="currentPage"
        :total-rows="rows"
        align="fill"
      ></wui-pagination>
    </div>
  </div>
</template>

<script>
  export default {
    data() {
      return {
        rows: 100,
        currentPage: 3,
      };
    },
  };
</script>

<!-- wui-pagination-alignment.vue -->

Preventing a page from being selected

You can listen for the page-click event, which provides an option to prevent the page from being selected. The event is emitted with two arguments:

• wvEvent: The WvEvent object. Call wvEvent.preventDefault() to cancel page selection
• page: Page number to select (starting with 1)

For accessibility reasons, when using the page-click event to prevent a page from being selected, you should provide some means of notification to the user as to why the page is not able to be selected. It is recommended to use the disabled attribute on the <wui-pagination> component instead of using the page-click event (as disabled is more intuitive for screen reader users).

Accessibility

The <wui-pagination> component provides many features to support assistive technology users, such as aria- attributes and keyboard navigation.

aria-controls

When pagination is controlling another component on the page (such as <wui-table>), set the aria-controls prop to the id of the element it is controlling. This will help non-sighted users know what component is being updated/controlled.

ARIA labels

<wui-pagination> provides various *-label-* props which are used to set the aria-label attributes on the various elements within the component, which will help users of assistive technology.

The label-page will optionally accept a function to generate the aria-label. The function is passed a single argument which is the page number (indexed from 1 to number of pages).

You can remove any label by setting the prop to an empty string (''), although this is not recommended unless the content of the button textually conveys its purpose.

Keyboard navigation support

<wui-pagination> supports keyboard navigation out of the box, and follows the WAI-ARIA roving tabindex pattern.

• Tabbing into the pagination component will autofocus the current active page button
• Left (or Up) and Right (or Down) arrow keys will focus the previous and next buttons, respectively, in the page list
• Enter or Space keys will select (click) the currently focused page button
• Pressing Tab will move to the next control or link on the page, while pressing Shift+Tab will move to the previous control or link on the page.

See also

Component reference

<wui-pagination>

Properties

v-model

Slots

Events

<wui-quick-pagination>

Properties

v-model

Events

Importing individual components

You can import individual components into your project via the following named exports:

Example

import { WuiPagination, WuiQuickPagination } from "@wui/wui-vue/lib/pagination";
Vue.component("wui-pagination", WuiPagination);
Vue.component("wui-quick-pagination", WuiQuickPagination);

Importing as a Vue.js plugin

This plugin includes all of the above listed individual components. Plugins also include any component aliases.

This plugin also automatically includes the following plugins:

• VWPaginationPlugin

Example

import { PaginationPlugin } from "@wui/wui-vue/lib/pagination";
Vue.use(PaginationPlugin);