之前我曾写过一篇关于bootstrap分页的文章,简单地展示了使用ajax加载网页内容时,这个bootstrap组件的改进方法,现在我对这个方法进行了封装,让它成为一个比较通用的方法。
2016-3-23:已在runjs上演示 http://runjs.cn/code/eknooxiw
2016-2-15:修改首页末页文字显示为可自定义
先看代码:
//分页,页码导航,要求参数为一个对象
function createPageNav(opt) {
opt= opt || {};
var $container = opt.$container || null, //必需,页码容器,请确保这个容器只用来存放页码导航
pageCount = Number(opt.pageCount) || 0, //必需,页码总数
currentNum = Number(opt.currentNum) || 1, //选填,当前页码
maxCommonLen = Number(opt.maxCommonLen)|| 10, //选填,普通页码的最大个数
className = opt.className || "pagination",//选填,分页类型:pagination或pager等
preText = opt.preText || "上一页", //选填,上一页文字显示,适用于只有前后页按钮的情况
nextText = opt.nextText || "下一页", //选填,下一页文字,同上
firstText = opt.firstText || "首页",
lastText = opt.lastText || "末页",
hasFirstBtn = opt.hasFirstBtn === false ? false : true,
hasLastBtn = opt.hasLastBtn === false ? false : true,
hasPreBtn = opt.hasPreBtn === false ? false : true,
hasNextBtn = opt.hasNextBtn === false ? false : true,
hasInput = opt.hasInput === false ? false : true,
hasCommonPage= opt.hasCommonPage === false ? false : true,//选填,是否存在普通页
beforeFun = opt.beforeFun || null, //选填,页码跳转前调用的函数,可通过返回false来阻止跳转,可接收目标页码参数
afterFun = opt.afterFun || null, //选填,页码跳转后调用的函数,可接收目标页码参数
noPageFun = opt.noPageFun || null; //选填,页码总数为0时调用的函数
//当前显示的最小页码,用于计算起始页码,直接容器,当前页,前,后,首,末,输入框
var minNum=1,changeLen,$parent,$currentPage,$preBtn,$nextBtn,$firstBtn,$lastBtn,$input;
//容器
if (!$container || $container.length != 1){
console.log("分页容器不存在或不正确");
return false;
}
//总页数
if(pageCount <= 0){
if(noPageFun) noPageFun();
return false;
}
//当前页
if (currentNum < 1) currentNum = 1;
else if (currentNum > pageCount) currentNum = pageCount;
//普通页码的最大个数,起始页算法限制,不能小于3
if(maxCommonLen<3) maxCommonLen=3;
//跳转页响应长度,用于计算起始页码
if(maxCommonLen>=8) changeLen=3;
else if(maxCommonLen>=5) changeLen=2;
else changeLen=1;
$container.hide();
_initPageNav();
$container.show();
function _initPageNav(){
var initStr = [];
initStr.push('<nav><ul class="'+ className +'" onselectstart="return false">');
if(hasFirstBtn)initStr.push('<li class="first-page" value="1"><span>'+ firstText +'</span></li>');
if(hasPreBtn) initStr.push('<li class="pre-page" value="' + (currentNum - 1) + '"><span>'+ preText +'</span></li>');
if(hasNextBtn) initStr.push('<li class="next-page" value="' + (currentNum + 1) + '"><span>'+ nextText +'</span></li>');
if(hasLastBtn) initStr.push('<li class="last-page" value="' + pageCount + '"><span>'+ lastText +'</span></li>');
if(hasInput)
initStr.push('<div class="input-page-div">当前第<input type="text" maxlength="6" value="' + currentNum + '" />页,共<span>'
+ pageCount
+ '</span>页<button type="button" class="btn btn-xs input-btn-xs">确定</button></div>');
initStr.push('</ul></nav>');
$container.html(initStr.join(""));
//初始化变量
$parent=$container.children().children();
if(hasFirstBtn) $firstBtn = $parent.children("li.first-page");
if(hasPreBtn) $preBtn = $parent.children("li.pre-page");
if(hasNextBtn) $nextBtn = $parent.children("li.next-page");
if(hasLastBtn) $lastBtn = $parent.children("li.last-page");
if(hasInput){
$input = $parent.find("div.input-page-div>input");
$parent.find("div.input-page-div>button").click(function(){
_gotoPage($input.val());
});
}
//初始化功能按钮
_buttonToggle(currentNum);
//生成普通页码
if(hasCommonPage) {
_createCommonPage(_computeStartNum(currentNum), currentNum);
}
//绑定点击事件
$parent.on("click", "li",function () {
var $this=$(this);
if ($this.is("li") && $this.attr("value")){
if(!$this.hasClass("disabled") && !$this.hasClass("active")){
_gotoPage($this.attr("value"));
}
}
});
}
//跳转到页码
function _gotoPage(targetNum) {
targetNum=_formatNum(targetNum);
if (targetNum == 0 || targetNum == currentNum) return false;
// 跳转前回调函数
if (beforeFun && beforeFun(targetNum) === false) return false;
//修改值
currentNum=targetNum;
if(hasInput) $input.val(targetNum);
if(hasPreBtn) $preBtn.attr("value", targetNum - 1);
if(hasNextBtn) $nextBtn.attr("value", targetNum + 1);
//修改功能按钮的状态
_buttonToggle(targetNum);
// 计算起始页码
if(hasCommonPage) {
var starNum = _computeStartNum(targetNum);
if (starNum == minNum) {// 要显示的页码是相同的
$currentPage.removeClass("active");
$currentPage = $parent.children("li.commonPage").eq(targetNum - minNum).addClass("active");
}
else {// 需要刷新页码
_createCommonPage(starNum, targetNum);
}
}
// 跳转后回调函数
if (afterFun) afterFun(targetNum);
}
//整理目标页码的值
function _formatNum(num){
num = Number(num);
if(isNaN(num)) num=0;
else if (num <= 0) num = 1;
else if (num > pageCount) num = pageCount;
return num;
}
//功能按钮的开启与关闭
function _buttonToggle(current){
if (current == 1) {
if(hasFirstBtn) $firstBtn.addClass("disabled");
if(hasPreBtn) $preBtn.addClass("disabled");
}
else {
if(hasFirstBtn) $firstBtn.removeClass("disabled");
if(hasPreBtn) $preBtn.removeClass("disabled");
}
if (current == pageCount) {
if(hasNextBtn) $nextBtn.addClass("disabled");
if(hasLastBtn) $lastBtn.addClass("disabled");
}
else {
if(hasNextBtn) $nextBtn.removeClass("disabled");
if(hasLastBtn) $lastBtn.removeClass("disabled");
}
}
//计算当前显示的起始页码
function _computeStartNum(targetNum) {
var startNum;
if (pageCount <= maxCommonLen)
startNum = 1;
else {
if ((targetNum - minNum) >= (maxCommonLen-changeLen)) {//跳转到靠后的页码
startNum = targetNum - changeLen;
if ((startNum + maxCommonLen-1) > pageCount) startNum = pageCount - (maxCommonLen-1);// 边界修正
}
else if ((targetNum - minNum) <= (changeLen-1)) {//跳转到靠前的页码
startNum = targetNum - (maxCommonLen-changeLen-1);
if (startNum <= 0) startNum = 1;// 边界修正
}
else {// 不用改变页码
startNum = minNum;
}
}
return startNum;
}
//生成普通页码
function _createCommonPage(startNum, activeNum) {
var initStr = [];
for (var i = 1,pageNum=startNum; i <= pageCount && i <= maxCommonLen; i++ , pageNum++) {
initStr.push('<li class="commonPage" value="' + pageNum + '"><a href="javascript:">' + pageNum + '</a></li>');
}
$parent.hide();
$parent.children("li.commonPage").remove();
if(hasPreBtn) $preBtn.after(initStr.join(""));
else if(hasFirstBtn) $firstBtn.after(initStr.join(""));
else $parent.prepend(initStr.join(""));
minNum = startNum;
$currentPage = $parent.children("li.commonPage").eq(activeNum-startNum).addClass("active");
$parent.show();
}
}
样式(仅参考):
ul.pagination>li>span,ul.pagination>li>a,ul.pagination>li.active>a,ul.pager>li>span{
cursor: pointer;
}
.input-page-div>input{
width:5em;
height:1.8em;
margin:0.4em 0.2em 0.2em 0.2em;
text-align: center;
}
.input-page-div>.input-btn-xs{
margin-left:1em;
font-size: 1em;
width:3em;
background-color: #337ab7;
color:#fff;
}
.input-page-div{
display: inline-block;
margin-left:1em;
}
说明:
思路来源:
某些项目可能多处会用到bootstrap分页组件,并且有些地方仅仅需要前一页和后一页两个按钮,而有些地方需要首页、末页、前后页等功能,所以就有了这个比较通用的创建bootstrap分页组件的方法。
2.用法和示例:
2.1创建一个完整的分页组件:
只有两个必需参数:
createPageNav({$container:$("#page-nav"),pageCount:20});
效果:
在初始化的时候就定义当前页:
createPageNav({$container:$("#page-nav"),pageCount:20,currentNum:15});
效果:
2.2创建一个只有上下页的组件
var opt={
$container : $("#page-nav"),
pageCount:20,
hasCommonPage:false,
hasInput:false,
hasFirstBtn:false,
hasLastBtn:false,
className:"pager",
preText:"<",
nextText:">"
}
createPageNav(opt);
效果:
更多可自定参数请看源码。
3.数据的加载,页码跳转前会调用beforeFun,并且如果这个函数的返回值是false,那么将不会跳转,页码跳转后会调用afterFun函数,这两个函数都可以接收目标页码,即要跳转到的页码值,所以可以将ajax加载函数写在这两个函数里。