DIV CSS 佈局教程網

用 jQuery 打造一個可重複使用的分頁控件 simplePage
編輯:JQuery特效代碼     

分頁是列表頁的標配,但每個頁面都重寫一次實在浪費。這篇示範把它做成插件,一次寫好到處用。

效果預覽與素材

先想清楚要做什麼

需求:

1. 分頁控件要能向後端發請求,參數包含當前頁、每頁顯示數量、查詢條件,並把回傳資料載入頁面;
2. 執行修改、刪除等操作時,要能記住目前所在頁;
3. 查詢後翻頁時,要能記住當前的查詢條件。

這三點決定了後面的參數設計。

HTML 結構

<!--存放資料的容器-->
<div class="tableData">
</div>
<!--分頁控件顯示-->
<div class="pageBar"></div>

搭插件骨架

(function($){
    $.fn.simplePage = function(o){
        var options = {
            //設定參數
        };
        return //sth
    }
})(jQuery)

需要哪些預設參數

依需求推導:要送當前頁與每頁數量,所以需要 currentPage、pageSize;要查詢表格內容,所以要有放置查詢條件的 form;要記住當前操作類型,所以需要一個 type 標誌;為了增加靈活性,再加上承載資料的 container 與承載分頁的 pager。

var options = {
    pager: '.pager',          //分頁控件的容器
    container: '.tableData',  //放置表格資料的容器
    form: '#form',            //放置查詢條件的表單
    pageForm: '#pageForm',    //放置隱藏域的 Div
    url: '',                  //發送請求的位址
    currentPage: 1,
    pageSize: 2,
    type: null,               //可選:action
    pageShow: 7
}

把邏輯拆成獨立物件

為了便於維護,把「取資料」與「綁事件」獨立成 $.page:

$.page = {
    setPage: function(o){ },
    //取得當前頁
    getCurrentPage: function(o){ },
    //取得每頁顯示數量
    getPageSize: function(o){ },
    //生成發送所需的 json 資料
    genData: function(o){ },
    //發送資料
    loadData: function(o){ }
}

loadData:第一次載入時的關鍵

分頁第一次載入時,總頁數必須由伺服器給,才能生成分頁按鈕。所以先實作 loadData:

loadData: function(o){
    var that = this;
    var data = that.genData(o);
    $.ajax({
        url: o.url,
        data: data,
        type: 'post',
        dataType: 'html',
        cache: false,
        success: function(result){
            var res = $(result).find('tbody').html();
            var totalPage = $(result).find('#totalPage').val();
            var currentPage = $(result).find('#currentPage').val();
            o.currentPage = currentPage;
            o.pager.empty();
            $.line.setLine(totalPage, o); //呼叫生成分頁控件的函式
        },
        error: function(){
            alert("error");
        }
    })
}

這裡有個約定:回傳的 HTML 中要含 #totalPage 與 #currentPage 兩個隱藏欄位,前端才能取到總頁數與實際所在頁。

setLine:生成分頁按鈕

$.line = {
    setLine: function(totalPage, o){
        for (var i = 0; i < totalPage; i++){
            var a = $('<a/>').html('<span>' + (i + 1) + '</span>').addClass('pageA').bind('click', function(){
                var s = $(this);
                s.siblings().removeClass('pageActive');
                s.addClass('pageActive');
                o.currentPage = s.text();
                $.page.loadData(o);
            });
            if (o.currentPage == i + 1){
                a.addClass('pageActive');
            }
            o.pager.append(a);
        }
        var limit = this.getLimit(o, totalPage);
        var aPage = o.pager.find('a.pageA').not('a.previous,a.nextAll,a.record');
        aPage.hide();
        aPage.slice(limit.start, limit.end).show();
        var prev = $('<a/>').html('<span>上一頁</span>').addClass('pageA previous').unbind('click').bind('click', function(){
            var pageActive = o.pager.find('a.pageActive');
            if (pageActive.prev().text() == '上一頁'){
                alert('已經是第一頁!');
                return false;
            }
            pageActive.removeClass('pageActive');
            pageActive.prev().addClass('pageActive');
            o.currentPage = pageActive.prev().text();
            $.page.loadData(o);
        });
        var next = $('<a/>').html('<span>下一頁</span>').addClass('pageA nextAll').unbind('click').bind('click', function(){
            var pageActive = o.pager.find('a.pageActive');
            if (pageActive.next().text() == '下一頁'){
                alert('已經是最後一頁!');
                return false;
            }
            pageActive.removeClass('pageActive');
            pageActive.next().addClass('pageActive');
            o.currentPage = pageActive.next().text();
            $.page.loadData(o);
        });
        var pageActiveText = o.pager.find('a.pageActive').text();
        var record = $('<a/>').html('<span>' + pageActiveText + '/' + totalPage + '</span>').addClass('pageA record');
        o.pager.prepend(prev).prepend(record).append(next);
    }
}

getCurrentPage 與 genData

因為目前頁的按鈕帶有 pageActive 類,所以取當前頁變得很簡單:

getcurrentPage: function(o){
    var p = o.pager.find("a.pageActive").text();
    return p;
}

接著生成要發送的 json 資料:

genData: function(o){
    var sdata = $.extend({}, {
        "currentPage": o.currentPage,
        "pageSize": o.pageSize
    }, $.jsonObj(o.pageForm));
    return sdata;
},

$.jsonObj 是自訂函式,負責把表單序列化成 json,目前只支援 input 與 select:

$.jsonObj = function(form){
    //判斷是否有可序列化的內容
    if (!$(form).html() || $(form).html() == null || $.trim($(form).html()) == "") {
        return null;
    }
    var formEl = $(form).find('input[type="text"]');
    var formselect = $(form).find('select');
    var json = "{";
    for (var i = 0; i < formEl.length - 1; i++) {
        var name = formEl.eq(i).attr('name');
        var val = "'" + formEl.eq(i).val() + "'";
        json += name; json += ":"; json += val; json += ",";
    }
    var lname = formEl.eq(formEl.length - 1).attr('name');
    var lval = "'" + formEl.eq(formEl.length - 1).val() + "'";
    json += lname; json += ":"; json += lval;
    if (formselect) {
        json += ",";
        for (var i = 0; i < formselect.length - 1; i++) {
            var name = formselect.eq(i).attr('name');
            var val = "'" + formselect.eq(i).val() + "'";
            json += name; json += ":"; json += val; json += ",";
        }
        var lname = formselect.eq(formselect.length - 1).attr('name');
        var lval = "'" + formselect.eq(formselect.length - 1).val() + "'";
        json += lname; json += ":"; json += lval;
    }
    json += "}";
    var jsonObj = eval("(" + json + ")")
    return jsonObj;
}

記住查詢條件

這是需求三的答案:查詢時把表單內容複製一份到隱藏的 pageForm,之後翻頁就都會帶著這些條件走。

handleQueryLine: function(o){
    $(o.form).find(".query").click(function(){
        $(o.pageForm).empty();
        $(o.form).find('input[type="text"]').each(function(){
            var vals = $(this).val();
            var s = $(this).clone().val(vals);
            $(o.pageForm).append(s);
        });
        $(o.form).find('select').each(function(){
            var vals = $(this).val();
            var s = $(this).clone().val(vals);
            $(o.pageForm).append(s);
        });
        $.page.query(o);
    });
}

主函式

$.fn.simplePage = function(os){
    var options = {
        pager: '.pager',
        container: '.tableData',
        form: '#form',
        pageForm: '#pageForm',
        url: '',
        currentPage: 1,
        pageSize: 2,
        type: null,
        pageShow: 7
    };
    var o = $.extend(options, os);
    return this.each(function(){
        o.pager = $(this).find(o.pager);
        o.container = $(this).find(o.container);
        //先清除 click 事件,避免重複綁定
        o.pager.unbind('click');
        if (o.type == 'action') {
            //指定動作,例如刪除時的事件,此時需要在當前頁刷新資料
            o.currentPage = $.page.getPageSize(o);
            o.pageSize = $.page.getCurrentPage(o);
            $.page.loadData(o);
            return;
        }
        $.page.loadData(o);
        $.line.handleQueryLine(o);
    })
}

加上樣式

用 Firebug 檢視生成後的結構,寫了以下樣式:

.pager a {
    display: block;
    float: left;
    width: 16px;
    height: 16px;
    margin: 5px;
}
.pager a.pageA{
    background:url("../images/grid/page.png") no-repeat left 0px transparent;
    display:inline-block;
    font-size:14px;
    margin:0 3px;
    padding-left:6px;
    text-align:center;
    vertical-align:bottom;
    height:auto;
    width:auto;
    cursor:pointer;
}
.pager a.pageA span{
    background:url("../images/grid/page.png") no-repeat right 0px transparent;
    display:inline-block;
    height:24px;
    line-height:22px;
    padding-right:6px;
}
.pager a.pageActive{
    background:url("../images/grid/page.png") no-repeat left -24px transparent;
}

這裡用的是 Sprite 的滑門技巧:a 與其內的 span 各取背景圖的左右兩端,中間靠 padding 撐開,這樣一顆按鈕就能自由伸縮寬度而不失真。

大功告成。整個插件的設計重點在於把「資料取得」「按鈕生成」「條件保存」三件事拆開,彼此透過傳入的 options 物件溝通,因此換頁面時只要換 url 與容器選擇器就能沿用。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved