Skip to content
This repository has been archived by the owner on Apr 12, 2024. It is now read-only.

Commit

Permalink
doc(form): Minor form doc fixes and additions
Browse files Browse the repository at this point in the history
Form documentation fixes:
- Fix broken form example in docs
- Add method documentation for $setDirty()
- A few small other corrections in form docs.
  • Loading branch information
jonbcard committed Dec 16, 2012
1 parent 039b138 commit 3ec3566
Showing 1 changed file with 18 additions and 5 deletions.
23 changes: 18 additions & 5 deletions src/ng/directive/form.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ var nullFormCtrl = {
*
* @property {boolean} $pristine True if user has not interacted with the form yet.
* @property {boolean} $dirty True if user has already interacted with the form.
* @property {boolean} $valid True if all of the containg forms and controls are valid.
* @property {boolean} $valid True if all of the containing forms and controls are valid.
* @property {boolean} $invalid True if at least one containing control or form is invalid.
*
* @property {Object} $error Is an object hash, containing references to all invalid controls or
* forms, where:
*
* - keys are validation tokens (error names) — such as `REQUIRED`, `URL` or `EMAIL`),
* - keys are validation tokens (error names) — such as `required`, `url` or `email`),
* - values are arrays of controls or forms that are invalid with given error.
*
* @description
Expand Down Expand Up @@ -119,6 +119,19 @@ function FormController(element, attrs) {
}
};

/**
* @ngdoc function
* @name ng.directive:form.FormController#$setDirty
* @methodOf ng.directive:form.FormController
*
* @description
* Sets the form as dirty. This will remove the 'ng-pristine' class and add 'ng-dirty' to
* the form element. This change will be propagated to all parent forms.
*
* Changes to an ng-model control within a form (e.g. {@link ng.directive:input input})
* automatically invoke this as part of
* {@link ng.directive:ngModel.NgModelController#$setViewValue $setViewValue()}.
*/
form.$setDirty = function() {
element.removeClass(PRISTINE_CLASS).addClass(DIRTY_CLASS);
form.$dirty = true;
Expand Down Expand Up @@ -162,7 +175,7 @@ function FormController(element, attrs) {
* does not allow nesting of form elements. It is useful to nest forms, for example if the validity of a
* sub-group of controls needs to be determined.
*
* @param {string=} ngForm|name Name of the form. If specified, the form controller will be published into
* @param {string=} name|ngForm Name of the form. If specified, the form controller will be published into
* related scope, under this name.
*
*/
Expand Down Expand Up @@ -235,12 +248,12 @@ function FormController(element, attrs) {
</script>
<form name="myForm" ng-controller="Ctrl">
userType: <input name="input" ng-model="userType" required>
<span class="error" ng-show="myForm.input.$error.REQUIRED">Required!</span><br>
<span class="error" ng-show="myForm.input.$error.required">Required!</span><br>
<tt>userType = {{userType}}</tt><br>
<tt>myForm.input.$valid = {{myForm.input.$valid}}</tt><br>
<tt>myForm.input.$error = {{myForm.input.$error}}</tt><br>
<tt>myForm.$valid = {{myForm.$valid}}</tt><br>
<tt>myForm.$error.REQUIRED = {{!!myForm.$error.REQUIRED}}</tt><br>
<tt>myForm.$error.required = {{!!myForm.$error.required}}</tt><br>
</form>
</doc:source>
<doc:scenario>
Expand Down

0 comments on commit 3ec3566

Please sign in to comment.