345 lines
17 KiB
HTML
Executable file
345 lines
17 KiB
HTML
Executable file
<a href="http://github.com/angular/angular.js/edit/master/docs/content/guide/forms.ngdoc" class="improve-docs btn btn-primary"><i class="icon-edit"> </i> Improve this doc</a><h1><code ng:non-bindable=""></code>
|
|
<div><span class="hint"></span>
|
|
</div>
|
|
</h1>
|
|
<div><div class="forms-page"><p>Controls (<code>input</code>, <code>select</code>, <code>textarea</code>) are ways for a user to enter data.
|
|
A Form is a collection of controls for the purpose of grouping related controls together.</p>
|
|
<p>Form and controls provide validation services, so that the user can be notified of invalid input.
|
|
This provides a better user experience, because the user gets instant feedback on how to correct the error.
|
|
Keep in mind that while client-side validation plays an important role in providing good user experience, it can easily be circumvented and thus can not be trusted.
|
|
Server-side validation is still necessary for a secure application.</p>
|
|
<h2>Simple form</h1>
|
|
<p>The key directive in understanding two-way data-binding is <a href="api/ng.directive:ngModel"><code>ngModel</code></a>.
|
|
The <code>ngModel</code> directive provides the two-way data-binding by synchronizing the model to the view, as well as view to the model.
|
|
In addition it provides an <a href="api/ng.directive:ngModel.NgModelController"><code>API</code></a> for other directives to augment its behavior.</p>
|
|
<h3>Source</h2>
|
|
<div source-edit="" source-edit-deps="angular.js script.js" source-edit-html="index.html-225" source-edit-css="" source-edit-js="script.js-224" source-edit-json="" source-edit-unit="" source-edit-scenario=""></div>
|
|
<div class="tabbable"><div class="tab-pane" title="index.html">
|
|
<pre class="prettyprint linenums" ng-set-text="index.html-225" ng-html-wrap=" angular.js script.js"></pre>
|
|
<script type="text/ng-template" id="index.html-225">
|
|
<div ng-controller="Controller">
|
|
<form novalidate class="simple-form">
|
|
Name: <input type="text" ng-model="user.name" /><br />
|
|
E-mail: <input type="email" ng-model="user.email" /><br />
|
|
Gender: <input type="radio" ng-model="user.gender" value="male" />male
|
|
<input type="radio" ng-model="user.gender" value="female" />female<br />
|
|
<button ng-click="reset()">RESET</button>
|
|
<button ng-click="update(user)">SAVE</button>
|
|
</form>
|
|
<pre>form = {{user | json}}</pre>
|
|
<pre>master = {{master | json}}</pre>
|
|
</div>
|
|
|
|
|
|
</script>
|
|
</div>
|
|
<div class="tab-pane" title="script.js">
|
|
<pre class="prettyprint linenums" ng-set-text="script.js-224"></pre>
|
|
<script type="text/ng-template" id="script.js-224">
|
|
function Controller($scope) {
|
|
$scope.master= {};
|
|
|
|
$scope.update = function(user) {
|
|
$scope.master= angular.copy(user);
|
|
};
|
|
|
|
$scope.reset = function() {
|
|
$scope.user = angular.copy($scope.master);
|
|
};
|
|
|
|
$scope.reset();
|
|
}
|
|
</script>
|
|
</div>
|
|
</div><h2>Demo</h2>
|
|
<div class="well doc-example-live animate-container" ng-embed-app="" ng-set-html="index.html-225" ng-eval-javascript="script.js-224"></div>
|
|
<p>Note that <code>novalidate</code> is used to disable browser's native form validation.</p>
|
|
<h1>Using CSS classes</h1>
|
|
<p>To allow styling of form as well as controls, <code>ngModel</code> add these CSS classes:</p>
|
|
<ul>
|
|
<li><code>ng-valid</code></li>
|
|
<li><code>ng-invalid</code></li>
|
|
<li><code>ng-pristine</code></li>
|
|
<li><code>ng-dirty</code></li>
|
|
</ul>
|
|
<p>The following example uses the CSS to display validity of each form control.
|
|
In the example both <code>user.name</code> and <code>user.email</code> are required, but are rendered with red background only when they are dirty.
|
|
This ensures that the user is not distracted with an error until after interacting with the control, and failing to satisfy its validity.</p>
|
|
<h2>Source</h2>
|
|
<div source-edit="" source-edit-deps="angular.js script.js" source-edit-html="index.html-227" source-edit-css="" source-edit-js="script.js-226" source-edit-json="" source-edit-unit="" source-edit-scenario=""></div>
|
|
<div class="tabbable"><div class="tab-pane" title="index.html">
|
|
<pre class="prettyprint linenums" ng-set-text="index.html-227" ng-html-wrap=" angular.js script.js"></pre>
|
|
<script type="text/ng-template" id="index.html-227">
|
|
<div ng-controller="Controller">
|
|
<form novalidate class="css-form">
|
|
Name:
|
|
<input type="text" ng-model="user.name" required /><br />
|
|
E-mail: <input type="email" ng-model="user.email" required /><br />
|
|
Gender: <input type="radio" ng-model="user.gender" value="male" />male
|
|
<input type="radio" ng-model="user.gender" value="female" />female<br />
|
|
<button ng-click="reset()">RESET</button>
|
|
<button ng-click="update(user)">SAVE</button>
|
|
</form>
|
|
</div>
|
|
|
|
<style type="text/css">
|
|
.css-form input.ng-invalid.ng-dirty {
|
|
background-color: #FA787E;
|
|
}
|
|
|
|
.css-form input.ng-valid.ng-dirty {
|
|
background-color: #78FA89;
|
|
}
|
|
</style>
|
|
|
|
|
|
</script>
|
|
</div>
|
|
<div class="tab-pane" title="script.js">
|
|
<pre class="prettyprint linenums" ng-set-text="script.js-226"></pre>
|
|
<script type="text/ng-template" id="script.js-226">
|
|
function Controller($scope) {
|
|
$scope.master = {};
|
|
|
|
$scope.update = function(user) {
|
|
$scope.master = angular.copy(user);
|
|
};
|
|
|
|
$scope.reset = function() {
|
|
$scope.user = angular.copy($scope.master);
|
|
};
|
|
|
|
$scope.reset();
|
|
}
|
|
</script>
|
|
</div>
|
|
</div><h2>Demo</h2>
|
|
<div class="well doc-example-live animate-container" ng-embed-app="" ng-set-html="index.html-227" ng-eval-javascript="script.js-226"></div>
|
|
<h1>Binding to form and control state</h1>
|
|
<p>A form is an instance of <a href="api/ng.directive:form.FormController"><code>FormController</code></a>.
|
|
The form instance can optionally be published into the scope using the <code>name</code> attribute.
|
|
Similarly control is an instance of <a href="api/ng.directive:ngModel.NgModelController"><code>NgModelController</code></a>.
|
|
The control instance can similarly be published into the form instance using the <code>name</code> attribute.
|
|
This implies that the internal state of both the form and the control is available for binding in the view using the standard binding primitives.</p>
|
|
<p>This allows us to extend the above example with these features:</p>
|
|
<ul>
|
|
<li>RESET button is enabled only if form has some changes</li>
|
|
<li>SAVE button is enabled only if form has some changes and is valid</li>
|
|
<li>custom error messages for <code>user.email</code> and <code>user.agree</code></li>
|
|
</ul>
|
|
<h2>Source</h2>
|
|
<div source-edit="" source-edit-deps="angular.js script.js" source-edit-html="index.html-229" source-edit-css="" source-edit-js="script.js-228" source-edit-json="" source-edit-unit="" source-edit-scenario=""></div>
|
|
<div class="tabbable"><div class="tab-pane" title="index.html">
|
|
<pre class="prettyprint linenums" ng-set-text="index.html-229" ng-html-wrap=" angular.js script.js"></pre>
|
|
<script type="text/ng-template" id="index.html-229">
|
|
<div ng-controller="Controller">
|
|
<form name="form" class="css-form" novalidate>
|
|
Name:
|
|
<input type="text" ng-model="user.name" name="uName" required /><br />
|
|
E-mail:
|
|
<input type="email" ng-model="user.email" name="uEmail" required/><br />
|
|
<div ng-show="form.uEmail.$dirty && form.uEmail.$invalid">Invalid:
|
|
<span ng-show="form.uEmail.$error.required">Tell us your email.</span>
|
|
<span ng-show="form.uEmail.$error.email">This is not a valid email.</span>
|
|
</div>
|
|
|
|
Gender: <input type="radio" ng-model="user.gender" value="male" />male
|
|
<input type="radio" ng-model="user.gender" value="female" />female<br />
|
|
|
|
<input type="checkbox" ng-model="user.agree" name="userAgree" required />
|
|
I agree: <input ng-show="user.agree" type="text" ng-model="user.agreeSign"
|
|
required /><br />
|
|
<div ng-show="!user.agree || !user.agreeSign">Please agree and sign.</div>
|
|
|
|
<button ng-click="reset()" ng-disabled="isUnchanged(user)">RESET</button>
|
|
<button ng-click="update(user)"
|
|
ng-disabled="form.$invalid || isUnchanged(user)">SAVE</button>
|
|
</form>
|
|
</div>
|
|
|
|
|
|
</script>
|
|
</div>
|
|
<div class="tab-pane" title="script.js">
|
|
<pre class="prettyprint linenums" ng-set-text="script.js-228"></pre>
|
|
<script type="text/ng-template" id="script.js-228">
|
|
function Controller($scope) {
|
|
$scope.master= {};
|
|
|
|
$scope.update = function(user) {
|
|
$scope.master= angular.copy(user);
|
|
};
|
|
|
|
$scope.reset = function() {
|
|
$scope.user = angular.copy($scope.master);
|
|
};
|
|
|
|
$scope.isUnchanged = function(user) {
|
|
return angular.equals(user, $scope.master);
|
|
};
|
|
|
|
$scope.reset();
|
|
}
|
|
</script>
|
|
</div>
|
|
</div><h2>Demo</h2>
|
|
<div class="well doc-example-live animate-container" ng-embed-app="" ng-set-html="index.html-229" ng-eval-javascript="script.js-228"></div>
|
|
<h1>Custom Validation</h1>
|
|
<p>Angular provides basic implementation for most common html5 <a href="api/ng.directive:input"><code>input</code></a>
|
|
types: (<a href="api/ng.directive:input.text"><code>text</code></a>, <a href="api/ng.directive:input.number"><code>number</code></a>, <a href="api/ng.directive:input.url"><code>url</code></a>, <a href="api/ng.directive:input.email"><code>email</code></a>, <a href="api/ng.directive:input.radio"><code>radio</code></a>, <a href="api/ng.directive:input.checkbox"><code>checkbox</code></a>), as well as some directives for validation (<code>required</code>, <code>pattern</code>, <code>minlength</code>, <code>maxlength</code>, <code>min</code>, <code>max</code>).</p>
|
|
<p>Defining your own validator can be done by defining your own directive which adds a custom validation function to the <code>ngModel</code> <a href="api/ng.directive:ngModel.NgModelController"><code>controller</code></a>.
|
|
To get a hold of the controller the directive specifies a dependency as shown in the example below.
|
|
The validation can occur in two places:</p>
|
|
<ul>
|
|
<li><p><strong>Model to View update</strong> -
|
|
Whenever the bound model changes, all functions in <a href="api/ng.directive:ngModel.NgModelController#$formatters"><code>NgModelController#$formatters</code></a> array are pipe-lined, so that each of these functions has an opportunity to format the value and change validity state of the form control through <a href="api/ng.directive:ngModel.NgModelController#$setValidity"><code>NgModelController#$setValidity</code></a>.</p>
|
|
</li>
|
|
<li><p><strong>View to Model update</strong> -
|
|
In a similar way, whenever a user interacts with a control it calls <a href="api/ng.directive:ngModel.NgModelController#$setViewValue"><code>NgModelController#$setViewValue</code></a>.
|
|
This in turn pipelines all functions in the <a href="api/ng.directive:ngModel.NgModelController#$parsers"><code>NgModelController#$parsers</code></a> array, so that each of these functions has an opportunity to convert the value and change validity state of the form control through <a href="api/ng.directive:ngModel.NgModelController#$setValidity"><code>NgModelController#$setValidity</code></a>.</p>
|
|
</li>
|
|
</ul>
|
|
<p>In the following example we create two directives.</p>
|
|
<ul>
|
|
<li><p>The first one is <code>integer</code> and it validates whether the input is a valid integer.
|
|
For example <code>1.23</code> is an invalid value, since it contains a fraction.
|
|
Note that we unshift the array instead of pushing.
|
|
This is because we want to be first parser and consume the control string value, as we need to execute the validation function before a conversion to number occurs.</p>
|
|
</li>
|
|
<li><p>The second directive is a <code>smart-float</code>.
|
|
It parses both <code>1.2</code> and <code>1,2</code> into a valid float number <code>1.2</code>.
|
|
Note that we can't use input type <code>number</code> here as HTML5 browsers would not allow the user to type what it would consider an invalid number such as <code>1,2</code>.</p>
|
|
</li>
|
|
</ul>
|
|
<h2>Source</h2>
|
|
<div source-edit="form-example1" source-edit-deps="angular.js script.js" source-edit-html="index.html-231" source-edit-css="" source-edit-js="script.js-230" source-edit-json="" source-edit-unit="" source-edit-scenario=""></div>
|
|
<div class="tabbable"><div class="tab-pane" title="index.html">
|
|
<pre class="prettyprint linenums" ng-set-text="index.html-231" ng-html-wrap="form-example1 angular.js script.js"></pre>
|
|
<script type="text/ng-template" id="index.html-231">
|
|
<div ng-controller="Controller">
|
|
<form name="form" class="css-form" novalidate>
|
|
<div>
|
|
Size (integer 0 - 10):
|
|
<input type="number" ng-model="size" name="size"
|
|
min="0" max="10" integer />{{size}}<br />
|
|
<span ng-show="form.size.$error.integer">This is not valid integer!</span>
|
|
<span ng-show="form.size.$error.min || form.size.$error.max">
|
|
The value must be in range 0 to 10!</span>
|
|
</div>
|
|
|
|
<div>
|
|
Length (float):
|
|
<input type="text" ng-model="length" name="length" smart-float />
|
|
{{length}}<br />
|
|
<span ng-show="form.length.$error.float">
|
|
This is not a valid float number!</span>
|
|
</div>
|
|
</form>
|
|
</div>
|
|
|
|
|
|
</script>
|
|
</div>
|
|
<div class="tab-pane" title="script.js">
|
|
<pre class="prettyprint linenums" ng-set-text="script.js-230"></pre>
|
|
<script type="text/ng-template" id="script.js-230">
|
|
var app = angular.module('form-example1', []);
|
|
|
|
var INTEGER_REGEXP = /^\-?\d*$/;
|
|
app.directive('integer', function() {
|
|
return {
|
|
require: 'ngModel',
|
|
link: function(scope, elm, attrs, ctrl) {
|
|
ctrl.$parsers.unshift(function(viewValue) {
|
|
if (INTEGER_REGEXP.test(viewValue)) {
|
|
// it is valid
|
|
ctrl.$setValidity('integer', true);
|
|
return viewValue;
|
|
} else {
|
|
// it is invalid, return undefined (no model update)
|
|
ctrl.$setValidity('integer', false);
|
|
return undefined;
|
|
}
|
|
});
|
|
}
|
|
};
|
|
});
|
|
|
|
var FLOAT_REGEXP = /^\-?\d+((\.|\,)\d+)?$/;
|
|
app.directive('smartFloat', function() {
|
|
return {
|
|
require: 'ngModel',
|
|
link: function(scope, elm, attrs, ctrl) {
|
|
ctrl.$parsers.unshift(function(viewValue) {
|
|
if (FLOAT_REGEXP.test(viewValue)) {
|
|
ctrl.$setValidity('float', true);
|
|
return parseFloat(viewValue.replace(',', '.'));
|
|
} else {
|
|
ctrl.$setValidity('float', false);
|
|
return undefined;
|
|
}
|
|
});
|
|
}
|
|
};
|
|
});
|
|
</script>
|
|
</div>
|
|
</div><h2>Demo</h2>
|
|
<div class="well doc-example-live animate-container" ng-embed-app="form-example1" ng-set-html="index.html-231" ng-eval-javascript="script.js-230"></div>
|
|
<h1>Implementing custom form controls (using <code>ngModel</code>)</h2>
|
|
<p>Angular implements all of the basic HTML form controls (<a href="api/ng.directive:input"><code>input</code></a>, <a href="api/ng.directive:select"><code>select</code></a>, <a href="api/ng.directive:textarea"><code>textarea</code></a>), which should be sufficient for most cases.
|
|
However, if you need more flexibility, you can write your own form control as a directive.</p>
|
|
<p>In order for custom control to work with <code>ngModel</code> and to achieve two-way data-binding it needs to:</p>
|
|
<ul>
|
|
<li>implement <code>$render</code> method, which is responsible for rendering the data after it passed the <a href="api/ng.directive:ngModel.NgModelController#$formatters"><code>NgModelController#$formatters</code></a>,</li>
|
|
<li>call <code>$setViewValue</code> method, whenever the user interacts with the control and model needs to be updated. This is usually done inside a DOM Event listener.</li>
|
|
</ul>
|
|
<p>See <a href="guide/directive">$compileProvider.directive</a> for more info.</p>
|
|
<p>The following example shows how to add two-way data-binding to contentEditable elements.</p>
|
|
<h2>Source</h2>
|
|
<div source-edit="form-example2" source-edit-deps="angular.js script.js" source-edit-html="index.html-233" source-edit-css="" source-edit-js="script.js-232" source-edit-json="" source-edit-unit="" source-edit-scenario=""></div>
|
|
<div class="tabbable"><div class="tab-pane" title="index.html">
|
|
<pre class="prettyprint linenums" ng-set-text="index.html-233" ng-html-wrap="form-example2 angular.js script.js"></pre>
|
|
<script type="text/ng-template" id="index.html-233">
|
|
|
|
|
|
<div contentEditable="true" ng-model="content" title="Click to edit">Some</div>
|
|
<pre>model = {{content}}</pre>
|
|
|
|
<style type="text/css">
|
|
div[contentEditable] {
|
|
cursor: pointer;
|
|
background-color: #D0D0D0;
|
|
}
|
|
</style>
|
|
</script>
|
|
</div>
|
|
<div class="tab-pane" title="script.js">
|
|
<pre class="prettyprint linenums" ng-set-text="script.js-232"></pre>
|
|
<script type="text/ng-template" id="script.js-232">
|
|
angular.module('form-example2', []).directive('contenteditable', function() {
|
|
return {
|
|
require: 'ngModel',
|
|
link: function(scope, elm, attrs, ctrl) {
|
|
// view -> model
|
|
elm.on('blur', function() {
|
|
scope.$apply(function() {
|
|
ctrl.$setViewValue(elm.html());
|
|
});
|
|
});
|
|
|
|
// model -> view
|
|
ctrl.$render = function() {
|
|
elm.html(ctrl.$viewValue);
|
|
};
|
|
|
|
// load init value from DOM
|
|
ctrl.$setViewValue(elm.html());
|
|
}
|
|
};
|
|
});
|
|
</script>
|
|
</div>
|
|
</div><h2>Demo</h3>
|
|
<div class="well doc-example-live animate-container" ng-embed-app="form-example2" ng-set-html="index.html-233" ng-eval-javascript="script.js-232"></div>
|
|
</div></div>
|