Hopiu/angular.js
1
0
Fork 0
mirror of https://github.com/Hopiu/angular.js.git synced 2026-05-09 23:34:42 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs(ngForm): fix grammar and improve explanation

Browse source 
Closes #4050
This commit is contained in:
Dave Peticolas 2013-09-18 17:06:29 -07:00 committed by Pete Bacon Darwin
parent 7b2259f32c
commit f363bcb437
1 changed files with 14 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
src/ng/directive/form.js
View file

@ -188,15 +188,19 @@ function FormController(element, attrs) {
* Directive that instantiates * Directive that instantiates
* {@link ng.directive:form.FormController FormController}. * {@link ng.directive:form.FormController FormController}.
* *
* If `name` attribute is specified, the form controller is published onto the current scope under * If the `name` attribute is specified, the form controller is published onto the current scope under
* this name. * this name.
* *
* # Alias: {@link ng.directive:ngForm `ngForm`} * # Alias: {@link ng.directive:ngForm `ngForm`}
* *
* In angular forms can be nested. This means that the outer form is valid when all of the child * In Angular forms can be nested. This means that the outer form is valid when all of the child
* forms are valid as well. However browsers do not allow nesting of `<form>` elements, for this * forms are valid as well. However, browsers do not allow nesting of `<form>` elements, so
* reason angular provides {@link ng.directive:ngForm `ngForm`} alias * Angular provides the {@link ng.directive:ngForm `ngForm`} directive which behaves identically to
* which behaves identical to `<form>` but allows form nesting. * `<form>` but can be nested. This allows you to have nested forms, which is very useful when
* using Angular validation directives in forms that are dynamically generated using the
* {@link ng.directive:ngRepeat `ngRepeat`} directive. Since you cannot dynamically generate the `name`
* attribute of input elements using interpolation, you have to wrap each set of repeated inputs in an
* `ngForm` directive and nest these in an outer `form` element.
* *
* *
* # CSS classes * # CSS classes
@ -206,12 +210,12 @@ function FormController(element, attrs) {
* - `ng-dirty` Is set if the form is dirty. * - `ng-dirty` Is set if the form is dirty.
* *
* *
* # Submitting a form and preventing default action * # Submitting a form and preventing the default action
* *
* Since the role of forms in client-side Angular applications is different than in classical * Since the role of forms in client-side Angular applications is different than in classical
* roundtrip apps, it is desirable for the browser not to translate the form submission into a full * roundtrip apps, it is desirable for the browser not to translate the form submission into a full
* page reload that sends the data to the server. Instead some javascript logic should be triggered * page reload that sends the data to the server. Instead some javascript logic should be triggered
* to handle the form submission in application specific way. * to handle the form submission in an application-specific way.
* *
* For this reason, Angular prevents the default action (form submission to the server) unless the * For this reason, Angular prevents the default action (form submission to the server) unless the
* `<form>` element has an `action` attribute specified. * `<form>` element has an `action` attribute specified.
@ -223,8 +227,9 @@ function FormController(element, attrs) {
* - {@link ng.directive:ngClick ngClick} directive on the first * - {@link ng.directive:ngClick ngClick} directive on the first
* button or input field of type submit (input[type=submit]) * button or input field of type submit (input[type=submit])
* *
* To prevent double execution of the handler, use only one of ngSubmit or ngClick directives. This * To prevent double execution of the handler, use only one of the {@link ng.directive:ngSubmit ngSubmit}
* is because of the following form submission rules coming from the html spec: * or {@link ng.directive:ngClick ngClick} directives.
* This is because of the following form submission rules in the HTML specification:
* *
* - If a form has only one input field then hitting enter in this field triggers form submit * - If a form has only one input field then hitting enter in this field triggers form submit
* (`ngSubmit`) * (`ngSubmit`)