Home>Web design tutorial>Javascript tutorial

JavaScript to create simple paging plugin

Author：Eve Cole Update Time：2025-08-08 20:16:01

Introduction

Compatible with IE6+ and modern browsers, it supports multiple pages on the same page.

use

Browser

 <link rel="stylesheet" href="css/GB-paging.css"><script src="js/GB-paging.js"></script>

Normal pagination

HTML

 <div id="gbpaging">

JS

 gbPaging({ total: 101, paramName: 'p', curPage: getPage('p', '#'), size: 5, prevText: '<', nextText: '>', pageInfo: '<b>{{currentPage}}</b>/<b>{{totalPages}}</b>', eventType: 'click'});

Another page for the same page

HTML

 <div id="paging1"></div>

JS

 gbPaging({ eleId: 'paging1', total: 54, size: 10, prevText: false, nextText: false, paramName: 'p1', curPage: getPage('p1', '#'), pageInfo: false, eventType: 'click'});

Refresh with parameters

HTML

 <div id="paging2"></div>

JS

 gbPaging({ eleId: 'paging2', total: 2500, paramName: 'page', curPage: getPage('page', '?type=1&name=2&'), goUrl: '?type=1&name=2&{{n}}'});

Helper functions

 function getPage(pname, other){ var page = window.location.search.replace( other + pname + '=', '') || 1; return parseInt(page);}

Options

eleId paging container, only supports ID, default is: 'gbpaging'

total: Total records

paramName: Pagination parameter name|| 'p'

curPage: Current page number

size: Number of records per page|| 10

prevText: Previous page copy|| 'Previous page', value is false and not displayed

nextText: 'Next page copy|| 'Next page' value is false not displayed

pageInfo: paging information, {{currentPage}} current page number, {{totalPages}} total page number|| Current {{currentPage}} page/total {{totalPages}} page, the value is false not displayed

eventType: event mode, 'click' || 'link'

goUrl: Link URL, '?type=1&name=2&{{n}}' || '', {{n}} is the page parameter name + value, such as: 'p=1'

Github

https://github.com/givebest/GB-paging

Complete code

 /** * GB-paging.js * @class gbPaging * @see https://github.com/givebest/GB-paging * @author [email protected] * @(c) 2016 **/ (function() { var $, defaultConfig, paging = null, args; /** * [defaultConfig default configuration] * @type {Object} */ defaultConfig = { eventType: 'link', curPage: 1, //Current page size: 10, //N paramName per page: 'p', //Page number parameter prevText: 'Previous page', nextText: 'Next page', pageInfo: 'Current <b>{{currentPage}}</b> pages/Total<b>{{totalPages}}</b>' } /** * [$ description] * @param {String} id * @return {Object} HTML [HTML element] */ $ = function(id) { return document.getElementById(id); } function GbPaging() { if (!(this instanceof GbPaging)) return new GbPaging(); } GbPaging.prototype.init = function(opts) { this.getParams(opts); this.build(); this.events(); } GbPaging.prototype.getParams = function(opts) { args = this.opts = opts || {}; // _this = this; if ($(args.eleId)) { args.container = $(args.eleId); } else if ($('gbpaging')) { args.container = $('gbpaging'); } else { return; } args.eventType = args.eventType || defaultConfig.eventType; args.total = args.total || 0; args.curPage = args.curPage || defaultConfig.curPage; args.size = args.size || defaultConfig.size; args.paramName = args.paramName || defaultConfig.paramName; args.goUrl = args.goUrl || ''; args.pages = Math.ceil(args.total / args.size || 0); args.isPrev = (args.prevText !== false) ? true : false; args.prevText = args.prevText || defaultConfig.prevText; args.isNext = (args.nextText !== false) ? true : false; args.nextText = args.nextText || defaultConfig.nextText; args.isPageInfo = (args.pageInfo !== false) ? true : false; args.pageInfo = args.pageInfo || defaultConfig.pageInfo; } /** * [Pagination html] * @return {[type]} [description] */ GbPaging.prototype.build = function() { var html = []; // console.log('build', args) // No data if (args.pages <= 1) { addClass(args.container, 'gb-hide'); return; } if (args.curPage >>> 0 <= 0) return; var ii = (args.curPage == 1 || args.curPage == args.pages) ? 3 : 2; var urlParam = parseUrl(args.goUrl, args.paramName); html.push('<a href="'+ urlParam + args.curPage +'">' + args.curPage + '</a>'); for (var i = 1; i < ii; i++) { if (args.curPage - i > 1) { html.unshift('<a href="'+ urlParam + (args.curPage - i) +'">' + (args.curPage - i) + '</a>'); } if (args.curPage + i < args.pages) { html.push('<a href="'+ urlParam + (args.curPage + i) +'">' + (args.curPage + i) + '</a>'); } } if (args.curPage - 2 > 1) { html.unshift('<span>...</span>'); } if (args.curPage > 1) { html.unshift('<a href="'+ urlParam +'1">1</a>'); args.isPrev && html.unshift('<a href="'+ urlParam + (args.curPage - 1) +'">' + args.prevText + '</a>'); } else { args.isPrev && html.unshift('<a>' + args.prevText + '</a>'); } if (args.curPage + 2 < args.pages) { html.push('<span>...</span>'); } if (args.curPage < args.pages) { html.push('<a href="'+ urlParam + args.pages +'">' + args.pages + '</a>'); args.isNext && html.push('<a href="'+ urlParam + (args.curPage + 1) +'">' + args.nextText + '</a>'); } else { args.isNext && html.push('<a>' + args.nextText + '</a>'); } // Whether to display the paging information on the right if (args.isPageInfo) html.push('<div>' + args.pageInfo.replace('{{currentPage}}', args.curPage).replace('{{totalPages}}', args.pages) + '</div>'); args.container.innerHTML = html.join(''); } /** * [Binding Event] * @return {[type]} [description] */ GbPaging.prototype.events = function() { var _this = this; if (args.eventType !== 'click') return; bind(args.container, 'click', function(e) { e = e || window.event; e.preventDefault ? e.preventDefault() : e.returnValue = false; args = _this.opts; // console.log('events', _this.opts); var target = e.target || e.srcElement; if (target.tagName.toLowerCase() === 'a' && !hasClass(target, 'disabled')) { args.curPage = target.getAttribute('href').replace(parseUrl(args.goUrl, args.paramName), ''); if (args.curPage >>> 0 === 0) args.curPage = args.curPage.replace(window.location.href, ''); args.curPage = parseInt(args.curPage); _this.build(); } }); } /** * [Explanation URL] * @param {[String]} url [description] * @param {[String]} param [description] * @return {[String]} [description] */ function parseUrl(url, param) { if (url) { return url.replace('{{n}}', param + '='); } else { return '#' + param + '='; } } /** * Bind events to elements * @param {Object} ele HTML Object * @param {Event} event Event to detach * @param {Function} fn Callback function */ function bind(ele, event, fn) { if (typeof addEventListener === 'function') { ele.addEventListener(event, fn, false); } else if (ele.attachEvent) { ele.attachEvent('on' + event, fn); } } /** * Unbind events to elements * @param {Object} ele HTML Object * @param {Event} event Event to detach * @param {Function} fn Callback function */ /* function unbind(ele, event, fn) { if (typeof removeEventListener === 'function') { ele.removeEventListener(event, fn, false); } else if (ele.detachEvent) { ele.detach('on' + event, fn); } }*/ /** * hasClass * @param {Object} ele HTML Object * @param {String} cls className * @return {Boolean} */ function hasClass(ele, cls) { if (!ele || !cls) return false; if (ele.classList) { return ele.classList.contains(cls); } else { return ele.className.match(new RegExp('(//s|^)' + cls + '(//s|$)')); } } /** * [addClass description] * @param {Object} ele [HTML Object] * @param {String} cls [className] */ function addClass(ele, cls) { if (ele.classList) { ele.classList.add(cls); } else { if (!hasClass(ele, cls)) ele.className += '' + cls; } } /** * [removeClass description] * @param {Object} ele [HTML Object] * @param {String} cls [className] */ /* function removeClass(ele, cls) { if (ele.classList) { ele.classList.remove(cls); } else { ele.className = ele.className.replace(new RegExp('(^|//b)' + className.split(' ').join('|') + '(//b|$)', 'gi'), ' '); } }*/ if (window.gbPaging == undefined) { window.gbPaging = function (opts) { paging = GbPaging(); return paging.init(opts); } } // AMD (@see https://github.com/jashkenas/underscore/blob/master/underscore.js) if (typeof define == 'function' && define.amd) { define('GB-paging', [], function() { return gbPaging; }); } }());
Related Articles