Paginate Vuejs

Note: This version only works with Vue 3

---

Pagination

The Pagination component allows the user to choose a particular page from a selection of pages.

Basic pagination

Outlined pagination

Rounded pagination

Show buttons

You can optionally enable first-page and last-page buttons.

Hide buttons

You can optionally disable the previous-page and next-page buttons.

Custom icons

It's possible to customize the control icons.

Pagination ranges

You can specify how many digits to display either side of current page with the siblingCount prop, and adjacent to the start and end page number with the boundaryCount prop.

Pagination API

Explore the API reference documentation for the Vuejs Pagination component, where you can discover information regarding its props, classes, and other available APIs.

Demos

This is a simple Demo environment for the package where you can use and test the package.

Import

App.vue

1<script setup>
2// Import the package
3import { Pagination } from "paginate-vuejs";
4
5// Import the CSS file to apply the default styling.
6import 'paginate-vuejs/dist/style.css';
7
8const clickCallback = (pageNum) => {
9  // Add your code here
10};
11</script>
12
13<template>
14  <Pagination :total="100" :clickHandler="clickCallback" />
15</template>

OR

main.js

1import { createApp } from 'vue';
2import App from './App.vue';
3
4// Import the package
5import Pagination from 'paginate-vuejs';
6
7// Import the CSS file to apply the default styling.
8import 'paginate-vuejs/dist/style.css';
9
10// Register the package
11createApp(App).use(PaginateVuejs).mount('#app');
12
13import { Pagination } from "paginate-vuejs";

App.vue

1<script setup>
2const clickCallback = (pageNum) => {
3  // Add your code here
4};
5</script>
6
7<template>
8  <Pagination :total="100" :clickHandler="clickCallback" />
9</template>

Props

Component Attributes

Name	Type	Default	Description
total	integer	___	The total count of pages is required.
perPage	bool	10	The number of items or records displayed on each page.
currentPage	integer	1	The current page active.
siblingCount	integer	1	Number of always visible pages before and after the current page.
boundaryCount	integer	1	Number of always visible pages at the beginning and end.
hideNextButton	bool	false	If true, hide the next-page button.
hidePrevButton	bool	false	If true, hide the previous-page button.
showFirstButton	bool	false	Show the First button.
showLastButton	bool	false	Show the Last button.
clickHandler	func	___	Callback fired when the page is changed. function(page: number) => void page The page selected.
type	'link' | 'button'	'button'	HTML Element type of the pagination component.
linkUrl	string	'#'	Necessary when the type attribute is configured as 'link' and should include the "{page}" placeholder for it to be substituted with the actual page number when rendering.
disablePagination	bool	false	Toggle the buttons for the entire component on/off.
disablePagination	bool	false	Toggle the buttons for the entire component on/off.
paginationTypes	'normal' | 'standard' | 'minimal' | 'of'	normal	The style of pagination to be applied ('normal', 'standard', 'minimal', or 'of').

Class Name Attributes

Name	Default	Description
pageContainerClass	'pagination-container'	Styles applied to the component's container.
pageItemClass	'page-item'	Styles applied to individual page items.
pageLinkClass	'page-link'	Styles applied to page links.
activeClass	'active'	Styles applied to the currently active page.
ellipsisClass	'pagination-ellipsis'	Styles applied to the ellipsis indicator.

Slot Names

These slot names can be utilized for Vue Slots to insert custom HTML into the specified element.

Name	Target
firstBtn	First page button
lastBtn	Last page button
prevBtn	Previous page button
nextBtn	Next page button
ellipsisText	Ellipsis indicator

Author

Dadda Abdelghafour

License

The MIT License