jqPaginator.js是一款强大的jquery分页插件。该jquery分页插件简洁大方,可以高度自定义,适用于多种场景。

使用方法

在页面中引入jquery和jqPaginator.js文件。

<script src="js/jquery.min.js"></script>
<script src="js/jqPaginator.js"></script>
                
HTML结构

使用一个<ul>元素来作为分页组件的容器。

<ul class="pagination" id="pagination1"></ul>
                
初始化插件

在页面DOM元素加载完毕之后,通过下面的方法来完成对该分页组件的初始化。

$('#pagination1').jqPaginator({
    totalPages: 100,
    visiblePages: 10,
    currentPage: 1,

    first: '<li class="first"><a href="javascript:void(0);">First</a></li>',
    prev: '<li class="prev"><a href="javascript:void(0);">Previous</a></li>',
    next: '<li class="next"><a href="javascript:void(0);">Next</a></li>',
    last: '<li class="last"><a href="javascript:void(0);">Last</a></li>',
    page: '<li class="page"><a href="javascript:void(0);">{{page}}</a></li>',
    onPageChange: function (num) {
        $('#text').html('当前第' + num + '页');
    }
});
                

配置参数

jqPaginator分页插件的可用配置参数如下:

参数 默认值 描述
totalPages 0 设置分页的总页数
totalCounts 0 设置分页的总条目数
pageSize 0 设置每一页的条目数。

注意:要么设置totalPages,要么设置totalCounts + pageSize,否则报错;设置了totalCounts和pageSize后,会自动计算出totalPages。

currentPage 1 设置当前的页码
visiblePages 7 设置最多显示的页码数(例如有100页,当前第1页,则显示1 - 7页)
disableClass 'disabled' 设置首页,上一页,下一页,末页的“禁用状态”样式
activeClass 'active' 设置当前页码样式
first bootstrap风格 设置“首页”的Html结构
prev bootstrap风格 设置“上一页”的Html结构
next bootstrap风格 设置“下一页”的Html结构
last bootstrap风格 设置“末页”的Html结构
page bootstrap风格 设置页码的Html结构,其中可以使用{{page}}代表当前页,{{totalPages}}代表总页数,{{totalCounts}}代表总条目数(例如:上面的“极简风格”的Demo,就是使用了{{占位符}},并将visiblePages设为1实现的。)

注意:first、prev、next、last。page只要设置一个,其余未设置的会变为空。

wrapper (无) 分页结构的Html包裹,例如:<div class="your class"></div>,一般不会用到
onPageChange (无) 回调函数,当换页时触发(包括初始化第一页的时候),会传入两个参数:

1、“目标页"的页码,Number类型

2、触发类型,可能的值:“init”(初始化),“change”(点击分页)

扩展方法

jqPaginator分页插件在初始化之后,提供了两个扩展方法,方便初始化后对组件进行操作。

// 扩展方法一
$('#id').jqPaginator('option', options)
                

这个方法用于动态修改jqPaginator分页插件的配置信息。例如:

$('#id').jqPaginator('option', {
    currentPage: 1  //将当前页修改为第一页
});
                
// 扩展方法二
$('#id').jqPaginator('destroy')
                

该方法用于销毁jqPaginator分页插件。

jqPaginator分页插件的官方网址为:http://jqpaginator.keenwon.com/