This repository was archived by the owner on Apr 12, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 27.4k
feat(form.FormController): add $getControls() #16601
Merged
Merged
Changes from 1 commit
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,6 +4,7 @@ | |
*/ | ||
var nullFormCtrl = { | ||
$addControl: noop, | ||
$getControls: noop, | ||
$$renameControl: nullFormRenameControl, | ||
$removeControl: noop, | ||
$setValidity: noop, | ||
|
@@ -159,6 +160,28 @@ FormController.prototype = { | |
control.$$parentForm = this; | ||
}, | ||
|
||
/** | ||
* @ngdoc method | ||
* @name form.FormController#$getControls | ||
* @returns {Array} the controls that are currently part of this form | ||
* | ||
* @description | ||
* This method returns a **shallow copy** of the controls that are currently part of this form | ||
* ({@link form.FormController `FormController`} / | ||
* {@link ngModel.NgModelController `NgModelController`}) . This can be used | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I assume here you refer to the fact that the controls can be either I think it makes sense to be more explicit about this in the docs (because not all people might realize |
||
* for example to iterate over all controls to validate them. | ||
* | ||
* The controls can be accessed normally, but adding or removing controls from the array has no | ||
* effect on the form. Instead, use {@link form.FormController#$addControl `$addControl()`} and | ||
* {@link form.FormController#$removeControl `$removeControl()`}. | ||
* Likewise, adding a control to / removing a control from the form is not reflected | ||
* in the shallow copy. That means you should get a fresh copy from `$getControls` every time | ||
* you need access to the controls. | ||
*/ | ||
$getControls: function() { | ||
return shallowCopy(this.$$controls); | ||
}, | ||
|
||
// Private API: rename a form control | ||
$$renameControl: function(control, newName) { | ||
var oldName = control.$name; | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this should return an empty array (to respect the "contract" that
$getControls()
returns an array).Maybe change it to
valueFn([])
.