DIV CSS 佈局教程網

StepJump 元件:多步驟多分步表單流程的完整實作
編輯:關於JavaScript     

近期工作有一個多步驟、多小步的表單頁面:整個業務分成幾個大步驟,每個大步驟底下又可能細分若干小步驟,大小步驟之間都是順序發生。原本以為這與 tab 頁差不多,真正動手才發現邏輯 complexity 遠超預期,尤其是當它還必須與表單驗證及業務狀態結合時。

我把相關邏輯抽象成一個名為 StepJump 的元件,既能處理純靜態的分步切換,也能承載與業務狀態耦合的複雜流程。

附帶兩個示例頁面:demo.html 演示純靜態的內容切換,regist.html 則是與業務結合的完整案例,其中的業務狀態以一個 STEP_STATUS 常數模擬。元件本體封裝於 stepJump.js,以 seajs 做模組化。

一、需求分析

靜態功能面:

  1. 共四個大步驟,其中 1、3、4 各只有一個小步驟,2 則有三個。
  2. 步驟嚴格順序發生,前一步未完成不得進入下一步。
  3. 每個大步驟的第一個小步可能提供返回上一大步的按鈕。
  4. 中間的小步通常有兩個按鈕:返回上一小步、前往下一小步。
  5. 最後一個小步可能提供前往下一大步的按鈕。
  6. 若某大步驟只含一個小步,它同時是第一個也是最後一個。
  7. 同一時間只顯示一個小步驟的內容。
  8. 已完成、進行中、待執行三種狀態需有明確的視覺區隔。
  9. 待執行的大步驟必須透過前一大步驟最後小步的按鈕才能進入;已完成與進行中的可點標題直接跳轉。
  10. 點擊大步驟標題時,跳往該大步驟的第一個小步。

業務面:頁面開放給登入使用者,作為平台入駐申請流程。依入駐狀態不同,進入頁面時要停在不同的步驟:待填寫資料對應【1 入住須知】、待提交資料對應【2 公司信息提交】、審核未通過與已通過都對應【3 等待審核】、待確認合同則對應【4 合同簽訂】。

特別的是,【3 等待審核】與【4 合同簽訂】底下各有 3 個與 2 個互斥內容,它們並非分步關係,顯示哪一項完全由業務狀態決定。而且審核未通過時,步驟標題還要加上特殊樣式:



直接點擊標題時該特殊樣式需還原為預設外觀;只有透過【2 公司信息提交】的小步按鈕前進到【3 等待審核】時,才完整套用該效果。

設計上的取捨是:靜態功能需求才是元件核心,業務需求不具通用性。因此元件的出發點是先滿足靜態需求,再據此設計合理的 API 與回呼,並盡量做到樣式與邏輯分離、元件與業務分離。

二、實作思路

HTML 結構上需要兩個集合分別存放大步驟與小步驟,並靠一個配置陣列表達彼此的包含關係:

 <nav class="nav-step">
  <ul id="steps" class="steps">
    <li><a href="javascript:;">1<span class="gap"></span>入住須知</a></li>
    <li><a href="javascript:;">2<span class="gap"></span>公司信息提交</a></li>
    <li><a href="javascript:;">3<span class="gap"></span>等待審核</a></li>
    <li><a href="javascript:;">4<span class="gap"></span>合同簽訂</a></li>
  </ul>
</nav>
<div id="step-content" class="step-content">
  <div class="step-pane"></div>
  <div class="step-pane"></div>
  <div class="step-pane"></div>
  <div class="step-pane"></div>
  <div class="step-pane"></div>
  <div class="step-pane"></div>
</div>

包含關係用 [1,3,1,1] 這樣的陣列即可描述:四個大步驟,其中第二個有三個小步驟。但由於兩份集合各自從 0 開始索引,小步驟的絕對位置不好辨識,若每個小步都各自初始化了表單等元件並存入配置表,維護起來很痛苦:

 var STEP_CONFIG = {
  0: { form: { /* ... */ } },
  1: { form: { /* ... */ } },
  2: { form: { /* ... */ } }
}

更理想的方式是用「大步驟索引 → 小步驟索引」的兩層結構:

 var STEP_PANES_CONFIG = {
  // 2,1 表示第二個大步驟的第一個小步驟內容
  2: {
    1: { /* 配置小步驟相關的東西 */ },
    2: { /* 配置小步驟相關的東西 */ },
    3: { /* 配置小步驟相關的東西 */ }
    /* 配置大步驟相關的東西 */
  }
}

這樣有兩個好處:不必操心索引從 0 開始,STEP_PANES_CONFIG[2] 就是第二大步;小步驟索引也相對大步驟表示,HTML 結構調整時配置表不受影響。代價是元件內部必須負責邏輯索引與物理索引之間的雙向轉換。

視覺效果上:步驟內容只需 active 與預設兩態;箭頭邊角可用 CSS 邊框畫三角形的技巧實現;大步驟則需 done、current 與預設三態,實作方式與常見的評分元件類似。

三、實作細節

 var DEFAULTS = {
  config: [],       // 必傳,如 [1,2,3] 表示三個大步驟,各有 1/2/3 個內容項
  stepPanes: '',    // 必傳,步驟內容項的 jq 選擇器
  navSteps: '',     // 必傳,步驟項的 jq 選擇器
  initStepIndex: 1, // 初始顯示的步驟位置
  initPaneIndex: 1, // 初始顯示的內容項位置(基於 initStepIndex)
  onStepJump: $.noop,        // 大步驟跳轉時的回呼
  onBeforePaneChange: $.noop,// 內容項切換前的回呼
  onPaneChange: $.noop,      // 內容項切換後的回呼
  onPaneLoad: $.noop         // 內容項首次顯示時的回呼
};

四個回呼的用途:

onStepJump(oldStepIndex, targetStep):大步驟跳轉時觸發,審核步驟的特殊樣式控制就靠它,兩個參數皆為物理索引。

onBeforePaneChange(currentPane, targetPane, currentStep):切換前觸發,若小步驟中的表單驗證未通過,回傳 false 即可取消切換。

onPaneChange(currentPane, targetPane, currentStep):切換完成後觸發。

onPaneLoad(e, currentStep, currentPane):用途最關鍵,小步驟內部的表單等元件都在此延遲初始化,且 this 已指向該小步驟的 DOM 元素,便於向下尋找子元素。每個小步驟只會觸發一次。

觸發順序為 onBeforePaneChange → onPaneChange → onPaneLoad → onStepJump,其中 onPaneLoad 在元件初始化時也會呼叫一次。

對外 API 只保留三個:

 return {
  goStep: function(step) { goStep(step - 1); },
  goNext: function() { go(currentPane + 1); },
  goPrev: function() { go(currentPane - 1); }
}

另有一個靜態方法負責把物理索引轉為邏輯索引:

 // config: [1,3,1,1], step: 2, pane: 4 會回傳 1
StepJump.getRelativePaneIndex = function(config, step, pane) {
  return pane - getPaneCountBeforeStep(config, step) + 1;
};

元件全文如下:

 define(function(require, exports, module) {
  var $ = require('jquery');
  var DEFAULTS = {
    config: [], stepPanes: '', navSteps: '',
    initStepIndex: 1, initPaneIndex: 1,
    onStepJump: $.noop, onBeforePaneChange: $.noop,
    onPaneChange: $.noop, onPaneLoad: $.noop
  };

  function StepJump(options) {
    var opts = $.extend({}, DEFAULTS, options),
      $stepPanes = $(opts.stepPanes),
      $navSteps = $(opts.navSteps),
      config = opts.config,
      stepPaneCount = sum.apply(null, config),
      currentStep = opts.initStepIndex - 1,
      currentPane = sum.apply(null, config.slice(0, currentStep)) + (opts.initPaneIndex - 1),
      maxStepIndex = currentStep,
      $activePane = $stepPanes.eq(currentPane);

    // 每個內容項的 stepLoad 只觸發一次
    $stepPanes.each(function() {
      $(this).one('stepLoad', $.proxy(function() {
        opts.onPaneLoad.apply(this, [].slice.apply(arguments).concat([currentStep, currentPane]));
      }, this));
    });

    showStep(currentStep);
    $activePane.addClass('active').trigger('stepLoad');

    $navSteps.on('click.step.jump', function() {
      var $this = $(this), step = $this.index(opts.navSteps);
      if (step > maxStepIndex || $this.hasClass('current')) return;
      goStep(step);
    });

    function showStep(targetStep) {
      $navSteps.each(function(i) {
        var cname = this.className;
        cname = $.trim(cname.replace(/current|done/g, ''));
        if (i < targetStep) { cname += ' done'; }
        else if (i == targetStep) { cname += ' current'; }
        this.className = cname;
      });
    }

    function goStep(step) { go(getPaneCountBeforeStep(config, step)); }

    function getStepByPaneIndex(targetPane) {
      var r = 0, targetStep = 0;
      for (var i = 0; i < stepPaneCount; i++) {
        r = r + config[i];
        if (targetPane < r) { targetStep = i; break; }
      }
      return targetStep;
    }

    function go(targetPane) {
      if (targetPane < 0 || targetPane >= stepPaneCount) return;
      var ret = opts.onBeforePaneChange(currentPane, targetPane, currentStep);
      if (ret === false) return;
      var $targetPane = $stepPanes.eq(targetPane),
        targetStep = getStepByPaneIndex(targetPane);
      $activePane.removeClass('active');
      $targetPane.addClass('active');
      opts.onPaneChange(currentPane, targetPane, currentStep);
      $activePane = $targetPane;
      currentPane = targetPane;
      var oldStepIndex = currentStep;
      currentStep = targetStep;
      currentStep > maxStepIndex && (maxStepIndex = currentStep);
      $targetPane.trigger('stepLoad');
      if (targetStep !== oldStepIndex) {
        showStep(targetStep);
        opts.onStepJump(oldStepIndex, targetStep);
      }
    }

    return {
      goStep: function(step) { goStep(step - 1); },
      goNext: function() { go(currentPane + 1); },
      goPrev: function() { go(currentPane - 1); }
    }
  }

  StepJump.getRelativePaneIndex = function(config, step, pane) {
    return pane - getPaneCountBeforeStep(config, step) + 1;
  };

  function sum() {
    var a = [].slice.apply(arguments), r = 0;
    a.forEach(function(n) { r = r + n; });
    return r;
  }

  function getPaneCountBeforeStep(config, step) {
    return sum.apply(null, config.slice(0, step));
  }

  return StepJump;
});

四、呼叫範例

純靜態場景,不需要任何回呼:

 define(function(require, exports, module) {
  var $ = require('jquery');
  var StepJump = require('components/stepJump'),
    stepJump = new StepJump({
      config: [1,3,1,1],
      stepPanes: '#step-content .step-pane',
      navSteps: '#steps > li',
      initStepIndex: 1
    });
  $(document).on('click.stepPane.switch', '.btn-step', function(e) {
    var $this = $(this);
    if ($this.hasClass('next')) { stepJump.goNext(); } else { stepJump.goPrev(); }
  });
});

與業務結合的場景,靠 STEP_STATUS 切換不同狀態來驗證:

 // STEP_STATUS 取值:
 // 0 待填寫資料 -> 顯示【1 入住須知】
 // 1 待提交資料 -> 顯示【2 公司信息提交】,小步驟預設第一個
 // 2 審核未通過 -> 顯示【3 等待審核】
 // 3 審核已通過 -> 顯示【3 等待審核】
 // 4 待確認合同 -> 顯示【4 合同簽訂】
 var STEP_STATUS = 3,
  MODE = STEP_STATUS == 2 || STEP_STATUS == 4 ? 3 : 2,
  STEP_AUDIT_ALERTS = STEP_STATUS == 3,
  STEP_STATUS_MAP = { 0: 1, 1: 2, 2: 3, 3: 3, 4: 4 },
  initStepIndex = STEP_STATUS_MAP[STEP_STATUS],
  STEP_PANES_DATA = [1, 3, 1, 1],
  STEP_PANES_CONFIG = {
    3: {
      1: {
        onPaneLoad: function(e, currentStep, currentPane, conf) {
          var $stepPane = $(this);
          conf.vc = new VisibleController($stepPane.children('div'));
          if (STEP_AUDIT_ALERTS) {
            $auditStep = $('#audit-step');
            $auditStep.addClass('alerts');
            conf.vc.show('#audit-no');
          } else if (STEP_STATUS == 2 || STEP_STATUS == 4) {
            conf.vc.show('#audit-yes');
          } else {
            conf.vc.show('#audit-wait');
          }
        }
      },
      onLeaveStep: function() {
        STEP_AUDIT_ALERTS && $auditStep.removeClass('alerts');
      },
      onEnterStep: function(step, conf) {
        if (STEP_AUDIT_ALERTS) { $auditStep.addClass('alerts'); }
        else { conf[1].vc.show('#audit-wait'); }
      }
    },
    4: {
      1: {
        onPaneLoad: function(e, currentStep, currentPane, conf) {
          var $stepPane = $(this);
          conf.vc = new VisibleController($stepPane.children('div'));
          conf.vc.show('#contract-confirm');
        }
      }
    }
  },
  GET_STEP_PANES_CONFIG = function(step, pane) {
    if (pane == undefined) return STEP_PANES_CONFIG[step + 1];
    return STEP_PANES_CONFIG[step + 1] &&
      STEP_PANES_CONFIG[step + 1][StepJump.getRelativePaneIndex(STEP_PANES_DATA, step, pane)];
  };

 var $auditStep, stepJump = new StepJump({
  config: STEP_PANES_DATA,
  stepPanes: '#step-content .step-pane',
  navSteps: '#steps > li',
  initStepIndex: initStepIndex,
  onBeforePaneChange: function(currentPane, targetPane, currentStep) {
    var conf = GET_STEP_PANES_CONFIG(currentStep, currentPane);
    return conf && conf.onBeforePaneChange &&
      conf.onBeforePaneChange.apply(this, [].slice.apply(arguments).concat([conf]));
  },
  onPaneChange: function() { window.scrollTo(0, 0); },
  onPaneLoad: function(e, currentStep, currentPane) {
    var conf = GET_STEP_PANES_CONFIG(currentStep, currentPane);
    conf && conf.onPaneLoad &&
      conf.onPaneLoad.apply(this, [].slice.apply(arguments).concat([conf]));
  },
  onStepJump: function(currentStep, targetStep) {
    var conf = GET_STEP_PANES_CONFIG(currentStep);
    conf && conf.onLeaveStep && conf.onLeaveStep(currentStep, conf);
    conf = GET_STEP_PANES_CONFIG(targetStep);
    conf && conf.onEnterStep && conf.onEnterStep(targetStep, conf);
  }
});

只要替換 STEP_STATUS 的值,就能模擬不同業務狀態進入頁面時的呈現差異。

五、小結

StepJump 把大步驟與小步驟的包含關係、順序約束、狀態樣式與延遲初始化都收攏在一個元件裡,透過 config 描述結構、透過回呼對接業務,元件本身則完全不認識任何具體業務。除了這個元件,這階段思考比較多的其實是樣式分離、CSS 命名與表單元件拆分,只是這些方法論還未成體系,等累積夠成熟再另行整理分享。

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