您所在的位置:小祥子 » 编程 » JavaScript » 正文

Bootstrap Paginator 分页插件参数介绍及使用

时间:2015-04-20 编辑:清朗的晨风 来源:本站整理

Bootstrap Paginator是一款基于Bootstrap的JS分页插件,功能很丰富,个人觉得这款插件已经无可挑剔了。它提供了一系列的参数用来支持用户的定制,提供了公共的方法可随时获得插件状态的改变,以及事件来监听用户的动作。目前经过测试的浏览器包括: Firefox 5+, Chrome 14+, Safari 5+, Opera 11.6+ and IE 7+。

GitHub 官网地址:https://github.com/lyonlai/bootstrap-paginator

参数介绍:

参数名数据类型默认值描述
size string   "normal"    设置控件的显示大小,是个字符串. 允许的值: minismallnormal,large。值:mini版的、小号的、正常的、大号的。
alignment string  "left" 设置控件的对齐方式,是个字符串, 允许的值用: leftcenter andright. 即:左对齐、居中对齐、右对齐。
itemContainerClass function  

该参数接收一个函数,返回一个字符串,该字符串是一个我们自定义的class类样式。当控件内的每个操纵按钮被渲染(render)时,都会调用该函数,

同时把有关该按钮的信息作为参数传入。参数:type,pagecurrent 。type为该控件的操作按钮的类型,如上图所示的五种类型:first、prev、page、next、last。

page为该按钮所属第几页。current 指示整个控件的当前页是第几页。

currentPage number 1 设置当前页.
numberOfPages number 5 设置控件显示的页码数.即:类型为"page"的操作按钮的数量。
totalPages number 1 设置总页数.
pageUrl function  

实际上,控件内的每个操作按钮最终会被渲染成超链接,该参数的作用就是设置超链接的链接地址。该参数是个函数,参数为:type,pagecurrent。

这样我们就可以通过这个函数为每个操作按钮动态设置链接地址。如:"http://example.com/list/page/"+page

shouldShowPage boolean/function true

该参数用于设置某个操作按钮是否显示,可是个布尔值也可是个函数。当为true时,显示。当为false时,不显示。如果该参数是个函数,需要返回个布尔值,

通过这个返回值判断是否显示。函数有3个参数: typepagecurrent。使用函数的好处是,可以对每个操作按钮进行显示控制。

itemTexts function  

控制每个操作按钮的显示文字。是个函数,有3个参数: typepagecurrent。通过这个参数我们就可以将操作按钮上的英文改为中文,

如first-->首页,last-->尾页。

tooltipTitles function   设置操作按钮的title属性。是个函数,有3个参数: typepagecurrent。
useBootstrapTooltip boolean false

设置是否使用Bootstrap内置的tooltip。 true是使用,false是不使用,默认是不使用。

注意:如果使用,则需要引入bootstrap-tooltip.js插件。

bootstrapTooltipOptions object  
    Default:
    {
        animation: true,
        html: true,
        placement: 'top',
        selector: false,
        title: "",
        container: false }

该参数是个js对象。当参数useBootstrapTooltip为true时,会将该对象传给Bootstrap的bootstrap-tooltip.js插件。

onPageClicked function   为操作按钮绑定click事件。回调函数的参数:eventoriginalEventtype,page。
onPageChanged function   为操作按钮绑定页码改变事件,回调函数的参数:eventoldPagenewPage。

公共命令:

另外该插件还提供了几个公共的命令,可以通过如下方法调用,如:$('#example').bootstrapPaginator("show",3) 调用show命令、$('#example').bootstrapPaginator("getPages") 调用getPages命令。

命令名参数返回值描述
show   page    

show命令用于直接跳转到特定的page,与直接点击操作按钮的效果是一样的。使用方法,

如:$('#example').bootstrapPaginator("show",3) 直接跳转到第3页,

$('#example').bootstrapPaginator("show",100)直接跳转到100页。 

showFirst     showFirst 命令用于直接跳转到首页,与点击first按钮相同。使用方法:$('#example').bootstrapPaginator("showFirst") 
showPrevious     showPrevious 命令用于直接跳转到上一页。使用方法:$('#example').bootstrapPaginator("showPrevious") 
showNext     showNext命令用于直接跳转到下一页。
showLast     showLast 命令用于直接跳转到上一页。
getPages      object   getPages命令用于返回当前控件中显示的页码,以数组形式返回。使用方法:var arra = $('#example').bootstrapPaginator("getPages") 
setOptions object   setOptions 命令用于重新设置参数,使用方法:$('#example').bootstrapPaginator("setOptions",newoptions)

事件Events:

Bootstrap Paginator 提供了俩个事件:page-clickedpage-changed。这俩个事件作为参数使用,分别对应onPageClickedonPageChanged

事件名回调函数描述
page-clicked function(eventoriginalEventtypepage) 同上文。另外,参数eventoriginalEvent是俩个jquery事件对象,可参考jquery相关文档
page-changed function(eventoldPagenewPage) 同上文

 

Demo 示例:

    var options = {
        alignment:"center",//居中显示 currentPage: pageIndex,//当前页数 totalPages: total,//总页数 注意不是总条数 pageUrl: function(type, page, current){
                if (page==current) {
                    return "javascript:void(0)";
                } else {
                    return "/Articles?pageSize=15&pageIndex="+page;
                }
            }
} $("#pagintor").bootstrapPaginator(options);

 

注意:分页样式用BootStrap 的,如果单独使用,请去BootStrap中把分页样式拷出来。jQuery版本需要1.8及以上。