DIV CSS 佈局教程網

自研 jQuery 瀑布流插件:參數配置、插入策略與滾動加載全解析
編輯:JQuery特效代碼     

關於瀑布流佈局的討論文章已經很多——從 CSS 多欄流體佈局的實現技巧,到各大網站瀑布流方案的橫向對比。因為自己日常用 jQuery 比較多,索性把瀑布流封裝成一個插件,圖片素材直接借用了迅雷 UED 上的美圖。

插件核心代碼

;(function($) {
    var
    // 默認參數
    setting = {
        column_width: 204,                    // 列寬
        column_className: 'waterfall_column', // 列的類名
        column_space: 10,                     // 列間距
        cell_selector: '.cell',               // 磚塊選擇器,限定在容器內
        img_selector: 'img',                  // 圖片選擇器
        auto_imgHeight: true,                 // 是否自動計算圖片高度
        fadein: true,                         // 是否漸顯載入
        fadein_speed: 600,                    // 漸顯速率(毫秒)
        insert_type: 1,                       // 1=插入最短列,2=按序輪流插入
        getResource: function(index) { }      // 獲取動態資源,必須返回磚塊元素集合
    },
    waterfall = $.waterfall = {},
    $container = null;

    waterfall.load_index = 0;   // 已加載次數

    $.fn.extend({
        waterfall: function(opt) {
            opt = opt || {};
            setting = $.extend(setting, opt);
            $container = waterfall.$container = $(this);
            waterfall.$columns = creatColumn();
            render($(this).find(setting.cell_selector).detach(), false);
            waterfall._scrollTimer2 = null;
            $(window).bind('scroll', function() {
                clearTimeout(waterfall._scrollTimer2);
                waterfall._scrollTimer2 = setTimeout(onScroll, 300);
            });
            waterfall._scrollTimer3 = null;
            $(window).bind('resize', function() {
                clearTimeout(waterfall._scrollTimer3);
                waterfall._scrollTimer3 = setTimeout(onResize, 300);
            });
        }
    });

    function creatColumn() {   // 創建列
        waterfall.column_num = calculateColumns();
        var html = '';
        for (var i = 0; i < waterfall.column_num; i++) {
            html += '<div class="' + setting.column_className + '" style="width:' + setting.column_width +
                'px; display:inline-block; *display:inline;zoom:1; margin-left:' + setting.column_space / 2 +
                'px;margin-right:' + setting.column_space / 2 + 'px; vertical-align:top; overflow:hidden"></div>';
        }
        $container.prepend(html);
        return $('.' + setting.column_className, $container);
    }

    function calculateColumns() {   // 計算列數
        var num = Math.floor($container.innerWidth() / (setting.column_width + setting.column_space));
        if (num < 1) { num = 1; }   // 保證至少一列
        return num;
    }

    function render(elements, fadein) {   // 渲染元素
        if (!$(elements).length) return;
        var $columns = waterfall.$columns;
        $(elements).each(function(i) {
            if (!setting.auto_imgHeight || setting.insert_type == 2) {
                if (setting.insert_type == 1) {
                    insert($(elements).eq(i), setting.fadein && fadein);
                } else if (setting.insert_type == 2) {
                    insert2($(elements).eq(i), i, setting.fadein && fadein);
                }
                return true;
            }
            if ($(this)[0].nodeName.toLowerCase() == 'img' ||
                $(this).find(setting.img_selector).length > 0) {
                var image = new Image;
                var src = $(this)[0].nodeName.toLowerCase() == 'img'
                    ? $(this).attr('src') : $(this).find(setting.img_selector).attr('src');
                image.onload = function() {   // 圖片加載後才能算出真實尺寸
                    image.onreadystatechange = null;
                    if (setting.insert_type == 1) {
                        insert($(elements).eq(i), setting.fadein && fadein);
                    } else if (setting.insert_type == 2) {
                        insert2($(elements).eq(i), i, setting.fadein && fadein);
                    }
                    image = null;
                };
                image.onreadystatechange = function() {   // 兼容 IE 緩存不觸發 onload
                    if (image.readyState == "complete") {
                        image.onload = null;
                        if (setting.insert_type == 1) {
                            insert($(elements).eq(i), setting.fadein && fadein);
                        } else if (setting.insert_type == 2) {
                            insert2($(elements).eq(i), i, setting.fadein && fadein);
                        }
                        image = null;
                    }
                };
                image.src = src;
            } else {
                if (setting.insert_type == 1) {
                    insert($(elements).eq(i), setting.fadein && fadein);
                } else if (setting.insert_type == 2) {
                    insert2($(elements).eq(i), i, setting.fadein && fadein);
                }
            }
        });
    }

    function public_render(elem) { render(elem, true); }   // 異步數據渲染接口

    function insert($element, fadein) {   // 插入最短列
        if (fadein) {
            $element.css('opacity', 0).appendTo(waterfall.$columns.eq(calculateLowest()))
                    .fadeTo(setting.fadein_speed, 1);
        } else {
            $element.appendTo(waterfall.$columns.eq(calculateLowest()));
        }
    }

    function insert2($element, i, fadein) {   // 按序輪流插入
        if (fadein) {
            $element.css('opacity', 0).appendTo(waterfall.$columns.eq(i % waterfall.column_num))
                    .fadeTo(setting.fadein_speed, 1);
        } else {
            $element.appendTo(waterfall.$columns.eq(i % waterfall.column_num));
        }
    }

    function calculateLowest() {   // 計算最短列的索引
        var min = waterfall.$columns.eq(0).outerHeight(), min_key = 0;
        waterfall.$columns.each(function(i) {
            if ($(this).outerHeight() < min) {
                min = $(this).outerHeight();
                min_key = i;
            }
        });
        return min_key;
    }

    function getElements() {   // 獲取資源
        $.waterfall.load_index++;
        return setting.getResource($.waterfall.load_index, public_render);
    }

    waterfall._scrollTimer = null;
    function onScroll() {   // 滾動加載
        clearTimeout(waterfall._scrollTimer);
        waterfall._scrollTimer = setTimeout(function() {
            var $lowest_column = waterfall.$columns.eq(calculateLowest());
            var bottom = $lowest_column.offset().top + $lowest_column.outerHeight();
            var scrollTop = document.documentElement.scrollTop || document.body.scrollTop || 0;
            var windowHeight = document.documentElement.clientHeight || document.body.clientHeight || 0;
            if (scrollTop >= bottom - windowHeight) {
                render(getElements(), true);
            }
        }, 100);
    }

    function onResize() {   // 窗口縮放時重新排列
        if (calculateColumns() == waterfall.column_num) return;   // 列數未變,無需重排
        var $cells = waterfall.$container.find(setting.cell_selector);
        waterfall.$columns.remove();
        waterfall.$columns = creatColumn();
        render($cells, false);   // 重排時強制不漸顯
    }
})(jQuery);

使用方式

$(selector).waterfall(opt);

其中 selector 為瀑布流容器的選擇器,opt 為配置參數對象。

HTML 結構

容器可以是個空元素,磚塊通過動態加載進入;也可以預先放一些磚塊:

<div id="container">
<div class="cell"><img src="P_000.jpg" /><p>00</p></div>
<div class="cell"><img src="P_001.jpg" /><p>01</p></div>
<div class="cell"><img src="P_002.jpg" /><p>02</p></div>
<!-- ... 更多磚塊 ... -->
</div>

配置參數詳解

  • column_width(默認 204):每列寬度,直接決定瀑布流的列數。
  • column_className(默認 'waterfall_column'):列的類名,方便自定義樣式。
  • column_space(默認 10):列與列之間的間距。
  • cell_selector(默認 '.cell'):磚塊選擇器,插件僅在容器範圍內查找匹配元素。
  • img_selector(默認 'img'):圖片選擇器。若磚塊主題內容是尺寸不固定的圖片,插件需要拿到這些圖片才能計算。
  • auto_imgHeight(默認 true):是否自動計算圖片高度。圖片尺寸固定時請設為 false,能省下大量等待。
  • fadein(默認 true):是否漸顯載入。
  • fadein_speed(默認 600):漸顯速率,單位毫秒。
  • insert_type(默認 1):1 為插入當前最短的那一列,2 為按順序輪流插入。
  • getResource:獲取動態資源的函數,必須返回一個磚塊元素集合。第一個參數 index 是已加載次數,第二個參數是渲染函數;若使用 ajax 異步取數據,拿到數據後需手動調用該渲染函數。每次滾動到瀑布流底部時會自動觸發。

一些必要的吐槽

瀑布流的經典內容就是「寬度相同、高度不同」的圖片。如果能在渲染前就拿到圖片高度,一切都很簡單;但如果拿不到,就必須等圖片實際加載完成才能計算高度——這正是瀑布流最惱人的地方。

由此帶來連鎖問題:圖片加載完成的先後順序不固定(這次這張快,下次那張快),導致磚塊的插入順序每次刷新都可能不同。若業務上要求順序穩定,建議把 insert_type 設為 2,走「按順序輪流插入」的路徑。

另外,插件追求的是使用簡單,但用起來越簡單,內部邏輯就越複雜,潛在的 bug 也會增多,這個插件後續還會持續完善。

目前已在 IE6+、Chrome、Firefox、Opera、Safari 等主流瀏覽器上驗證通過。

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