From 8fa4ebca54de3bc58b423539f1481cc4512561f0 Mon Sep 17 00:00:00 2001 From: Matthieu Riegler Date: Tue, 7 May 2024 02:03:10 +0200 Subject: [PATCH] refactor(forms): deprecate unwanted control events aliases This commit deprecates the aliases for the control events to ease the changes in G3 A follow-up commit will remove those deprecated entries. --- goldens/public-api/forms/index.md | 16 ++++++++++++-- packages/forms/src/forms.ts | 9 +++++--- packages/forms/src/model/abstract_model.ts | 25 ++++++++++++++++++---- 3 files changed, 41 insertions(+), 9 deletions(-) diff --git a/goldens/public-api/forms/index.md b/goldens/public-api/forms/index.md index f627125c5f44a8..6878c641c28899 100644 --- a/goldens/public-api/forms/index.md +++ b/goldens/public-api/forms/index.md @@ -800,6 +800,10 @@ export class PatternValidator extends AbstractValidatorDirective { } // @public +export class PristineChangeEvent extends PristineEvent { +} + +// @public @deprecated (undocumented) export class PristineEvent extends ControlEvent { constructor(pristine: boolean, source: AbstractControl); // (undocumented) @@ -894,7 +898,7 @@ export class SelectMultipleControlValueAccessor extends BuiltInControlValueAcces export type SetDisabledStateOption = 'whenDisabledForLegacyCode' | 'always'; // @public -export class StatusEvent extends ControlEvent { +export class StatusChangeEvent extends ControlEvent { constructor(status: FormControlStatus, source: AbstractControl); // (undocumented) readonly source: AbstractControl; @@ -902,8 +906,12 @@ export class StatusEvent extends ControlEvent { readonly status: FormControlStatus; } +// @public @deprecated (undocumented) +export class StatusEvent extends StatusChangeEvent { +} + // @public -export class TouchedEvent extends ControlEvent { +export class TouchedChangeEvent extends ControlEvent { constructor(touched: boolean, source: AbstractControl); // (undocumented) readonly source: AbstractControl; @@ -911,6 +919,10 @@ export class TouchedEvent extends ControlEvent { readonly touched: boolean; } +// @public @deprecated (undocumented) +export class TouchedEvent extends TouchedChangeEvent { +} + // @public export type UntypedFormArray = FormArray; diff --git a/packages/forms/src/forms.ts b/packages/forms/src/forms.ts index e5d6880d402784..6d5f2cd67ea8d6 100644 --- a/packages/forms/src/forms.ts +++ b/packages/forms/src/forms.ts @@ -76,9 +76,12 @@ export { FormControlStatus, FormResetEvent, FormSubmittedEvent, - PristineChangeEvent as PristineEvent, - StatusChangeEvent as StatusEvent, - TouchedChangeEvent as TouchedEvent, + PristineEvent, + StatusEvent, + TouchedEvent, + PristineChangeEvent, + StatusChangeEvent, + TouchedChangeEvent, ValueChangeEvent, ɵCoerceStrArrToNumArr, ɵGetProperty, diff --git a/packages/forms/src/model/abstract_model.ts b/packages/forms/src/model/abstract_model.ts index 1b9659342b92da..64dcca244b5657 100644 --- a/packages/forms/src/model/abstract_model.ts +++ b/packages/forms/src/model/abstract_model.ts @@ -103,11 +103,10 @@ export class ValueChangeEvent extends ControlEvent { } /** - * Event fired when the control's pristine state changes (pristine <=> dirty). - * - * @publicApi + * @deprecated use `PristineChangeEvent` symbol instead. */ -export class PristineChangeEvent extends ControlEvent { + +export class PristineEvent extends ControlEvent { constructor( public readonly pristine: boolean, public readonly source: AbstractControl, @@ -116,6 +115,14 @@ export class PristineChangeEvent extends ControlEvent { } } +/** + * Event fired when the control's pristine state changes (pristine <=> dirty). + * + * @publicApi + */ + +export class PristineChangeEvent extends PristineEvent {} + /** * Event fired when the control's touched status changes (touched <=> untouched). * @@ -130,6 +137,11 @@ export class TouchedChangeEvent extends ControlEvent { } } +/** + * @deprecated use `TouchedChangeEvent` symbol instead. + */ +export class TouchedEvent extends TouchedChangeEvent {} + /** * Event fired when the control's status changes. * @@ -165,6 +177,11 @@ export class FormResetEvent extends ControlEvent { } } +/** + * @deprecated use `StatusChangeEvent` symbol instead. + */ +export class StatusEvent extends StatusChangeEvent {} + /** * Gets validators from either an options object or given validators. */