UNPKG

knowhow-server

Version:

A personal workflow engine that can manage and use any network connected host

195 lines (180 loc) 9.95 kB
<a href="http://github.com/angular/angular.js/tree/v1.2.9/src/ng/directive/ngController.js#L3" class="view-source btn btn-action"><i class="icon-zoom-in"> </i> View source</a><a href="http://github.com/angular/angular.js/edit/master/src/ng/directive/ngController.js" class="improve-docs btn btn-primary"><i class="icon-edit"> </i> Improve this doc</a><h1><code ng:non-bindable="">ngController</code> <div><span class="hint">directive in module <code ng:non-bindable="">ng</code> </span> </div> </h1> <div><h2 id="description">Description</h2> <div class="description"><div class="ng-directive-page ng-directive-ngcontroller-page"><p>The <code>ngController</code> directive attaches a controller class to the view. This is a key aspect of how angular supports the principles behind the Model-View-Controller design pattern.</p> <p>MVC components in angular:</p> <ul> <li>Model — The Model is scope properties; scopes are attached to the DOM where scope properties are accessed through bindings.</li> <li>View — The template (HTML with data bindings) that is rendered into the View.</li> <li>Controller — The <code>ngController</code> directive specifies a Controller class; the class contains business logic behind the application to decorate the scope with functions and values</li> </ul> <p>Note that you can also attach controllers to the DOM by declaring it in a route definition via the <a href="api/ngRoute.$route">$route</a> service. A common mistake is to declare the controller again using <code>ng-controller</code> in the template itself. This will cause the controller to be attached and executed twice.</p> </div></div> <h2 id="usage">Usage</h2> <div class="usage">as attribute<pre class="prettyprint linenums">&lt;ANY ng-controller="{expression}"&gt; ... &lt;/ANY&gt;</pre> <h3 id="usage_directive-info">Directive info</h3> <div class="directive-info"><ul><li>This directive creates new scope.</li> </ul> </div> <h4 id="usage_directive-info_parameters">Parameters</h4><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>ngController</td><td><a href="" class="label type-hint type-hint-expression">expression</a></td><td><div class="ng-directive-page ng-directive-ngcontroller-page"><p>Name of a globally accessible constructor function or an <a href="guide/expression">expression</a> that on the current scope evaluates to a constructor function. The controller instance can be published into a scope property by specifying <code>as propertyName</code>.</p> </div></td></tr></tbody></table></div> <h2 id="example">Example</h2> <div class="example"><div class="ng-directive-page ng-directive-ngcontroller-page"><p>Here is a simple form for editing user contact information. Adding, removing, clearing, and greeting are methods declared on the controller (see source tab). These methods can easily be called from the angular markup. Notice that the scope becomes the <code>this</code> for the controller&#39;s instance. This allows for easy access to the view data from the controller. Also notice that any changes to the data are automatically reflected in the View without the need for a manual update. The example is shown in two different declaration styles you may use according to preference. <h4 id="example_source">Source</h4> <div source-edit="" source-edit-deps="angular.js script.js" source-edit-html="index.html-76" source-edit-css="" source-edit-js="script.js-75" source-edit-json="" source-edit-unit="" source-edit-scenario="scenario.js-77" source-edit-protractor=""></div> <div class="tabbable"><div class="tab-pane" title="index.html"> <pre class="prettyprint linenums" ng-set-text="index.html-76" ng-html-wrap=" angular.js script.js"></pre> <script type="text/ng-template" id="index.html-76"> <div id="ctrl-as-exmpl" ng-controller="SettingsController1 as settings"> Name: <input type="text" ng-model="settings.name"/> [ <a href="" ng-click="settings.greet()">greet</a> ]<br/> Contact: <ul> <li ng-repeat="contact in settings.contacts"> <select ng-model="contact.type"> <option>phone</option> <option>email</option> </select> <input type="text" ng-model="contact.value"/> [ <a href="" ng-click="settings.clearContact(contact)">clear</a> | <a href="" ng-click="settings.removeContact(contact)">X</a> ] </li> <li>[ <a href="" ng-click="settings.addContact()">add</a> ]</li> </ul> </div> </script> </div> <div class="tab-pane" title="script.js"> <pre class="prettyprint linenums" ng-set-text="script.js-75"></pre> <script type="text/ng-template" id="script.js-75"> function SettingsController1() { this.name = "John Smith"; this.contacts = [ {type: 'phone', value: '408 555 1212'}, {type: 'email', value: 'john.smith@example.org'} ]; }; SettingsController1.prototype.greet = function() { alert(this.name); }; SettingsController1.prototype.addContact = function() { this.contacts.push({type: 'email', value: 'yourname@example.org'}); }; SettingsController1.prototype.removeContact = function(contactToRemove) { var index = this.contacts.indexOf(contactToRemove); this.contacts.splice(index, 1); }; SettingsController1.prototype.clearContact = function(contact) { contact.type = 'phone'; contact.value = ''; }; </script> </div> <div class="tab-pane" title="ngScenario e2e test"> <pre class="prettyprint linenums" ng-set-text="scenario.js-77"></pre> <script type="text/ng-template" id="scenario.js-77"> it('should check controller as', function() { expect(element('#ctrl-as-exmpl>:input').val()).toBe('John Smith'); expect(element('#ctrl-as-exmpl li:nth-child(1) input').val()) .toBe('408 555 1212'); expect(element('#ctrl-as-exmpl li:nth-child(2) input').val()) .toBe('john.smith@example.org'); element('#ctrl-as-exmpl li:first a:contains("clear")').click(); expect(element('#ctrl-as-exmpl li:first input').val()).toBe(''); element('#ctrl-as-exmpl li:last a:contains("add")').click(); expect(element('#ctrl-as-exmpl li:nth-child(3) input').val()) .toBe('yourname@example.org'); }); </script> </div> </div><h4 id="example_demo">Demo</h4> <div class="well doc-example-live animate-container" ng-embed-app="" ng-set-html="index.html-76" ng-eval-javascript="script.js-75"></div> <h4 id="example_source">Source</h4> <div source-edit="" source-edit-deps="angular.js script.js" source-edit-html="index.html-79" source-edit-css="" source-edit-js="script.js-78" source-edit-json="" source-edit-unit="" source-edit-scenario="scenario.js-80" source-edit-protractor=""></div> <div class="tabbable"><div class="tab-pane" title="index.html"> <pre class="prettyprint linenums" ng-set-text="index.html-79" ng-html-wrap=" angular.js script.js"></pre> <script type="text/ng-template" id="index.html-79"> <div id="ctrl-exmpl" ng-controller="SettingsController2"> Name: <input type="text" ng-model="name"/> [ <a href="" ng-click="greet()">greet</a> ]<br/> Contact: <ul> <li ng-repeat="contact in contacts"> <select ng-model="contact.type"> <option>phone</option> <option>email</option> </select> <input type="text" ng-model="contact.value"/> [ <a href="" ng-click="clearContact(contact)">clear</a> | <a href="" ng-click="removeContact(contact)">X</a> ] </li> <li>[ <a href="" ng-click="addContact()">add</a> ]</li> </ul> </div> </script> </div> <div class="tab-pane" title="script.js"> <pre class="prettyprint linenums" ng-set-text="script.js-78"></pre> <script type="text/ng-template" id="script.js-78"> function SettingsController2($scope) { $scope.name = "John Smith"; $scope.contacts = [ {type:'phone', value:'408 555 1212'}, {type:'email', value:'john.smith@example.org'} ]; $scope.greet = function() { alert(this.name); }; $scope.addContact = function() { this.contacts.push({type:'email', value:'yourname@example.org'}); }; $scope.removeContact = function(contactToRemove) { var index = this.contacts.indexOf(contactToRemove); this.contacts.splice(index, 1); }; $scope.clearContact = function(contact) { contact.type = 'phone'; contact.value = ''; }; } </script> </div> <div class="tab-pane" title="ngScenario e2e test"> <pre class="prettyprint linenums" ng-set-text="scenario.js-80"></pre> <script type="text/ng-template" id="scenario.js-80"> it('should check controller', function() { expect(element('#ctrl-exmpl>:input').val()).toBe('John Smith'); expect(element('#ctrl-exmpl li:nth-child(1) input').val()) .toBe('408 555 1212'); expect(element('#ctrl-exmpl li:nth-child(2) input').val()) .toBe('john.smith@example.org'); element('#ctrl-exmpl li:first a:contains("clear")').click(); expect(element('#ctrl-exmpl li:first input').val()).toBe(''); element('#ctrl-exmpl li:last a:contains("add")').click(); expect(element('#ctrl-exmpl li:nth-child(3) input').val()) .toBe('yourname@example.org'); }); </script> </div> </div><h4 id="example_demo">Demo</h4> <div class="well doc-example-live animate-container" ng-embed-app="" ng-set-html="index.html-79" ng-eval-javascript="script.js-78"></div> </div></div> </div>