本文以 Ext JS 4.2.1 為基礎。ExtJS 4 對框架做了大幅重構,最重要的成果之一是形成了一套結構與層次分明的組件體系,而主題系統正是建立在這套體系之上。
學 ExtJS 本質上就是學組件的使用。ExtJs4 將近 100 種組件大致可分四大類:容器類、工具列及選單欄、表單及元素、其他組件。
ExtJs4 引入了全新的主題系統,採用 Sass 與 Compass 技術,提供標準主題模板,只要對模板做簡單定製,就能產生出豐富多變的外觀。
Sass 是 CSS 的擴充語言,為它帶來變數、內嵌規則、混入(mixins)、選擇器繼承等能力。Sass 3 起 100% 相容 CSS3,語法檔升級為 SCSS,任何有效的 CSS3 檔同時也是有效的 SCSS 檔,學習成本因此大幅降低。Sass 讓我們能定義變數並在不同樣式中引用甚至計算,也能定義可重複使用的 mixins,這些都是原生 CSS 做不到的;編譯後仍會輸出標準 CSS 供各瀏覽器使用。
Sass 的主要特性:混入(class 中的 class)、可傳參數的參數混入(像函數一樣)、嵌套規則(減少重複程式碼)、運算(在 CSS 中做數學)、顏色功能、命名空間、作用域(局部覆寫樣式),以及 JavaScript 賦值。詳情見 https://sass-lang.com/。
Compass 是一套基於 Ruby 的開源 CSS 創作框架,使用 Sass 語法,並內建大量可重用的優秀模式。用一個等式概括:Compass = Sass 樣式表語言 + 大量可重用的優秀 CSS 模式。詳情見 https://compass-style.org/。
安裝 Ruby。使用 Sass 與 Compass 需要 Ruby,可至 https://rubyinstaller.org/ 下載。這裡有個實務上的坑:不要裝 Ruby 2.0.0-p195,後續開發會因版本問題出錯,Ruby 1.9.3-p429 即可。安裝時把三個選項都勾上。
安裝完成後,從開始選單的 Ruby 程式組點「Start Command Prompt with Ruby」進入命令列,輸入 ruby -v 確認版本,能正常顯示即代表環境就緒。
安裝 Compass 與 Sass。同樣開啟 Ruby 命令列,執行:
gem install compass
該命令會遠端安裝 Compass 及相關文件,因走網路所以耗時較長,耐心等待即可。看到安裝訊息出現即代表成功,範例環境裝到的是 sass-3.2.9 與 compass-0.12.2。可用 compass -v 與 sass -v 分別查詢版本。
1. 初始化。以 myproject 為例:
compass create myproject cd myproject
該目錄下會有一個 config.rb 設定檔,以及 sass 與 stylesheets 兩個子目錄,前者放 Sass 原始檔,後者放編譯後的 css。
2. 編譯。我們寫的是 .scss 檔,必須編譯成 css 才能使用:
compass compile # 基本編譯 compass compile --output-style compressed # 輸出壓縮版 compass compile --force # 強制重編未變動的檔案
預設輸出的 css 帶有大量註解,正式環境需要壓縮版,因此加上 --output-style 參數。也可在 config.rb 中指定:
output_style = :expanded
可選值有四種::nested(嵌套縮排,預設)、:expanded(無縮排的展開格式)、:compact(簡潔格式)、:compressed(壓縮)。進入正式階段後改為 :compressed:
output_style = :compressed
也可以透過 environment 智慧判斷:
environment = :development output_style = (environment == :production) ? :compressed : :expanded
除了一次性編譯,還有自動編譯模式:
compass watch
執行後只要 scss 檔變動就會自動編譯。
用「編輯器寫 Sass → Ruby 編譯 → 複製到 Eclipse 專案」的流程相當繁瑣。要在 Eclipse 中直接編輯並自動編譯,可以這樣設定:
1. 確認 ant 已安裝;
2. 開啟專案的「properties」,選擇「Builders」,點「New…」;
3. 選擇「Ant Builder」,按「OK」;
4. 輸入名稱「compass.compile」,在「Main」頁籤點「Browse Workspace」選取專案中的 build.xml;
5. 在「Targets」頁籤的 Auto-Build 中點「Set Targets」,選擇「compass.compile」(「sass.compile」只用 Sass),按「OK」;
6. 在「Build Options」頁籤點「Select Resources」,選擇 Sass 檔目錄,按「Finish」再按「OK」。
設定完成後,編輯 Sass 檔存檔,css 就會自動產生或更新。
Sencha Cmd 是打包與部署 ExtJs 及 Sencha Touch 應用的命令列工具。開發 ExtJs 4.2 主題需要 3.1 以上版本。
1. 安裝 Java Runtime Environment(JRE),版本需 6.0 以上;
2. 安裝 Ruby(同樣建議 1.9.3-p429,避免版本衝突);
3. 下載並安裝 Sencha Cmd;
4. 下載並解壓 Ext JS SDK。
注意:目錄名稱不要用中文或特殊符號,否則容易出錯。開啟系統 cmd,定位到 SDK 解壓目錄,執行:
sencha -sdk d:/ExtJs4-App/ext-4.2.1.883 generate workspace my-workspace cd my-workspace
這個命令會把 Ext JS SDK 與 package 關聯到工作區,讓主題與應用程式能找到所需依賴。切換到 my-workspace 後,應該能看到兩個資料夾:ext(含 Ext JS SDK)與 packages(含語言環境與主題包)。
測試主題最好的方式就是在一個實際應用裡跑它:
sencha -sdk ext generate app ThemeDemoApp theme-demo-app cd theme-demo-app sencha app build
兩種執行模式:開發模式開啟 theme-demo-app/index.html,未壓縮資源、便於除錯;產品模式開啟 build/ThemeDemoApp/production/index.html,資源已壓縮,記憶體佔用更小、效能更好。
sencha generate theme my-custom-theme
結構重點:
package.json——包屬性檔,記錄 name、version 與 dependencies。
sass/——主題的 Sass 檔,分三部分:sass/var/ 放變數;sass/src/ 放樣式規則與 UI mixin 呼叫,可使用 var 下的變數;sass/etc/ 放共用功能或 mixins。檔案路徑應對應組件類路徑,例如 Ext.panel.Panel 的變數放在 sass/var/panel/Panel.scss。
resources/——主題需要的圖片與其他靜態資源。
overrides/——用 JavaScript 覆寫 Ext JS 組件類。
主題包可以繼承其他主題包,Ext Js 4.2 正是靠這個特性建立主題層級:
ext-theme-base——所有主題的基礎,唯一沒有父主題的包,只包含讓組件與版面正常運作的最少 CSS 規則,其樣式規則不可設定,應避免覆寫。
ext-theme-neutral——從 base 擴展,包含絕大多數可設定的樣式規則,大多數變數都在這裡定義。
ext-theme-classic——預設主題,從 neutral 擴展。
ext-theme-gray——從 classic 擴展。
ext-theme-access——從 classic 擴展。
ext-theme-neptune——從 neutral 擴展。
建議以 ext-theme-neptune 或 ext-theme-classic 作為自定義主題的起點,因為它們包含了一切必要程式碼,改幾個變數就能在幾分鐘內跑起來。而 ext-theme-neutral 太過抽象,直接基於它擴展需要覆寫數以百計的變數,工作量龐大,通常只有高手才做此選擇。
要改用 neptune 作為基底,編輯 packages/my-custom-theme/package.json:
"extend": "ext-theme-classic" → "extend": "ext-theme-neptune"
接著在 theme-demo-app 目錄執行 sencha app refresh,確保正確的主題 JavaScript 檔被納入 bootstrap.js,讓開發模式能正常運行。
在 my-custom-theme/sass/var/ 下建立 Component.scss:
$base-color: #317040 !default;
若想讓主題可被延伸,務必在每個變數末尾加上 !default。少了它,你就無法覆寫派生主題的變數,因為 Sencha Cmd 的變數遵循「反向」規則——派生樣式在前,基礎樣式在後。完整的 Ext JS 全域 SASS 變數清單可參考 Global_CSS。
cd packages/my-custom-theme sencha package build
會在 package 下產生 build 目錄,其中 my-custom-theme/build/resources/my-custom-theme-all.css 包含所有 Ext JS 組件的樣式規則。你可以直接在應用裡使用它,但並不建議——「all」檔含全部樣式,而大多數應用只用到組件的子集。建置應用時 Sencha Cmd 能過濾掉未使用的規則,前提是先把測試程式設定成使用自定義主題。
編輯 theme-demo-app/.sencha/app/sencha.cfg:
app.theme=ext-theme-classic → app.theme=my-custom-theme
若先前已用經典主題建置過,先清理再重建:
sencha ant clean sencha app build
開啟 theme-demo-app/index.html 即可看到效果。
每個 Ext JS 組件都有一份全域變數清單可用來調整外觀。例如改面板標題的字型,建立 packages/my-custom-theme/sass/var/panel/Panel.scss:
$panel-header-font-family: Times New Roman !default;
在 theme-demo-app 下執行 sencha app build 後即可看到字型變化。各組件的 SASS 變數清單可在 API 文件的「CSS Variables」章節查得。
ExtJs 中每個組件都有一個 ui 設定(預設為 default),可以在單一實例上指定,讓同類組件呈現不同外觀。建立 packages/my-custom-theme/sass/src/panel/Panel.scss:
@include extjs-panel-ui(
$ui-label: 'highlight-framed',
$ui-header-background-color: red,
$ui-border-color: red,
$ui-header-border-color: red,
$ui-body-border-color: red,
$ui-border-width: 5px,
$ui-border-radius: 5px
);
接著修改 theme-demo-app/app/view/Viewport.js:
Ext.define('ThemeDemoApp.view.Viewport', {
extend: 'Ext.container.Viewport',
requires: [
'Ext.layout.container.Border',
'ThemeDemoApp.view.Main'
],
layout: {
type: 'border'
},
items: [{
// 預設 UI
region: 'west',
xtype: 'panel',
title: 'West',
split: true,
width: 150
}, {
// 自定義的 highlight UI
region: 'center',
xtype: 'panel',
layout: 'fit',
bodyPadding: 20,
items: [
{
xtype: 'panel',
ui: 'highlight',
frame: true,
bodyPadding: 10,
title: 'Highlight Panel'
}
]
}, {
// neptune 的 light UI
region: 'east',
xtype: 'panel',
ui: 'light',
title: 'East',
split: true,
width: 150
}]
});
在 theme-demo-app 下執行 sencha app build,開啟 index.html 即可看到三種不同外觀的面板。
UI 雖然方便,但不應過度使用:每次呼叫 UI mixin 都會產生額外的 CSS 規則,濫用會讓樣式檔膨脹。
另外,呼叫 UI mixin 時應使用具名參數而非無參數值的有序列表:
// 建議
@include extjs-component-ui(
$ui-foo: foo,
$ui-bar: bar
);
// 避免
@include extjs-component-ui(foo, bar);
因為 mixin 參數的數量與順序可能隨版本增刪,位置式呼叫一旦遇到參數變動就會失效。
所需圖片預設繼承父主題,但必要時可覆寫。把同名圖片放到 my-custom-theme/resources/images/ 對應路徑即可,例如覆寫彈出視窗的資訊圖示:
packages/my-custom-theme/resources/images/shared/icon-info.png
在 highlight panel 中加入按鈕來驗證:
requires: [
...
'Ext.window.MessageBox',
...
],
title: 'Highlight Panel',
items: [{
xtype: 'button',
text: 'Show Message',
handler: function () {
Ext.Msg.show({
title: 'Info',
msg: 'Message Box with custom icon',
buttons: Ext.MessageBox.OK,
icon: Ext.MessageBox.INFO
});
}
}]
建立新的 UI 時常會用到背景漸層或圓角,但并非所有瀏覽器都支援 CSS3,此時必須用圖片彌補。Sencha Cmd 能自動切片,前提是要告訴它哪些組件需要。相關設定檔都在各主題的 sass/example/ 目錄下,可參考 packages/ext-theme-base/sass/example/:
shortcuts.js——可切割的組件類型基本設定。多數自定義主題不需要另建此檔,除非包含自定義組件樣式;若要新增快捷定義,需呼叫 Ext.theme.addShortcuts()。
manifest.js——能產生切片圖像的組件 UI 清單。可繼承父主題的所有條目,也可呼叫 Ext.theme.addManifest() 加入自己的。
theme.html——用來渲染 manifest.js 中定義的內容。
為 highlight panel 建立圓角切片,新增 packages/my-custom-theme/sass/example/manifest.js:
Ext.theme.addManifest({
xtype: 'panel',
ui: 'highlight'
});
編輯 packages/my-custom-theme/sass/example/theme.html,加入 script 標籤:
<!-- Sencha Cmd 目前不會自動帶入父主題的 manifest.js,因此需手動引用 --> <script src="../../../ext-theme-neptune/sass/example/manifest.js"></script> <!-- 你的主題自己的 manifest.js --> <script src="manifest.js"></script>
為了在建置應用時能進行切片,還要在 theme-demo-app/sass/example/theme.html 加入兩個 script 標記:
<script type="text/javascript"
src="../../../packages/ext-theme-neptune/sass/example/manifest.js"></script>
<script type="text/javascript"
src="../../../packages/my-custom-theme/sass/example/manifest.js"></script>
建置後在 IE8 及以下版本瀏覽,highlight panel 會呈現圓角,與 IE9 及其他瀏覽器的 CSS3 效果一致。
有些外觀調整需要靠 JavaScript 改變組件設定,這可以透過覆寫主題包的 JS 達成。建立 packages/my-custom-theme/overrides/panel/Panel.js:
Ext.define('MyCustomTheme.panel.Panel', {
override: 'Ext.panel.Panel',
titleAlign: 'center'
});
接著重新建置主題包,讓 packages/my-custom-theme/build/my-custom-theme.js 納入這個覆寫檔:
cd packages/my-custom-theme sencha package build cd ../../theme-demo-app sencha app refresh sencha app build
完成後開啟 index.html,即可看到面板標題已置中。
整套流程的順序值得記牢:裝 Ruby → 裝 Compass/Sass → 裝 Sencha Cmd → 建工作空間 → 建測試應用 → 產主題包 → 設定繼承 → 改全域變數 → 改組件變數 → 定義自定義 UI → 覆寫圖片 → 處理舊 IE 切片 → 覆寫 JS → 每次改動後 refresh 與 build。