DIV CSS 佈局教程網

封裝可翻頁的捲動列表外掛
編輯:JQuery特效代碼     

需求是這樣:一次讀取十幾筆資料,畫面上只顯示幾筆,透過「上一頁/下一頁」翻動捲動,一次滾 N 筆。做法是把整套邏輯封裝成一個物件,只要在 HTML 元素上標註約定的 class 就能使用。

HTML 結構與約定 class

<style>
ul._rollSe  { width:100px; height:300px; overflow:hidden; }
ul._rollSe li._rollPar { height:100px; border:1px solid #369; }
</style>

<div class="_rollParent">
  <ul class="_rollPageSe">
    <li class="_rollpage">1</li>
    <li class="_rollpage">2</li>
  </ul>
  <div>
    <a href="#" class="_scrollPrev" data-frequency="3" data-pr="happy">上一頁</a>
    <a href="#" class="_scrollNext" data-frequency="3" data-pr="happy">下一頁</a>
  </div>
  <ul class="_rollSe">
  <?php for($a=1; $a<10; $a++): ?>
    <li class="_rollPar"><?php echo $a; ?></li>
  <?php endfor; ?>
  </ul>
</div>

<script type="text/javascript" src="/js/jquery/scrollTo/jquery.scrollTo-min.js"></script>

class 命名約定一覽

作者:teresa,2011-03-28。以下為必填的 class:

_rollParent  觸發事件的上層容器
_rollSe      滾動區域
_rollPar     滾動元素(每一筆)
_scrollNext  下一頁按鈕
_scrollPrev  上一頁按鈕
_rollPageSe  分頁區域
_rollpage    頁碼元素
data-frequency  滾動頻率(一次滾 3 個元素),標註在觸發按鈕上
data-pr         cookie 前綴

說明:一次讀取幾筆資料,畫面只顯示幾筆,滾動翻頁(一次滾 3 筆或 n 筆)。只要在需要滾動效果的 HTML 元素上標註以上 class 即可使用。

初始化與事件綁定

$(function(){
  _scroll.init();                                  // 初始顯示

  $('._scrollPrev').live('click', function(){      // 上滾
    _scroll.prev(this);
    return false;
  });

  $('._scrollNext').live('click', function(){      // 下滾
    _scroll.next(this);
    return false;
  });
});

核心物件

var _scroll = {
  // 滾動位置以 cookie 保存
  config: {
    ckname   : 'lifedu_rollCur',
    ckoptions: { expires: 3, path: '/' }         // 3 天、全站有效
  },

  // 初始化
  init: function(){
    var roll = $('._rollParent');
    for (var i = 0; i < roll.length; i++) {
      var cookieName = roll.eq(i).find('._scrollNext').attr('data-pr') + "_lifedu_rollCur";
      var oStr = $.cookie(_scroll.config.ckname) || '{}';
      var json = eval('(' + oStr + ')');
      var cur  = 0;
      var page = 0;
      var rollPar = roll.eq(i).find('._rollPar');

      roll.eq(i).find('._scrollPrev').addClass('disabled');
      roll.eq(i).find('._rollSe').scrollTo(rollPar.eq(cur), 50);
      roll.eq(i).find('._rollPageSe').find('_rollpage').removeClass('ac').eq(page).addClass('ac');

      json.cur = cur;  json.page = page;
      $.cookie(cookieName, JsonToStr(json), _scroll.config.ckoptions);
    }
  },

  _p : {},

  // 前置處理:把當前操作所需的資訊都備妥
  _pre: function(o){
    _scroll.config.ckname = $(o).attr('data-pr') + "_lifedu_rollCur";
    _scroll._p.rollFrequency = parseInt($(o).attr('data-frequency'));
    _scroll._p.rollSe = $(o).parents('._rollParent').find('._rollSe');
    _scroll._p.rollPar = _scroll._p.rollSe.find('._rollPar');
    _scroll._p.rlen = _scroll._p.rollPar.length;
    _scroll._p.rollPageSe = $(o).parents('._rollParent').find('._rollPageSe');
    _scroll._p.rollPageLen = _scroll._p.rollPageSe.find('._rollpage').length;
  },

  // 下滾
  next: function(o){
    _scroll._pre(o);
    var oStr = $.cookie(_scroll.config.ckname) || '{}';
    var json = eval('(' + oStr + ')');
    var last = _scroll._p.rlen - 1;
    var n    = _scroll._p.rollFrequency;
    var cur  = parseInt(json.cur)  || 0;    // 當前元素索引
    var page = parseInt(json.page) || 0;    // 當前頁碼

    if (cur + n < last)      { cur += n; page++; }
    else if (cur == last)    { return; }
    else                     { cur = last; page = _scroll._p.rollPageLen - 1; }

    // 到最後一頁就把下一頁按鈕變灰
    $(o).parents('._rollParent').find('._scrollPrev').removeClass('disabled');
    if (page == _scroll._p.rollPageLen - 1) { $(o).addClass('disabled'); }
    else                                    { $(o).removeClass('disabled'); }

    _scroll._p.rollSe.scrollTo(_scroll._p.rollPar.eq(cur), 500);
    _scroll.goPage(page);

    json.cur = cur;  json.page = page;
    $.cookie(_scroll.config.ckname, JsonToStr(json), _scroll.config.ckoptions);
  },

  // 上滾
  prev: function(o){
    _scroll._pre(o);
    var oStr = $.cookie(_scroll.config.ckname) || '{}';
    var json = eval('(' + oStr + ')');
    var cur  = parseInt(json.cur)  || 0;
    var page = parseInt(json.page) || 0;
    var n    = _scroll._p.rollFrequency;

    if (cur - n > 0) {
      if (cur == _scroll._p.rlen - 1) { cur -= 2 * n - 1; }   // 從末頁回退要跳兩段
      else                            { cur -= n; }
      if (cur < 0) { cur = 0; }
      page--;
    } else if (cur == 0) { return; }
    else                 { cur = 0; page = 0; }

    $(o).parents('._rollParent').find('._scrollNext').removeClass('disabled');
    if (page == 0) { $(o).addClass('disabled'); }
    else           { $(o).removeClass('disabled'); }

    _scroll._p.rollSe.scrollTo(_scroll._p.rollPar.eq(cur), 500);
    _scroll.goPage(page);

    json.cur = cur;  json.page = page;
    $.cookie(_scroll.config.ckname, JsonToStr(json), _scroll.config.ckoptions);
  },

  goPage : function(p){
    if (_scroll._p.rollPageSe.length != 0) {
      _scroll._p.rollPageSe.find('._rollpage').removeClass('ac').eq(p).addClass('ac');
    }
  }
}

這個封裝設計得好的地方

一、用約定 class 取代參數。 呼叫方不必寫任何設定,只要在 HTML 上標註 _rollParent、_rollSe 這些 class,元件自己會找到所有相關元素。對非程式的頁面編輯者很友善,這個模式在 CMS 裡很常見。

二、_pre() 集中準備上下文。 每次 next/prev 之前先把「當前容器、滾動區、元素總數、頁數、頻率」一次備妥放進 _p,後面的邏輯就能專心處理邊界判斷,可讀性比散落各處好很多。

三、用 cookie 記住位置。 使用者翻到第 3 頁後離開,回來時還在第 3 頁。這對長清單很貼心。而且 cookie 名稱用 data-pr 當前綴,讓同一頁的多個滾動列表各自記自己的位置,不會互相覆蓋。

四、首末頁按鈕自動變灰。 到邊界時加上 disabled class 並在判斷中直接 return,避免使用者按了沒反應卻不知道是為什麼。

必須修正的幾個問題

雖然設計思路清楚,這份 2011 年的程式碼有幾處在今天會直接出錯,使用前請務必處理。

第一,.live() 已被移除。 jQuery 1.9 起 live 不復存在,請改用事件委派:$(document).on('click', '._scrollPrev', function(){ ... })。

第二,eval('(' + oStr + ')') 是危險寫法。 用 eval 解析 cookie 字串,等於把 cookie 內容當程式碼執行,而 cookie 是使用者可任意竄改的,這構成了 XSS 缺口。請改用 JSON.parse(),並用 try/catch 包住以處理格式錯誤的情況。

第三,cookie 讀寫名稱不一致。 init 裡算出 cookieName(帶 data-pr 前綴)寫入,但 next/prev 讀的是 _scroll.config.ckname;雖然 _pre() 會重新設定 ckname 讓它湊巧能動,但這種「靠副作用運作」的耦合非常脆弱。建議統一改成每個容器有自己的狀態物件,並用 jQuery 的 .data() 保存,或乾脆把狀態存在 closure 裡,不必繞 cookie。

第四,find('_rollpage') 少了點。 這裡想找的是 class,應寫成 find('._rollpage'),否則它會去找名為 _rollpage 的 HTML 標籤,永遠找不到。

第五,cookie 依賴讓 SSR 與無 cookie 環境失效。 若專案有 cookie 同意規範或使用者停用 cookie,位置記憶會靜默失效。改成 sessionStorage 或 localStorage 會更合適,也能存更多狀態。

最後談維護成本:這種「靠 HTML class 約定驅動」的設計雖然方便,但一旦 class 命名與 CSS 樣式衝突(例如專案剛好有 .disabled 或 .ac)就會出問題。若要在新專案沿用,建議加上外掛專屬前綴(如 js-roll-prev),並把狀態與 DOM 的關聯改用 .data() 管理,會比全域物件加 cookie 的組合乾淨得多。

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