diff options
| author | Luc Morin | 2013-04-08 20:50:32 -0300 |
|---|---|---|
| committer | Igor Minar | 2013-04-11 14:02:06 -0700 |
| commit | 484286d5364401ecb9150704891d86cbdca5c717 (patch) | |
| tree | e59ab7a2f9f1e04c269398678c22971b9be8b597 | |
| parent | d56b62dcda4b0c403d28b7dbd5c1844a85d20e03 (diff) | |
| download | angular.js-484286d5364401ecb9150704891d86cbdca5c717.tar.bz2 | |
docs(guide/directives): give more details about directive declaration
| -rw-r--r-- | docs/content/guide/directive.ngdoc | 22 |
1 files changed, 14 insertions, 8 deletions
diff --git a/docs/content/guide/directive.ngdoc b/docs/content/guide/directive.ngdoc index 7e17f6c9..b44a90ca 100644 --- a/docs/content/guide/directive.ngdoc +++ b/docs/content/guide/directive.ngdoc @@ -225,7 +225,12 @@ In this example we will build a directive that displays the current time. # Writing directives (long version) -An example skeleton of the directive is shown here, for the complete list see below. +There are different ways to declare a directive. The difference resides in the return +value of the factory function. You can either return a Directive Definition Object +(see below) that defines the directive properties, or just the postLink function +of such an object (all other properties will have the default values). + +Here's an example directive declared with a Directive Definition Object: <pre> var myModule = angular.module(...); @@ -251,12 +256,11 @@ An example skeleton of the directive is shown here, for the complete list see be }); </pre> -In most cases you will not need such fine control and so the above can be simplified. All of the -different parts of this skeleton are explained in following sections. In this section we are -interested only in some of this skeleton. +In most cases you will not need such fine control and so the above can be simplified. You can still +return a Directive Definition Object, but only setting the 'compile' function property of the Object, +and rely on the default values for other properties. -The first step in simplyfing the code is to rely on the default values. Therefore the above can be -simplified as: +Therefore the above can be simplified as: <pre> var myModule = angular.module(...); @@ -271,8 +275,10 @@ simplified as: }); </pre> -Most directives concern themselves only with instances, not with template transformations, allowing -further simplification: +Finally, most directives concern themselves only with instances, not with template transformations, allowing +further simplification. + +Here we only define the postLink function: <pre> var myModule = angular.module(...); |
