向導(Wizard)是那種「把一件複雜的事拆成幾小步」的交互模式:一步問一個問題,用戶選完自動前進,還能回頭改。下面用原生 JavaScript 加一點 jQuery,做一個可定製的通用向導。示例場景是「禮物推薦」。
index.html 只提供一個占位容器,其餘全部由腳本生成:
<html> <head> <title>禮物推薦向導</title> <meta http-equiv="content-type" content="text/html; charset=utf-8"> <link rel="stylesheet" type="text/css" href="style.css"> <script src="jquery.js" type="text/javascript"></script> <script src="wizard.js" type="text/javascript"></script> </head> <body> <div id="wizard"></div> </body> </html>
約定一下結構:向導裡有一個 h2 顯示標題、一個 ul 承載主要內容、一個 div 作為按鈕條。默認樣式可以很樸素,實際項目裡再美化:
body{ margin:0; }
/* 向導容器 */
#wizard{
height:400px;
width:600px;
background-color:#999;
}
/* 主體內容用列表展示 */
#wizard ul{
margin:10px;
height:80%;
}
/* 橫向排列列表項 */
#wizard li{
display:inline-block;
margin:10px;
cursor:pointer;
}
#wizard h2{ margin:10px; }
/* 功能條,如返回按鈕 */
#wizard .bar{
margin:10px;
clear:both;
}
設計思路是:每一步自己負責自己的事情——負責畫界面、負責捕捉用戶選擇,但必須遵守我們約定的「契約」。
契約是這樣的:每個步驟是一個函數,接受兩個參數。data_key 是選擇本步數據的關鍵字,通常由上一步的結果決定;result_callback 是回調,本步拿到結果時調用,用於跟向導類通信——向導類收到後存下結果並前進到下一步。函數返回一個二元組:第一項是本步標題,第二項是本步主體的 UI。
function step1(data_key, result_callback){
var targets = ['女朋友','男朋友','父親','媽媽','孩子'];
var wrapper = $('<ul></ul>');
$.each(targets, function(k, v){
$('<li>' + v + '</li>')
.click(function(){ result_callback(v); })
.appendTo(wrapper);
});
return ['第一步:請選擇送禮物的對象', wrapper];
}
function step2(data_key, result_callback){
var tags = {
'女朋友': ['創意','可愛','浪漫','激情','實用','數碼',
'自制','毛絨玩具','衣服','包包'],
'男朋友': ['男士用品','溫馨','實用','數碼','創意','衣物'],
'父親' : ['男士用品','健康','植物','衣物'],
'媽媽' : ['溫馨','健康','創意','護膚品','實用'],
'孩子' : ['玩具','學習用品','實用','數碼']
};
var wrapper = $('<ul></ul>');
$.each(tags[data_key], function(k, v){
$('<li>' + v + '</li>')
.click(function(){ result_callback(v); })
.appendTo(wrapper);
});
return ['第二步:請選擇關鍵詞', wrapper];
}
function step3(data_key, result_callback){
var price_level = ['便宜','普通','稍貴','貴重'];
var wrapper = $('<ul></ul>');
$.each(price_level, function(k, v){
$('<li>' + v + '</li>')
.click(function(){ result_callback(v); })
.appendTo(wrapper);
});
return ['第三步:請選擇價格區間', wrapper];
}
注意 step2 裡的 tags[data_key]——這就是「上一步的結果決定下一步的內容」,也是 data_key 這個參數存在的意義。
向導類需要知道三件事:掛在哪個 DOM 元素上、有哪些步驟、做完之後幹什麼。另外它還要提供前進與後退的能力,並用一個私有的 index 維護當前狀態。
function Wizard(container, steps, callback){
this.container = container; // 向導容器
this.steps = steps; // 步驟列表
this.callback = callback; // 全部完成後的回調
this.collect_data = []; // 保存每一步的結果
this.index = -1; // 當前執行到第幾步
}
// 繪製某一步驟
Wizard.prototype.render = function(step, this_result){
var me = this;
// 執行該步驟並取得它的 UI
var to_append = step(this_result, function(result){
me.collect_data.push(result); // 收集本步結果
// 全部走完就調用完成回調,否則進入下一步
if(me.collect_data.length == me.steps.length)
me.callback(me.collect_data);
else
me.next(result);
});
// 繪製本步 UI
this.container.empty();
this.container.append("<h2>" + to_append[0] + "</h2>");
this.container.append(to_append[1]);
if(this.index > 0){
// 第一步不顯示後退按鈕
this.container.append(
$("<div class='bar'><a href='javascript:;'>後退</a></div>")
.click(function(){ me.back(); })
);
}
};
// 前進一步
Wizard.prototype.next = function(this_result){
if(this.index >= this.steps.length - 1)
return;
var step = this.steps[++this.index];
this.render(step, this_result);
};
// 後退一步
Wizard.prototype.back = function(){
if(this.index <= 0)
return;
var step = this.steps[--this.index];
// 回到上一步,但上一步的數據需要「上上一步」的結果來決定
this.collect_data = this.collect_data.slice(0, this.index);
this.render(step, this.collect_data[this.index - 1]);
};
back() 裡那行 slice 是關鍵:後退時必須把「後面幾步已經收集的結果」丟掉,否則用戶改了第一步的答案,後面的數據會與新選擇不一致。
調用起來非常直觀:
new Wizard($('#wizard'), [step1, step2, step3], function(data){
alert('你的選擇:' + data.join(' / '));
});
這個向導結構簡單、可定製性強,把 JavaScript 的函數式特性(用函數表示步驟、用回調串流程)和面向對象特性(用 prototype 封裝狀態)結合在一起,擴展新步驟只需要再寫一個符合契約的函數。
要說不足,Wizard 類裡的界面繪製邏輯和步驟函數裡的繪製邏輯還是有耦合。繼續重構的話,可以把所有繪製相關的動作再抽一層,讓界面改動更加集中、方便替換。