docs(forms): clarify boxed values in FormBuilder API#68799
Open
mohanrajvenkatesan23-04 wants to merge 1 commit into
Open
docs(forms): clarify boxed values in FormBuilder API#68799mohanrajvenkatesan23-04 wants to merge 1 commit into
mohanrajvenkatesan23-04 wants to merge 1 commit into
Conversation
Expand the JSDoc on FormBuilder.control, FormBuilder.group,
FormBuilder.array, NonNullableFormBuilder.control, ControlConfig, and
FormControlState to explicitly document the "boxed value"
({value, disabled}) shape: where it is accepted, how it differs from
the AbstractControlOptions configuration object, and how it
corresponds to the FormControl constructor's first argument. Add
usage examples for raw values, boxed values, and ControlConfig tuples
so readers do not confuse them with the options argument.
Closes angular#36746
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
The JSDoc on
FormBuilder.control,FormBuilder.group,FormBuilder.array,NonNullableFormBuilder.control,ControlConfig, andFormControlStatementions "boxed values" only briefly — without defining what shape is
accepted, how it interacts with the
AbstractControlOptionsargument, orhow it maps to the
FormControlconstructor. Issue #36746 reports thatthis is confusing for users trying to initialize a control as disabled.
Issue Number: #36746
What is the new behavior?
The JSDoc on every
FormBuilderfactory now:FormControlState<T>—{value: T, disabled: boolean}).boxed value /
ControlConfigtuple / already-constructedAbstractControl).{validators, asyncValidators, updateOn, nonNullable}options object so readers do not pass it where a value isexpected.
FormControlconstructor so the two surfaces stayvisibly consistent.
and
ControlConfigtuples.No runtime behavior or public-API surface is changed — JSDoc only. Also
fixes a pre-existing typo in
FormBuilder.control("the type of" → "thetype of").
Does this PR introduce a breaking change?
Other information
Documentation-only change. No unit tests added (
docs:is exempt from the"tests must be added" rule per CONTRIBUTING.md). Public-API goldens were
not regenerated because no exported symbol or signature changed.