DIV CSS 佈局教程網

jQuery powerFloat 萬能浮動層下拉層外掛使用指南
編輯:JQuery特效代碼     

一、寫這個外掛的起心動念

為什麼想寫它?想來想去歸結為一個字:「懶」。不想為兩個明明很類似的功能分別寫一遍程式碼,本該喝茶休閒的時間卻耗在本可避免的重複勞動上。於是乾脆一鼓作氣把這些類似的功能集合起來,一個外掛全部搞定。這裡所說的「類似功能」,指的是那些與某個元素有位置關係的浮動層——例如 tip 提示、滑鼠移過顯示大圖、下拉列表等等。

二、外掛概述

外掛名稱為 jquery-powerFloat.js。powerFloat 顧名思義就是「強大的浮動」。基於 jQuery,未壓縮約 20K 出頭,經 YUI Compressor 壓縮後體積減半,是我寫過程式碼量最多的一個外掛。

主要能力:

  • 支援 hover、click、focus 以及無事件觸發四種模式。
  • 支援多達 12 種定位組合,浮動層超出視窗會自動調整位置。
  • 支援頁面元素載入、Ajax 載入、下拉列表、提示層、tip 效果等。
  • 可自訂外層容器,並內建兩種視覺設計良好的容器樣式。
  • 支援滑鼠跟隨。

三、Demo 與下載

請點開外掛測試頁面實際操作看看。下圖是「滑鼠移過顯示大圖」的效果截圖:

下載

  • JS 檔:jquery-powerFloat.js(未壓縮)或 jquery-powerFloat-min.js(壓縮)
  • 打包:jquery-powerFloat.zip

四、如何使用

使用方式統一為 $(選擇器).powerFloat({..});。先載入 CSS:

<link rel="stylesheet" href="https://www.zhangxinxu.com/study/css/powerFloat.css" type="text/css" />

再載入 jQuery 與外掛:

<script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1.4.4/jquery.min.js"></script>
<script type="text/javascript" src="https://www.zhangxinxu.com/study/js/jquery-powerFloat.js"></script>

假設頁面上有個連結:

<a id="trigger" href="javascript:;" rel="targetBox">經過我</a>

那麼只要:

$("#trigger").powerFloat();

就能實現:滑鼠移過「經過我」這個連結時,在它下方顯示 id 為 targetBox 的元素。

用幾個關鍵詞概括這個外掛,不外乎是:觸發元素(trigger,也就是選擇器綁定的對象)、觸發事件(eventType)、浮動元素(target)、定位。下文所稱的 trigger 即觸發元素,target 即浮動元素。

五、API 參數一覽

參數名預設值說明
width"auto"可選 "inherit"(與觸發元素同寬)、數值或百分比。
offsets{x:0, y:0}浮動層的偏移量,可正可負。
zIndex999浮動層層級;內建小三角為 999+1。
eventType"hover"可選 "click"、"focus";設為其他值則綁定即觸發。
showDelay0eventType 為 hover 時,顯示的延遲毫秒數。
hideDelay0滑鼠移出後隱藏的延遲毫秒數。
hoverHoldtrue浮動層是否容許滑鼠懸停在上面。
hoverFollowfalse可選 true、"x"、"y",是否滑鼠跟隨。
targetMode"common"可選 "ajax"、"list"、"remind",浮動層類型。
targetnull浮動層內容來源,優先於 targetAttr。
targetAttr"rel"另一個內容來源,從觸發元素的屬性取值。
containernull裝載浮動層的容器;自訂類型時可用 "plugin" 使用內建容器。
reverseSharpfalse是否反轉小三角的顯示規則。
position"4-1"浮動層顯示位置,格式為「數字-數字」。
edgeAdjusttrue浮動層超出視窗時是否重新定位。
showCall$.noop顯示時的回呼函式。
hideCall$.noop隱藏時的回呼函式。

六、參數詳解

1. width

與 CSS 的 width 取值相同。

可以是 "auto"(預設)、"inherit" 或具體寬度值。特別的是,"inherit" 繼承的不是父標籤寬度,而是觸發元素的寬度。滑鼠移過一個文字連結而顯示浮動層時,若 width 設為 inherit,浮動層寬度就會等於該 a 標籤的寬度。等寬下拉列表非常好用。

2. offsets

相對於目標位置的偏移量,預設 {x:0, y:0},x 為水平、y 為垂直。偏移方向取決於浮動層與觸發元素的相對位置:位於左側或上方的元素向左上偏移,位於右側或下方的則向右下偏移。

只要記住「以 trigger 為參考點、target 呈輻射狀偏移」就不會搞混。例如 offsets.x = 10,浮動層在右側就右移 10px,在左側就左移 10px。

3. zIndex

浮動層都採用絕對定位,因此有層級問題,預設 999。內建的小三角也是絕對定位,層級比浮動層高一級,所以是 1000。

4. eventType

常見值有 "hover"(預設)、"click"、"focus" 以及 null。hover 表示滑鼠移入移出,focus 適用於表單元素,null 表示無事件——只要綁定 powerFloat 就立刻觸發,這在「點擊 A 元素卻要在 B 元素位置顯示提示」的場景很實用。

5. showDelay

顯示延遲,只有 eventType 為 hover 時才有效,click 與 focus 都是無延遲執行。單位毫秒,大於 0 的整數才生效。

6. hideDelay

滑鼠移出延遲,同樣只對 hover 有效。有兩種情況預設就帶 hideDelay:一是 hoverHold 為 true 時有 200 毫秒的隱藏延遲;二是 eventType 為 focus 時,失去焦點後也有 200 毫秒延遲關閉(用來保護點擊事件)。

7. hoverHold

滑鼠移到浮動層上時,浮動層是否依然顯示,僅對 hover 有效。設為 false 則滑鼠一離開 trigger,target 就隱藏。

8. hoverFollow

是否滑鼠跟隨,可為 false、true 或 "x"、"y"。false 為預設不跟隨;"x" 僅水平跟隨、"y" 僅垂直跟隨,這兩種都不會與 trigger 重疊。若設為 true 則是真正的跟隨,target 左上角會緊貼滑鼠並可能與 trigger 重疊——此時務必設定合適的 offsets,否則會因離滑鼠太近而不斷觸發移入移出,效能差的機器上頁面可能會晃動。

9. targetMode

浮動層類型,內建關鍵字有 "common"(預設,載入頁面元素)、"ajax"(載入外部圖片或 HTML 片段,含 loading 效果)、"list"(專作下拉列表)、"remind"(純文字或含 HTML 的字串提示)。這個外掛最強的地方在於你可以自訂類型:樣式完全自己決定,定位與裝載則交給外掛。

10. target

最重要也最常用的參數,是浮動層的內容來源。預設 null;由於它優先於 targetAttr,當它為 null 時外掛才會去讀 targetAttr。依 targetMode 不同,target 的型別也會變化。

11. targetAttr

另一個取得內容的途徑。若說 target 是顯式獲取,targetAttr 就是隱式獲取——它從觸發元素自身的標籤屬性取值,預設是 rel(a 標籤的合法屬性,因此很常用)。型別只能是字串,但值的意義與 targetMode 相關:

targetModetargettargetAttr
commonjQuery 物件或元素 id元素 id
ajax圖片或頁面位址圖片或頁面位址
list陣列,或 {href:"", text:""} 格式的物件陣列無效
remind字串,一般文字或含 HTML 片段字串,一般文字或含 HTML 片段
其他(自訂)jQuery 物件、選擇器、字串或 HTML 片段選擇器、元素 id 或文字等字串

12. container

jQuery 物件(需存在於當前頁面),用來裝載浮動層。若 targetMode 為自訂,可傳入 "plugin" 使用外掛內建容器(會顯示三角)。

13. reverseSharp

一種聰明的「顯示與不顯示三角」的開關,含義是把預設規則反轉。預設只有 targetMode 為 "ajax" 與 "remind" 時顯示三角,其餘一律不顯示。若你喜歡這個小三角,想在自訂浮動層上使用,就用 reverseSharp 讓它出現(居中定位外掛已幫你處理好);反之,若 Ajax 時想用自己寫的容器而不要三角,也可以用它把三角關掉。

14. position

看似簡單,實際上最麻煩的一個參數。一開始我試著用 slide-left 這類關鍵字表示位置,但很快發現 trigger 與 target 的組合實在太多,幾個英文字串根本表示不完,實作上也不容易。於是改設計一套用數字表示位置的規則,格式一定是「數字-數字」,中間的 - 用來分隔,前一個數字代表 trigger 的位置,後一個代表 target 的位置,也就是「trigger-target」。

元素各位置對應的數字如下:

四個邊角依 CSS margin/padding 的順序是 1、2、3、4,四邊中心順時針方向是 5、6、7、8。trigger 與 target 都套用同一套規則。因此預設的 "4-1" 就是下圖的位置——trigger 的第 4 位與 target 的第 1 位重合:

每個元素 8 個位置,兩兩組合理論上有 64 種布局,這顯然太多了。因此我另外定了一套簡化規則:區域不重疊、邊框重合、中心對中心。

「區域不重疊」指兩個元素主體在垂直方向上不重疊(不計 offsets),例如下圖的 "1-1" 就不合格:

「邊框重合」要求有邊框線重合,因此 "3-1" 這種不合格:

「中心對中心」指邊框中心點只能對齊邊框中心點,因此下面這種不合格:

因此實際合法的布局只有這 12 種:"4-1"、"1-4"、"5-7"、"2-3"、"2-1"、"6-8"、"3-4"、"4-3"、"8-6"、"1-2"、"7-5"、"3-2"。其他所有寫法都會被重置為預設的 "4-1"。

15. edgeAdjust

布林值。依設定的 position,如果浮動層跑出視窗,是否重新定位,預設 true。重定位的規則頗複雜,但對使用者而言了解它沒有意義,這裡就不展開。要注意的是,當 hoverFollow 為 true 或使用位置關鍵字時,重定位能力會被大幅削弱。

16. showCall

浮動層顯示時的回呼函式。函式內 $(this) 代表目前的 trigger,並可透過參數取得目前的 target。

17. hideCall

浮動層隱藏時的回呼函式,函式內 $(this) 代表目前的 trigger。

七、其他重要說明

1. 三角的顏色

為了與容器的邊框色、背景色一致,三角顏色是外掛自動在容器上尋找相符色彩而得。而且尋找是有方向性的:顯示在上方的小三角只會檢查下邊框顏色,不會誤取上邊框。所以自訂容器時不必擔心顏色對不上,即使四邊邊框顏色都不同也沒關係。若找不到邊框色或背景色,對應的三角就不顯示。

2. class 類名的秘密

① 命名規則:所有與外掛功能相關的 class 都以下劃線連接,並以 float 為前綴,例如 float_ajax_image、float_remind_box。

② 容器命名:若不是 common 類型且 container 為 null,外掛會自動建立一個容器外框,id 格式為 floatBox_ + targetMode,class 格式為 float_ + targetMode + _box。例如 list 類型的容器就是:

<div id="floatBox_list" class="float_list_box"></div>

在 powerFloat.css 中可以看到 float_ajax_box、float_remind_box 等樣式。容器的 class 完全支援自訂,例如把 targetMode 設為 "tip",就能為 float_tip_box 寫自己的樣式:

.float_tip_box {
  line-height: 18px; padding: 0 3px; background-color: #ffffe0;
  -moz-box-shadow: 1px 1px 2px rgba(0, 0, 0, .4);
  -webkit-box-shadow: 1px 1px 2px rgba(0, 0, 0, .4);
  box-shadow: 1px 1px 2px rgba(0, 0, 0, .4);
  border: 1px solid #333; position: absolute;
}

③ 隱藏類名:

類名作用
float_loadingajax 等待內容時的提示框
float_ajax_imageajax 載入的圖片
float_ajax_dataajax 取回資料後的裝載框
float_ajax_errorajax 出錯時的內容框
float_list_ul下拉列表的外框
float_list_li_first下拉列表的第一個 li
float_list_li_last下拉列表的最後一個 li
float_list_a下拉列表中 a 標籤的 class
float_list_null下拉列表無資料時的提示框

3. list 模式下 target 的資料格式

targetMode 為 "list" 時,資料只來自 target,且必須是陣列,否則不會出現任何浮動層。陣列元素可以是字串或物件字面量。

字串的話,內容會被直接放進 li 裡:

target: ["唐麗霞", "徐棟梁", "成霞", "王慶花", "王臘梅", "朱小麗", "束方娟", "吉回秀", "陳陽", "更多 >>"]

物件字面量的屬性名則是固定的:

{ href: "https://www.zhangxinxu.com/", text: "" }

外掛會自動找出文字與連結,組成一組 a 標籤放進 li:

<li><a href="https://www.zhangxinxu.com/" class="float_list_a"></a></li>

4. 開放的 API 方法

與先前的 zxxbox 彈框外掛不同,這裡的方法幾乎都被我私有化了,外部只預留一個:$.powerFloat.hide();,用來隱藏目前顯示的浮動層。

八、更實際的應用案例

1. 淘寶的頂部下拉

淘寶的下拉效果如下:

用 powerFloat 可以更簡潔地實作同樣的效果:

這裡用的是預設的 hover 事件搭配內建的 list 模式。淘寶的做法是透過標籤嵌套(把下拉內容藏在 relative 屬性的標籤下)加上手動位置計算,HTML 與 CSS 的程式碼量都增加了不少。若所有浮動效果一致,自然輕agment得多。

2. QQ 郵箱的自定義下拉

QQ 郵箱的下拉是這樣:

用 powerFloat 實作的效果:

這裡改用 click 事件,以 common 模式裝載元素內容(也可以改用 list 模式)。沒有加上下拉與收起的動畫,一方面個人對這類動畫沒什麼好感,覺得有點囉嗦;另一方面位置會上下計算重定位,若列表在頁面較上方顯示,配上下拉動畫反而奇怪,所以我省掉了。

3. 人人網好友搜尋框的半透明提示

人人網原本的效果:

呼叫程式碼非常短:

$("#navSearchInput").powerFloat({
    eventType: "focus",
    targetMode: "search",
    target: "多個關鍵字用空格隔開<br />(例:汪洋 北京大學)"
});

最後的效果:

這裡用的是 focus 事件搭配自訂的浮動模式("search")。

九、結語

這個外掛從著手到即將發布大約花了十天,期間手頭上還有不少工作,所以最近特別忙。

對它做個簡單評價吧:當初構想時很興奮,覺得什麼浮動層都能一個外掛搞定;但真正做完之後,反而沒了那份興奮。因為外掛功能雖然強大了,規則卻也變得複雜、學習成本提高,同時外掛本身被限制的地方也變多了——例如為了兼顧各種布局,就不能隨便加上下拉動畫。事物本來就有兩面,有利必有弊。

程式碼品質上仍有改進空間,例如對 this 的保護處理。就學習而言收穫不小:對物件字面量中 this 的使用有了更進一步的認識,對 jQuery 的 data 屬性(結合 HTML5 的 data-)也更感分了。

這兩天反覆測試修掉了不少 bug,但畢竟是一個人、時間精力有限,也不是專業測試工程師,加上 JS 功力還很稚嫩,外掛肯定還有問題。若你試用後發現 bug 或有改進建議,非常歡迎提出。

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