aboutsummaryrefslogtreecommitdiffstats
path: root/src/widget
diff options
context:
space:
mode:
authorIgor Minar2011-10-19 16:43:16 -0700
committerIgor Minar2011-10-19 16:49:34 -0700
commita46f2a0db37c88465072d0eec22b0439bf003ff7 (patch)
treea02988c377c4ecb293d30f142db482b657e64c7a /src/widget
parent3217a249e18c12fb1ade59073773e2ab67a67792 (diff)
downloadangular.js-a46f2a0db37c88465072d0eec22b0439bf003ff7.tar.bz2
docs(textarea): add docs for angular.widget.textarea
Diffstat (limited to 'src/widget')
-rw-r--r--src/widget/input.js27
1 files changed, 26 insertions, 1 deletions
diff --git a/src/widget/input.js b/src/widget/input.js
index 627aee27..a530b6a8 100644
--- a/src/widget/input.js
+++ b/src/widget/input.js
@@ -831,9 +831,34 @@ angularWidget('input', function(inputElement){
});
}
});
-
});
+
+/**
+ * @ngdoc widget
+ * @name angular.widget.textarea
+ *
+ * @description
+ * HTML textarea element widget with angular data-binding. The data-binding and validation
+ * properties of this element are exactly the same as those of the
+ * {@link angular.widget.input input element}.
+ *
+ * @param {string} type Widget types as defined by {@link angular.inputType}. If the
+ * type is in the format of `@ScopeType` then `ScopeType` is loaded from the
+ * current scope, allowing quick definition of type.
+ * @param {string} ng:model Assignable angular expression to data-bind to.
+ * @param {string=} name Property name of the form under which the widgets is published.
+ * @param {string=} required Sets `REQUIRED` validation error key if the value is not entered.
+ * @param {number=} ng:minlength Sets `MINLENGTH` validation error key if the value is shorter than
+ * minlength.
+ * @param {number=} ng:maxlength Sets `MAXLENGTH` validation error key if the value is longer than
+ * maxlength.
+ * @param {string=} ng:pattern Sets `PATTERN` validation error key if the value does not match the
+ * RegExp pattern expression. Expected value is `/regexp/` for inline patterns or `regexp` for
+ * patterns defined as scope expressions.
+ * @param {string=} ng:change Angular expression to be executed when input changes due to user
+ * interaction with the input element.
+ */
angularWidget('textarea', angularWidget('input'));