Skip to content

Commit 2ecef23

Browse files
committed
refactor(multiple): deprecate exposed ripples (#26914)
* refactor(multiple): deprecate exposed ripples * fixup! refactor(multiple): deprecate exposed ripples (cherry picked from commit 708c971)
1 parent c67d7db commit 2ecef23

File tree

4 files changed

+12
-2
lines changed

4 files changed

+12
-2
lines changed

src/material/checkbox/checkbox.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,11 @@ export abstract class _MatCheckboxBase<E>
180180
/** The native `<label>` element */
181181
@ViewChild('label') _labelElement: ElementRef<HTMLInputElement>;
182182

183-
/** Reference to the ripple instance of the checkbox. */
183+
/**
184+
* Reference to the MatRipple instance of the checkbox.
185+
* @deprecated Considered an implementation detail. To be removed.
186+
* @breaking-change 17.0.0
187+
*/
184188
@ViewChild(MatRipple) ripple: MatRipple;
185189

186190
/**

src/material/chips/chip.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,11 @@ export class MatChip
246246
/** The chip's trailing remove icon. */
247247
@ContentChild(MAT_CHIP_REMOVE) removeIcon: MatChipRemove;
248248

249-
/** Reference to the MatRipple instance of the chip. */
249+
/**
250+
* Reference to the MatRipple instance of the chip.
251+
* @deprecated Considered an implementation detail. To be removed.
252+
* @breaking-change 17.0.0
253+
*/
250254
@ViewChild(MatRipple) ripple: MatRipple;
251255

252256
/** Action receiving the primary set of user interactions. */

tools/public_api_guard/material/checkbox.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,7 @@ export abstract class _MatCheckboxBase<E> extends _MatCheckboxMixinBase implemen
124124
registerOnTouched(fn: any): void;
125125
get required(): boolean;
126126
set required(value: BooleanInput);
127+
// @deprecated
127128
ripple: MatRipple;
128129
// (undocumented)
129130
setDisabledState(isDisabled: boolean): void;

tools/public_api_guard/material/chips.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,7 @@ export class MatChip extends _MatChipMixinBase implements OnInit, AfterViewInit,
113113
remove(): void;
114114
readonly removed: EventEmitter<MatChipEvent>;
115115
removeIcon: MatChipRemove;
116+
// @deprecated
116117
ripple: MatRipple;
117118
role: string | null;
118119
trailingIcon: MatChipTrailingIcon;

0 commit comments

Comments
 (0)