AngularJS 指令實踐指南(一)
指令(Directives)是所有AngularJS應用最重要的部分。儘管AngularJS已經提供了非常豐富的指令,但還是經常需要建立應用特定的指令。這篇教程會為你講述如何自定義指令,以及介紹如何在實際專案中使用。在這篇文章的最後(第二部分),我會指導你如何使用Angular指令來建立一個簡單的記事本應用。
概述
一個指令用來引入新的HTML語法。指令是DOM元素上的標記,使元素擁有特定的行為。舉例來說,靜態的HTML不知道如何來建立和展現一個日期選擇器控制元件。讓HTML能識別這個語法,我們需要使用指令。指令通過某種方法來建立一個能夠支援日期選擇的元素。我們會循序漸進地介紹這是如何實現的。 如果你寫過AngularJS的應用,那麼你一定已經使用過指令,不管你有沒有意識到。你肯定已經用過簡單的指令,比如 ng-mode, ng-repeat, ng-show等。這些指令都賦予DOM元素特定的行為。例如,ng-repeat 重複特定的元素,ng-show 有條件地顯示一個元素。如果你想讓一個元素支援拖拽,你也需要建立一個指令來實現它。指令背後基本的想法很簡單。它通過對元素繫結事件監聽或者改變DOM而使HTML擁有真實的互動性。
jQuery視角
想象一下使用jQuery如何建立一個日期選擇器。首先,我們在HTML中新增一個普通的輸入框,然後通過jQuery呼叫 $(element).dataPicker() 來將它轉變成一個日期選擇器。但是,仔細想一下。當一個設計人員過來檢查HTML標記的時候,他/她能否立刻猜到這個欄位實際上表示的內容?這只是一個簡單的輸入框,或者一個日期選擇器?你需要檢視jQuery程式碼來確定這些。而Angular的方法是使用一個指令來擴充套件HTML。所以,一個日期選擇器的指令可以是下面的形式:
XHTML1 | <input type |
或者是這樣:
XHTML1 | <input type="text" /> |
這種建立UI組建的方式更加直接和清晰。你可以輕易地通過檢視元素就明白這到底是什麼。
建立自定義指令:
一個Angular指令可以有以下的四種表現形式: 1. 一個新的HTML元素(<data-picker></data-picker>) 2. 元素的屬性(<input type=”text” data-picker/>) 3. CSS class(<input type=”text” class=”data-picker”/>) 4. 註釋(<!–directive:data-picker –>) 當然,我們可以控制我們的指令在HTML中的表現形式。下面我們來看一下AngularJS中的一個典型的指令的寫法。指令註冊的方式與 controller 一樣,但是它返回的是一個擁有指令配置屬性的簡單物件(指令定義物件) 。下面的程式碼是一個簡單的 Hello World 指令。
123456789 | varapp=angular.module('myapp',[]);app.directive('helloWorld',function(){return{restrict:'AE',replace:'true',template:'<h3>Hello World!!</h3>'};}); |
在上面的程式碼中,app.directive()方法在模組中註冊了一個新的指令。這個方法的第一個引數是這個指令的名字。第二個引數是一個返回指令定義物件的函式。如果你的指令依賴於其他的物件或者服務,比如 $rootScope, $http, 或者$compile,他們可以在這個時間被注入。這個指令在HTML中以一個元素使用,如下:
1 2 3 | <hello-world/> //OR <hello:world/> |
或者,以一個屬性的方式使用:
XHTML123 | <div hello-world></div>//OR<div hello:world/> |
如果你想要符合HTML5的規範,你可以在元素前面新增 x- 或者 data-的字首。所以下面的標記也會匹配 helloWorld 指令:
1 2 3 | <div data-hello-world></div> //OR <divx-hello-world></div> |
注意: 在匹配指令的時候,Angular會在元素或者屬性的名字中剔除 x- 或者 data- 字首。 然後將 – 或者 : 連線的字串轉換成駝峰(camelCase)表現形式,然後再與註冊過的指令進行匹配。這是為什麼,我們在HTML中以 hello-world 的方式使用 helloWorld 指令。其實,這跟HTML對標籤和屬性不區分大小寫有關。 儘管上面的指令僅僅實現了靜態文字的顯示,但是這裡還是有一些有趣的點值得我們去挖掘。我們在指令定義過程中使用了三個屬性來配置指令。我們來一一介紹他們的作用。
- restrict – 這個屬性用來指定指令在HTML中如何使用(還記得之前說的,指令的四種表示方式嗎)。在上面的例子中,我們使用了 ‘AE’。所以這個指令可以被當作新的HTML元素或者屬性來使用。如果要允許指令被當作class來使用,我們將 restrict 設定成 ‘AEC’。
- template – 這個屬性規定了指令被Angular編譯和連結(link)後生成的HTML標記。這個屬性值不一定要是簡單的字串。template 可以非常複雜,而且經常包含其他的指令,以及表示式({{ }})等。更多的情況下你可能會見到 templateUrl, 而不是 template。所以,理想情況下,你應該將模板放到一個特定的HTML檔案中,然後將 templateUrl 屬性指向它。
- replace – 這個屬性指明生成的HTML內容是否會替換掉定義此指令的HTML元素。在我們的例子中,我們用 <hello-world></hello-world>的方式使用我們的指令,並且將 replace 設定成 true。所以,在指令被編譯之後,生成的模板內容替換掉了 <hello-world></hello-world>。最終的輸出是 <h3>Hello World!!</h3>。如果你將 replace 設定成 false,也就是預設值,那麼生成的模板會被插入到定義指令的元素中。
開啟這個 plunker,在”Hello World!!”右鍵檢查元素內容,來更形象地明白這些。
Link函式和Scope
指令生成出的模板其實沒有太多意義,除非它在特定的scope下編譯。預設情況下,指令並不會建立新的子scope。更多的,它使用父scope。也就是說,如果指令存在於一個controller下,它就會使用這個controller的scope。 如何運用scope,我們要用到一個叫做 link 的函式。它由指令定義物件中的link屬性配置。讓我們來改變一下我們的 helloWorld 指令,當用戶在一個輸入框中輸入一種顏色的名稱時,Hello World 文字的背景色自動發生變化。同時,當用戶在 Hello World 文字上點選時,背景色變回白色。 相應的HTML標記如下:
XHTML