Skip to content

refactor(slider): change deprecated APIs for version 10 #19379

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 21, 2020
Merged

refactor(slider): change deprecated APIs for version 10 #19379

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/material/schematics/ng-update/data/constructor-checks.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ export const constructorChecks: VersionChanges<ConstructorChecksUpgradeData> = {
{
pr: 'https://github.com/angular/components/pull/19307',
changes: ['MatSlideToggle']
},
{
pr: 'https://github.com/angular/components/pull/19379',
changes: ['MatSlider']
}
],
[TargetVersion.V9]: [
Expand Down
65 changes: 21 additions & 44 deletions src/material/slider/slider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -490,26 +490,21 @@ export class MatSlider extends _MatSliderMixinBase
private _lastPointerEvent: MouseEvent | TouchEvent | null;

/** Used to subscribe to global move and end events */
protected _document?: Document;
protected _document: Document;

constructor(elementRef: ElementRef,
private _focusMonitor: FocusMonitor,
private _changeDetectorRef: ChangeDetectorRef,
@Optional() private _dir: Directionality,
@Attribute('tabindex') tabIndex: string,
// @breaking-change 8.0.0 `_animationMode` parameter to be made required.
@Optional() @Inject(ANIMATION_MODULE_TYPE) public _animationMode?: string,
// @breaking-change 9.0.0 `_ngZone` parameter to be made required.
private _ngZone?: NgZone,
/** @breaking-change 11.0.0 make document required */
@Optional() @Inject(DOCUMENT) document?: any) {
private _ngZone: NgZone,
@Inject(DOCUMENT) _document: any,
@Optional() @Inject(ANIMATION_MODULE_TYPE) public _animationMode?: string) {
super(elementRef);

this._document = document;

this._document = _document;
this.tabIndex = parseInt(tabIndex) || 0;

this._runOutsizeZone(() => {
_ngZone.runOutsideAngular(() => {
const element = elementRef.nativeElement;
element.addEventListener('mousedown', this._pointerDown, activeEventOptions);
element.addEventListener('touchstart', this._pointerDown, activeEventOptions);
Expand Down Expand Up @@ -629,7 +624,7 @@ export class MatSlider extends _MatSliderMixinBase
return;
}

this._runInsideZone(() => {
this._ngZone.run(() => {
const oldValue = this.value;
const pointerPosition = getPointerPositionOnPage(event);
this._isSliding = true;
Expand Down Expand Up @@ -700,7 +695,7 @@ export class MatSlider extends _MatSliderMixinBase

/** Use defaultView of injected document if available or fallback to global window reference */
private _getWindow(): Window {
return this._document?.defaultView || window;
return this._document.defaultView || window;
}

/**
Expand All @@ -712,17 +707,14 @@ export class MatSlider extends _MatSliderMixinBase
// Note that we bind the events to the `document`, because it allows us to capture
// drag cancel events where the user's pointer is outside the browser window.
const document = this._document;

if (typeof document !== 'undefined' && document) {
const isTouch = isTouchEvent(triggerEvent);
const moveEventName = isTouch ? 'touchmove' : 'mousemove';
const endEventName = isTouch ? 'touchend' : 'mouseup';
document.addEventListener(moveEventName, this._pointerMove, activeEventOptions);
document.addEventListener(endEventName, this._pointerUp, activeEventOptions);

if (isTouch) {
document.addEventListener('touchcancel', this._pointerUp, activeEventOptions);
}
const isTouch = isTouchEvent(triggerEvent);
const moveEventName = isTouch ? 'touchmove' : 'mousemove';
const endEventName = isTouch ? 'touchend' : 'mouseup';
document.addEventListener(moveEventName, this._pointerMove, activeEventOptions);
document.addEventListener(endEventName, this._pointerUp, activeEventOptions);

if (isTouch) {
document.addEventListener('touchcancel', this._pointerUp, activeEventOptions);
}

const window = this._getWindow();
Expand All @@ -735,14 +727,11 @@ export class MatSlider extends _MatSliderMixinBase
/** Removes any global event listeners that we may have added. */
private _removeGlobalEvents() {
const document = this._document;

if (typeof document !== 'undefined' && document) {
document.removeEventListener('mousemove', this._pointerMove, activeEventOptions);
document.removeEventListener('mouseup', this._pointerUp, activeEventOptions);
document.removeEventListener('touchmove', this._pointerMove, activeEventOptions);
document.removeEventListener('touchend', this._pointerUp, activeEventOptions);
document.removeEventListener('touchcancel', this._pointerUp, activeEventOptions);
}
document.removeEventListener('mousemove', this._pointerMove, activeEventOptions);
document.removeEventListener('mouseup', this._pointerUp, activeEventOptions);
document.removeEventListener('touchmove', this._pointerMove, activeEventOptions);
document.removeEventListener('touchend', this._pointerUp, activeEventOptions);
document.removeEventListener('touchcancel', this._pointerUp, activeEventOptions);

const window = this._getWindow();

Expand Down Expand Up @@ -869,18 +858,6 @@ export class MatSlider extends _MatSliderMixinBase
this._elementRef.nativeElement.blur();
}

/** Runs a callback inside of the NgZone, if possible. */
private _runInsideZone(fn: () => any) {
// @breaking-change 9.0.0 Remove this function once `_ngZone` is a required parameter.
this._ngZone ? this._ngZone.run(fn) : fn();
}

/** Runs a callback outside of the NgZone, if possible. */
private _runOutsizeZone(fn: () => any) {
// @breaking-change 9.0.0 Remove this function once `_ngZone` is a required parameter.
this._ngZone ? this._ngZone.runOutsideAngular(fn) : fn();
}

/**
* Sets the model value. Implemented as part of ControlValueAccessor.
* @param value
Expand Down
7 changes: 3 additions & 4 deletions tools/public_api_guard/material/slider.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ export declare const MAT_SLIDER_VALUE_ACCESSOR: any;

export declare class MatSlider extends _MatSliderMixinBase implements ControlValueAccessor, OnDestroy, CanDisable, CanColor, OnInit, HasTabIndex {
_animationMode?: string | undefined;
protected _document?: Document;
protected _document: Document;
get _invertAxis(): boolean;
_isActive: boolean;
get _isMinValue(): boolean;
Expand Down Expand Up @@ -46,8 +46,7 @@ export declare class MatSlider extends _MatSliderMixinBase implements ControlVal
readonly valueChange: EventEmitter<number | null>;
get vertical(): boolean;
set vertical(value: boolean);
constructor(elementRef: ElementRef, _focusMonitor: FocusMonitor, _changeDetectorRef: ChangeDetectorRef, _dir: Directionality, tabIndex: string, _animationMode?: string | undefined, _ngZone?: NgZone | undefined,
document?: any);
constructor(elementRef: ElementRef, _focusMonitor: FocusMonitor, _changeDetectorRef: ChangeDetectorRef, _dir: Directionality, tabIndex: string, _ngZone: NgZone, _document: any, _animationMode?: string | undefined);
_onBlur(): void;
_onFocus(): void;
_onKeydown(event: KeyboardEvent): void;
Expand All @@ -72,7 +71,7 @@ export declare class MatSlider extends _MatSliderMixinBase implements ControlVal
static ngAcceptInputType_value: NumberInput;
static ngAcceptInputType_vertical: BooleanInput;
static ɵcmp: i0.ɵɵComponentDefWithMeta<MatSlider, "mat-slider", ["matSlider"], { "disabled": "disabled"; "color": "color"; "tabIndex": "tabIndex"; "invert": "invert"; "max": "max"; "min": "min"; "step": "step"; "thumbLabel": "thumbLabel"; "tickInterval": "tickInterval"; "value": "value"; "displayWith": "displayWith"; "vertical": "vertical"; }, { "change": "change"; "input": "input"; "valueChange": "valueChange"; }, never, never>;
static ɵfac: i0.ɵɵFactoryDef<MatSlider, [null, null, null, { optional: true; }, { attribute: "tabindex"; }, { optional: true; }, null, { optional: true; }]>;
static ɵfac: i0.ɵɵFactoryDef<MatSlider, [null, null, null, { optional: true; }, { attribute: "tabindex"; }, null, null, { optional: true; }]>;
}

export declare class MatSliderChange {
Expand Down