UI Layout 是一款基於 jQuery 的布局框架,專案主頁為 https://layout.jquery-dev.net/。它的參考原型是 ExtJS 的 border-layout,因此特別適合把原本使用 ExtJS 的專案改造成 jQuery 專案。
其核心是一個大小自適應的中心面板(必選),面板的上下左右四個方向可放置可折疊、可缩放的面板(可選),各面板還能添加任意數量的頁眉與頁腳面板。UI Layout 支援內層布局的嵌套,任何塊元素都能當作布局容器,最基礎的容器就是 body。
取得容器元素並呼叫 layout 方法,可傳入配置參數 options(可選)。通常會保留布局的引用,以便後續用程式碼控制布局形態:
var myLayout = $('body').layout();
// 讀取布局配置選項
var is_west_resizable = myLayout.options.west.resizable;
var north_maxHeight = myLayout.options.north.maxSize;
// 呼叫布局函式
myLayout.toggle("north");
myLayout.sizePane("west", 300);
// 呼叫布局工具
myLayout.addPinBtn("#myPinButton", "west");
myLayout.allowOverflow("north");
所有面板都基於現有的 HTML 元素,而面板的附属元件(缩放器與折疊開關)則是自動生成的 div,並加上對應的 class。幾乎所有面板元素都必須是容器元素的直接子元素,唯一的例外是 form 容器。我們可以為元素賦予默認類名或自訂類名、id 來指定布局面板:
$(document).ready(function() {
$("body").layout({
west__paneSelector: "#west", // 東西方板需指定 id
east__paneSelector: "#east",
north__paneSelector: ".ui-layout-north",// 北方板默認類名,可省略
south__paneSelector: ".myclass-south",
center__paneSelector: ".ui-layout-center"// 中心板默認類名,可省略
});
});
對應的頁面結構:
<body> <!-- north 與 south 是 body 的直接子元素 --> <div class="ui-layout-north">north</div> <div class="myclass-south">south</div> <!-- center 嵌套在 form 中 --> <form> <div class="ui-layout-center">center</div> </form> <!-- east 與 west 嵌套在一個 div 中 --> <div> <div id="west">west</div> <div id="east">east</div> </div> </body>
本例中,布局容器是 body,南、北方板是容器直接子元素:南板用自訂類名 myclass-south,需在 south__paneSelector 中指定;北板用默認類名 ui-layout-north。東、西方板不是直接子元素,必須指定 id(不能用類選擇器),並在對應參數中指明。中心板嵌套在 form 中,可用默認或自訂類名識別。
面板之間的空隙構成了面板的「邊」。由於可以拖動這些邊來缩放對應面板,因此稱之為「缩放器」;缩放器上通常附一個折疊開關,負責面板的折疊與打開。當兩個面板之間沒有空隙時,缩放器與折疊開關會隨之消失。此外,面板在打開與折疊狀態下,缩放器的寬度可以分別指定為不同值。
效果圖如下: