DIV CSS 佈局教程網

jQuery 表頭固定插件 fixHeader:原理與完整實現
編輯:JQuery特效代碼     

表頭固定是列表頁的刚需功能。網上現成的例子不少,但在常用瀏覽器下顯示效果參差不齊,而且大多基於「手寫一個固定表頭」的思路——遇到動態生成、列數不定的表格就完全無能為力。此外,多數方案只能處理限定高度的情況,一旦限定寬度出現橫向滾動條就束手無策。

我的目標很明確:像 jQuery UI 那樣,找到頁面裡的表格,調一個方法就完成固定表頭。趁著學習寫 jQuery 插件的機會,自己實現了一個。

使用方式

$('#table1').fixHeader({ height: 100 });
$('#table3').fixHeader({ height: 100, width: 500 });

浏覽器支持情況

測試通過:IE7、IE8、Firefox 16.0、Chrome 22.0。

已知 IE9 以下存在列對不齊的問題,暫無環境調試,後續再想辦法解決。

設計說明

  1. 需要 jQuery,開發測試使用 1.8.2,其他版本差異不大。
  2. 表頭部分的 <tr> 必須寫在 <thead> 裡。
  3. 不限定寬度時,自動適應表格寬度(滾動條寬度按 20px 估算,實際容器寬度為表格寬度 + 20px)。
  4. 支持多行表頭固定。
  5. 通常表格所有列都顯示、無橫向滾動條,只需要豎向滾動——這是插件支持的基本場景,同時也支持限定寬度下的表頭固定。
  6. 同時限定寬度和高度時,表頭固定無法單純靠 CSS 實現,必須借助 JS,因此會有輕微閃爍。
  7. 已考慮 table 與 th、td 的 border-width 設置成不同值的情況。
  8. 已保留原表頭中綁定的事件。

特別注意:IE 瀏覽器下一定要設置表格中 td 和 th 的 border-width,否則無法正確計算列寬,表頭和數據部分會錯位。

完整代碼

/*!
 * fixHeader 1.0.0
 * Copyright 2012 chokobo
 *
 * make table header fixed
 *
 * notice: set th, td border-width in IE
 *
 * tested browser: IE7 IE8 firefox16.0 chrome22.0
 */
(function( $, undefined ) {

$.fn.fixHeader = function(options) {
    var defaults = {
        width: '',
        height: ''
    };

    options = $.extend({}, defaults, options);
    var elem = this;

    if (options.height == '') {
        return this;
    }

    var thead = elem.find('thead');
    var fixTable = elem.clone().empty().removeAttr('id');

    // 表頭默認背景色,避免透明導致的穿透
    if (fixTable.css('background-color') == 'transparent' ||
        fixTable.css('background-color') == '') {
        fixTable.css('background-color', '#fff');
    }
    fixTable.css({
        'position': 'absolute',
        'top': '0px',
        'border-bottom': $('tr:eq(0)', thead).find('th:eq(0), td:eq(0)').css('border-bottom-width')
    });

    // 逐列同步寬度,各瀏覽器算法不同
    $('tr:eq(0)', thead).find('th, td').each(function() {
        var col = $(this);
        if ($.browser.mozilla) {
            col.width(col.width());
        } else if ($.browser.chrome) {
            var colBorderWidth = parseInt(col.css('border-width'));
            col.width(col.width() + colBorderWidth);
        } else if ($.browser.msie) {
            var colBorderWidth = parseInt(col.css('border-width'));
            if (colBorderWidth) {
                col.width(col.width() + colBorderWidth + colBorderWidth / 2);
            }
        }
    });

    // 生成浮動表頭
    var dummyHead = thead.clone();
    thead.appendTo(fixTable);
    dummyHead.prependTo(elem);

    var tbodyWrapper = elem.wrap('<div class="body-wrapper"></div>').parent();
    var tableWrapper = tbodyWrapper.wrap('<div class="table-wrapper" style="position:relative;"></div>').parent();
    setTableWidth();
    setWrapperSize();

    fixTable.prependTo(tableWrapper);

    return this;

    function setTableWidth() {
        if ($.browser.mozilla) {
            elem.width(elem.width());
            fixTable.css('width', elem.css('width'));
        } else if ($.browser.chrome) {
            elem.width(elem.outerWidth());
            fixTable.width(elem.outerWidth());
        } else if ($.browser.msie) {
            elem.width(elem.outerWidth());
            fixTable.width(elem.outerWidth());
        } else {
            elem.width(elem.outerWidth());
            fixTable.width(elem.outerWidth());
        }
    }

    function setWrapperSize() {
        var elemWidth = elem.outerWidth(true);
        var elemHeight = elem.outerHeight(true);
        var scrollBarWidth = 20;

        if (options.width == '') {
            tbodyWrapper.css({
                'width': (elemWidth + scrollBarWidth) + 'px',
                'height': options.height,
                'overflow-x': 'hidden',
                'overflow-y': 'auto'
            });
        } else {
            if (elemWidth <= options.width) {
                tbodyWrapper.css({
                    'width': options.width + 'px',
                    'height': options.height,
                    'overflow-x': 'hidden',
                    'overflow-y': 'auto'
                });
            } else {
                tableWrapper.css({
                    'width': options.width,
                    'height': options.height,
                    'overflow': 'auto'
                });
                tableWrapper.scroll(function() {
                    fixTable.css('top', tableWrapper.scrollTop() + 'px');
                });
            }
        }
    }
};

})( jQuery );

另一種思路:chromatable 風格的浮動表頭

下面這份實現走的是另一條路——直接把 thead 克隆到一個獨立表格中,再用 window 的 scroll 事件驅動它跟隨:

(function($) {
    $.chromatable = {
        defaults: {
            width: "900px",     // 容器寬度
            height: "300px",    // 容器高度
            scrolling: "yes"    // yes=跟隨IE滾動條滑動,no=固定在頁面上僅容器滾動條滑動
        }
    };

    $.fn.chromatable = function(options) {
        var options = $.extend({}, $.chromatable.defaults, options);
        return this.each(function() {
            var $divObj = $(this);
            var $tableObj = $divObj.find("table");
            var $uniqueID = $tableObj.attr("ID") + ("wrapper");
            var $class = $tableObj.attr("class");
            var $tableWidth = $tableObj.width();
            var top = $("#" + $tableObj.attr("ID")).offset().top;
            var left = $("#" + $tableObj.attr("ID")).offset().left;

            $divObj.append("<table class='" + $class + "' id='" + $uniqueID + "' \
style='position:absolute;top:" + top + "px;left:" + left + "px;' \
width='" + $tableWidth + "' border='0' cellspacing='0' cellpadding='0'><thead>" +
                $("#" + $tableObj.attr("ID")).find("thead").html() + "</thead></table>");

            $.each($("#" + $tableObj.attr("ID")).find("thead th"), function(i, item) {
                $("#" + $uniqueID).find("thead th").eq(i).width($(item).width());
                $(item).width($(item).width());
            });

            if (options.scrolling === "yes") {
                scrollEvent($tableObj.attr("ID"), $uniqueID);
            }
            resizeEvent($tableObj.attr("ID"), $uniqueID);
        });

        function scrollEvent(tableId, uniqueID) {
            var element = $("#" + uniqueID);
            $(window).scroll(function() {
                var top = $("#" + tableId).offset().top;
                var scrolls = $(this).scrollTop();
                if (scrolls > top) {
                    if (window.XMLHttpRequest) {
                        element.css({ position: "fixed", top: 0 });
                    } else {
                        element.css({ top: scrolls });
                    }
                } else {
                    element.css({ position: "absolute", top: top });
                }
            });
        }

        function resizeEvent(tableId, uniqueID) {
            var element = $("#" + uniqueID);
            $(window).resize(function() {
                var top = $("#" + tableId).offset().top;
                var scrolls = $(this).scrollTop();
                if (scrolls > top) {
                    if (window.XMLHttpRequest) {
                        element.css({ position: "fixed", top: 0 });
                    } else {
                        element.css({ top: scrolls });
                    }
                } else {
                    element.css({ position: "absolute", top: top });
                }
            });
        }
    };
})(jQuery);

兩種方案的取捨

fixHeader 的優勢在於「克隆表格 + 嵌套滾動容器」,同時兼顧了橫向與豎向滾動;chromatable 的優勢在於「獨立浮動表頭 + fixed 定位」,滾動時只有一個表頭節點在動,性能更輕。前者依賴 $.browser 做各瀏覽器寬度補償,在 jQuery 1.9+ 中需要改寫;後者用 window.XMLHttpRequest 判斷是否支持 fixed,思路更值得借鑒。

無論哪種方案,列寬同步永遠是最難的一環——border、padding、box-sizing 都會影響最終渲染寬度,這也是 IE 下必須顯式設置 border-width 的根本原因。

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