docs(cdk/coercion): add guidance on Angular built-in input transforms#32835
Open
yogeshwaran-c wants to merge 1 commit intoangular:mainfrom
Open
docs(cdk/coercion): add guidance on Angular built-in input transforms#32835yogeshwaran-c wants to merge 1 commit intoangular:mainfrom
yogeshwaran-c wants to merge 1 commit intoangular:mainfrom
Conversation
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
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.
What kind of change does this PR introduce?
Documentation improvement
What is the current behavior?
The CDK coercion documentation only shows the legacy pattern of using
coerceBooleanPropertyandcoerceNumberPropertywith@Input()gettersand setters. It does not mention that Angular now provides built-in equivalents
(
booleanAttributeandnumberAttribute) that work with signal inputs.Closes #27718
What is the new behavior?
Updates the coercion documentation to:
built-in equivalents (
booleanAttribute,numberAttribute)input()with{transform: booleanAttribute}and
{transform: numberAttribute}coerceElementandcoerceArrayremain useful for custom coercion logic
Additional context
Since Angular v16+, the
transformoption on@Input()made CDK coercionless necessary for boolean and number inputs. Since Angular v17+, signal inputs
(
input()) with transforms provide the cleanest API. The CDK coercion moduleis still useful for
coerceElement,coerceArray, and custom coercion logic.