现在网上各种各样的分页组件很多,但是很难找到十分“称心如意”的,于是jqPaginator诞生了。

我心中理想的分页组件,要不受CSS框架限制,可以使用在各种不同风格中的网页中。以我浅显的经验来看,要达到这个目标,关键的一点就是高度自定义的Html结构。所以jqPaginator努力做到合理范围内的自定义,使其灵活的使用了各种不同的场景。

jqPaginator是我业余学习的成果,技术有限,Bug和不合理之处再说难免,欢迎各位大牛指正。

 

注意:本项目大概是 14 年开源的,实际开发的时间要更早,后续出于学习的目的,加了单元测试等各种东西。虽然我早已经不在使用 jQuery 了,但项目本身运行的还是很好的,大家有问题可以提 issue,我会尽量回复。

Bootstrap风格的分页

当前第1页

    当前第1页

      自定义风格的分页 (这个网站找的,效果不是很好,大家凑合看吧,主要是想表现自定义结构)

      当前第16页

      极简风格的分页 o(╯□╰)o 实在是没耐心写样式,继续凑合看吧!

      当前第7页

        上下联动的分页

          当前第24页

            例子

            用法很简单,首先引入jQuery和jqPaginator,之后就可以初始化分页了

            $('#id').jqPaginator({
                totalPages: 100,
                visiblePages: 10,
                currentPage: 1,
                onPageChange: function (num, type) {
                    $('#text').html('当前第' + num + '页');
                }
            });

            上例就是第一Demo,Bootstrap风格的分页。具体参数稍后介绍,这里要了解的是,如果使用的不是id,而是class,就会初始化该class的所有元素,实现上面“两个分页联动”的效果。

            参数

            参数 默认值 说明
            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)

            初始化后,动态修改配置

            $('#id').jqPaginator('option', {
                currentPage: 1
            });

             

            $('#id').jqPaginator('destroy')

            销毁jqPaginator

            $('#id').jqPaginator('destroy');

            能力有限,难免有Bug和不合理之处,欢迎大牛提意见和反馈,我会尽快响应的:https://github.com/keenwon/jqPaginator/issues