Zero Clipboard 是一個跨瀏覽器的複製解決方案。它利用 Flash 完成複製,因此只要瀏覽器裝有 Flash Player 就能運作,比 IE 的 document.execCommand("Copy") 靈活得多,也不受 execCommand 只能複製「當前選取內容」的限制。
早期的 Clipboard Copy 方案同樣使用 Flash,做法是放一個隱藏的 Flash 影片,由 JavaScript 呼叫它。但 Flash Player 10 收緊了權限:只有在使用者直接對 Flash 物件進行操作時,才允許啟動剪貼簿。
Zero Clipboard 的改進很巧妙:把 Flash 做成透明的,並以絕對定位漂浮在按鈕的正上方。使用者以為自己點的是 HTML 按鈕,實際上點擊事件落在 Flash 上,因此滿足了「直接操作」的要求,複製得以執行。
理解這個原理很重要,因為它解釋了後續所有 API 設計的由來:為什麼需要 reposition()(Flash 位置會因版面變動而錯位)、為什麼 :hover 會失效(滑鼠實際上在 Flash 上而非按鈕上)、為什麼 setText 要搭配 mouseOver 事件使用。
下載並解壓縮後,需要兩個檔案:ZeroClipboard.js 與 ZeroClipboard.swf,放入專案中。
第一步,引入 JavaScript:
<script type="text/javascript" src="ZeroClipboard.js"></script>
第二步,設定 swf 的路徑:
ZeroClipboard.setMoviePath("ZeroClipboard.swf");
以上兩個路徑都需替換為專案中的實際位置,也可以使用絕對路徑。
第三步,建立物件並綁定按鈕:
var clip = new ZeroClipboard.Client(); // 新建物件
clip.setHandCursor(true); // 滑鼠游標設為手型
clip.setText("哈哈"); // 設定要複製的文字
// 註冊一個 button,參數為 id。點擊這個元素就會複製。
// 這個元素不一定是 input 按鈕,也可以是其他 DOM 元素。
clip.glue("copy-botton"); // 與上一句位置不可調換
glue 必須在 setText 之後呼叫,因為 glue 會把透明 Flash 定位到該元素上;順序顛倒會導致定位失敗。至此基本功能完成,點擊按鈕即可複製預設文字。
因為按鈕上漂浮著一個 Flash 物件,當頁面尺寸改變、版面重排時,Flash 可能與按鈕錯開,導致點擊落空。reposition() 會重新計算位置,建議綁在 resize 事件上:
bind(window, "resize", function () {
clip.reposition();
});
bind 是一個跨瀏覽器的事件綁定函式。此外,任何會造成版面變動的操作(展開摺疊、動態插入內容、卷軸出現)都可能需要重新呼叫它。
分別用來隱藏與顯示 Flash 按鈕。show() 內部會呼叫 reposition(),因此顯示後位置自動正確。
由於 Flash 遮住了按鈕,滑鼠實際上不在按鈕上,因此 :hover、:active 等偽類不會被觸發。setCSSEffects() 用來解決這個問題,做法是先把偽類改成類別:
#copy-botton:hover {
border-color: #FF6633;
}
/* 改成 */
#copy-botton.hover {
border-color: #FF6633;
}
然後呼叫 clip.setCSSEffects(true);,Zero Clipboard 會監聽 Flash 的滑鼠事件,並自動為元素加上或移除 .hover 類別,模擬出偽類的效果。
若你想自己實例化 Flash,不使用 Zero Clipboard 的附著機制,這個方法可以幫上忙。它接受寬與高兩個參數,回傳對應的 HTML:
var html = clip.getHTML(150, 20);
可用 innerHTML 或直接 document.write() 輸出。實際輸出的內容大致如下:
<embed id="ZeroClipboardMovie_1" src="zeroclipboard/ZeroClipboard.swf" loop="false" menu="false" quality="best" bgcolor="#ffffff" width="150" height="20" name="ZeroClipboardMovie_1" align="middle" allowScriptAccess="always" allowFullScreen="false" type="application/x-shockwave-flash" pluginspage="https://www.macromedia.com/go/getflashplayer" flashvars="id=1&width=150&height=20" wmode="transparent" />
注意 wmode="transparent" 與 allowScriptAccess="always" 這兩個屬性:前者讓 Flash 背景透明,後者允許 JavaScript 與 Flash 雙向溝通,兩者都是這個方案能運作的關鍵。
IE 的 Flash JavaScript 通信介面有一個 bug:你必須把 object 標籤插入一個已存在於 DOM 中的元素裡。因此在寫入 innerHTML 之前,請確保該元素已用 appendChild 插入文件,否則通信會失敗。
Zero Clipboard 提供事件機制,用 addEventListener() 註冊。例如 Flash 完全載入後會觸發 load 事件:
clip.addEventListener("load", function (client) {
alert("Flash 加載完畢!");
});
Zero Clipboard 會把 clip 物件本身作為參數傳入,即上例中的 client。load 也可以寫成 onLoad,其他事件同樣有這種別名寫法。
其他可用事件包括:
其中 mouseOver 與 complete 最常用。
前面提到待複製的文字是固定的。若要改成複製某個輸入框的當前值,就在滑鼠移上時重新設定:
clip.addEventListener("mouseOver", function (client) {
var test = document.getElementById("test");
client.setText(test.value); // 重新設定要複製的值
});
這也是為什麼 mouseOver 事件如此重要——它是「使用者即將點擊」的最後時機,可以在此時把最新的資料寫進 Flash。
clip.addEventListener("complete", function () {
alert("複製成功!");
});
実務上與其用 alert 打斷使用者,不如做一個兩秒後自動消失的小提示,體驗更好。
Flash 已於 2020 年底正式停止支援,Zero Clipboard 這套方案也隨之失效。但它的設計思路仍值得理解,因為「透明元素覆蓋在真實控制項上以借用其能力」這個手法,在今天依然存在——例如自訂檔案上傳按鈕,就是把 <input type="file"> 設為透明並鋪滿整個區域。
現代複製功能的標準做法是 Clipboard API:
await navigator.clipboard.writeText("要複製的文字");
// 讀取則是
var text = await navigator.clipboard.readText();
它不需要任何外掛、不必處理定位、天然跨瀏覽器,且以 Promise 為基礎,錯誤處理清楚。限制是必須在安全上下文(HTTPS 或 localhost)中、需要使用者授權,且讀取權限通常比寫入嚴格。整體而言,這些限制換來的是真正的安全性,遠勝過去靠 Flash 繞路的做法。