cargdev/angular
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(aio): provide link text for AbstractControl references in reactive directives for forms

Browse Source 
Closes #17484
This commit is contained in:
Linskeyd 2017-09-06 23:41:03 -07:00 committed by Matias Niemelä
parent 6c3f1f70ba
commit 37086748bf
4 changed files with 16 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
packages/forms/src/directives/reactive_directives/form_control_directive.ts
View File

@ -45,12 +45,12 @@ export const formControlBinding: any = {
* {@link AbstractControl}. * {@link AbstractControl}.
* *
* **Set the value**: You can pass in an initial value when instantiating the {@link FormControl}, * **Set the value**: You can pass in an initial value when instantiating the {@link FormControl},
* or you can set it programmatically later using {@link AbstractControl#setValue} or * or you can set it programmatically later using {@link AbstractControl#setValue setValue} or
* {@link AbstractControl#patchValue}. * {@link AbstractControl#patchValue patchValue}.
* *
* **Listen to value**: If you want to listen to changes in the value of the control, you can * **Listen to value**: If you want to listen to changes in the value of the control, you can
* subscribe to the {@link AbstractControl#valueChanges} event. You can also listen to * subscribe to the {@link AbstractControl#valueChanges valueChanges} event. You can also listen to
* {@link AbstractControl#statusChanges} to be notified when the validation status is * {@link AbstractControl#statusChanges statusChanges} to be notified when the validation status is
* re-calculated. * re-calculated.
* *
* ### Example * ### Example

8
packages/forms/src/directives/reactive_directives/form_control_name.ts
View File

@ -45,7 +45,7 @@ export const controlNameBinding: any = {
* closest {@link FormGroup} or {@link FormArray} above it. * closest {@link FormGroup} or {@link FormArray} above it.
* *
* **Access the control**: You can access the {@link FormControl} associated with * **Access the control**: You can access the {@link FormControl} associated with
* this directive by using the {@link AbstractControl#get} method. * this directive by using the {@link AbstractControl#get get} method.
* Ex: `this.form.get('first');` * Ex: `this.form.get('first');`
* *
* **Get value**: the `value` property is always synced and available on the {@link FormControl}. * **Get value**: the `value` property is always synced and available on the {@link FormControl}.
@ -53,11 +53,11 @@ export const controlNameBinding: any = {
* *
* **Set value**: You can set an initial value for the control when instantiating the * **Set value**: You can set an initial value for the control when instantiating the
* {@link FormControl}, or you can set it programmatically later using * {@link FormControl}, or you can set it programmatically later using
* {@link AbstractControl#setValue} or {@link AbstractControl#patchValue}. * {@link AbstractControl#setValue setValue} or {@link AbstractControl#patchValue patchValue}.
* *
* **Listen to value**: If you want to listen to changes in the value of the control, you can * **Listen to value**: If you want to listen to changes in the value of the control, you can
* subscribe to the {@link AbstractControl#valueChanges} event. You can also listen to * subscribe to the {@link AbstractControl#valueChanges valueChanges} event. You can also listen to
* {@link AbstractControl#statusChanges} to be notified when the validation status is * {@link AbstractControl#statusChanges statusChanges} to be notified when the validation status is
* re-calculated. * re-calculated.
* *
* ### Example * ### Example

9
packages/forms/src/directives/reactive_directives/form_group_directive.ts
View File

@ -34,12 +34,13 @@ export const formDirectiveProvider: any = {
* *
* **Set value**: You can set the form's initial value when instantiating the * **Set value**: You can set the form's initial value when instantiating the
* {@link FormGroup}, or you can set it programmatically later using the {@link FormGroup}'s * {@link FormGroup}, or you can set it programmatically later using the {@link FormGroup}'s
* {@link AbstractControl#setValue} or {@link AbstractControl#patchValue} methods. * {@link AbstractControl#setValue setValue} or {@link AbstractControl#patchValue patchValue}
* methods.
* *
* **Listen to value**: If you want to listen to changes in the value of the form, you can subscribe * **Listen to value**: If you want to listen to changes in the value of the form, you can subscribe
* to the {@link FormGroup}'s {@link AbstractControl#valueChanges} event. You can also listen to * to the {@link FormGroup}'s {@link AbstractControl#valueChanges valueChanges} event. You can also
* its {@link AbstractControl#statusChanges} event to be notified when the validation status is * listen to its {@link AbstractControl#statusChanges statusChanges} event to be notified when the
* re-calculated. * validation status is re-calculated.
* *
* Furthermore, you can listen to the directive's `ngSubmit` event to be notified when the user has * Furthermore, you can listen to the directive's `ngSubmit` event to be notified when the user has
* triggered a form submission. The `ngSubmit` event will be emitted with the original form * triggered a form submission. The `ngSubmit` event will be emitted with the original form

6
packages/forms/src/directives/reactive_directives/form_group_name.ts
View File

@ -50,11 +50,11 @@ export const formGroupNameProvider: any = {
* *
* **Set the value**: You can set an initial value for each child control when instantiating * **Set the value**: You can set an initial value for each child control when instantiating
* the {@link FormGroup}, or you can set it programmatically later using * the {@link FormGroup}, or you can set it programmatically later using
* {@link AbstractControl#setValue} or {@link AbstractControl#patchValue}. * {@link AbstractControl#setValue setValue} or {@link AbstractControl#patchValue patchValue}.
* *
* **Listen to value**: If you want to listen to changes in the value of the group, you can * **Listen to value**: If you want to listen to changes in the value of the group, you can
* subscribe to the {@link AbstractControl#valueChanges} event. You can also listen to * subscribe to the {@link AbstractControl#valueChanges valueChanges} event. You can also listen to
* {@link AbstractControl#statusChanges} to be notified when the validation status is * {@link AbstractControl#statusChanges statusChanges} to be notified when the validation status is
* re-calculated. * re-calculated.
* *
* ### Example * ### Example