refactor(module:anchor): remove deprecated APIs for v10 (#5776)

BREAKING CHANGES: - `nzTarget` has been removed, use `nzContainer` instead.
NG-ZORRO · Sep 15, 2020 · e50d530 · e50d530
1 parent 7e64e4c
commit e50d530
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 13 deletions.
diff --git a/components/anchor/anchor.component.ts b/components/anchor/anchor.component.ts
@@ -24,7 +24,6 @@ import {
   ViewEncapsulation
 } from '@angular/core';
 import { NzConfigKey, NzConfigService, WithConfig } from 'ng-zorro-antd/core/config';
-import { warnDeprecation } from 'ng-zorro-antd/core/logger';
 import { NzScrollService } from 'ng-zorro-antd/core/services';
 import { BooleanInput, NgStyleInterface, NumberInput, NzSafeAny } from 'ng-zorro-antd/core/types';
 import { InputBoolean, InputNumber } from 'ng-zorro-antd/core/util';
@@ -91,7 +90,6 @@ export class NzAnchorComponent implements OnDestroy, AfterViewInit, OnChanges {
   nzOffsetTop?: number = undefined;
 
   @Input() nzContainer?: string | HTMLElement;
-  @Input() nzTarget: string | HTMLElement = '';
 
   @Output() readonly nzClick = new EventEmitter<string>();
   @Output() readonly nzScroll = new EventEmitter<NzAnchorLinkComponent>();
@@ -234,19 +232,16 @@ export class NzAnchorComponent implements OnDestroy, AfterViewInit, OnChanges {
   }
 
   ngOnChanges(changes: SimpleChanges): void {
-    const { nzOffsetTop, nzTarget, nzContainer } = changes;
+    const { nzOffsetTop, nzContainer } = changes;
     if (nzOffsetTop) {
       this.wrapperStyle = {
         'max-height': `calc(100vh - ${this.nzOffsetTop}px)`
       };
     }
-    if (nzContainer || nzTarget) {
-      const container = this.nzContainer || this.nzTarget;
+    if (nzContainer) {
+      const container = this.nzContainer;
       this.container = typeof container === 'string' ? this.doc.querySelector(container) : container;
       this.registerScrollEvent();
-      if (nzTarget) {
-        warnDeprecation(`'nzTarget' of 'nz-anchor' is deprecated and will be removed in 10.0.0.Please use 'nzContainer' instead.`);
-      }
     }
   }
 }
diff --git a/components/anchor/anchor.spec.ts b/components/anchor/anchor.spec.ts
@@ -152,18 +152,18 @@ describe('anchor', () => {
       });
     });
 
-    describe('[nzTarget]', () => {
+    describe('[nzContainer]', () => {
       it('with window', () => {
         spyOn(window, 'addEventListener');
-        context.nzTarget = window;
+        context.nzContainer = window;
         fixture.detectChanges();
         expect(window.addEventListener).toHaveBeenCalled();
       });
       it('with string', () => {
         spyOn(context, '_click');
         const el = document.querySelector('#target')!;
         spyOn(el, 'addEventListener');
-        context.nzTarget = '#target';
+        context.nzContainer = '#target';
         fixture.detectChanges();
         expect(el.addEventListener).toHaveBeenCalled();
         page.to('#basic-target');
@@ -235,7 +235,7 @@ describe('anchor', () => {
       [nzBounds]="nzBounds"
       [nzShowInkInFixed]="nzShowInkInFixed"
       [nzOffsetTop]="nzOffsetTop"
-      [nzTarget]="nzTarget"
+      [nzContainer]="nzContainer"
       (nzClick)="_click($event)"
       (nzScroll)="_scroll($event)"
     >
@@ -291,7 +291,7 @@ export class TestComponent {
   nzBounds = 5;
   nzOffsetTop = 0;
   nzShowInkInFixed = false;
-  nzTarget: any = null;
+  nzContainer: any = null;
   _click() {}
   _scroll() {}
 }
diff --git a/schematics/ng-update/data/input-names.ts b/schematics/ng-update/data/input-names.ts
@@ -15,6 +15,20 @@ export const inputNames: VersionChanges<InputNameUpgradeData> = {
       ]
     }
   ],
+  [ TargetVersion.V10 ]: [
+    {
+      pr: 'https://github.com/NG-ZORRO/ng-zorro-antd/pull/5776',
+      changes: [
+        {
+          replace    : 'nzTarget',
+          replaceWith: 'nzContainer',
+          whitelist  : {
+            elements: [ 'nz-anchor' ]
+          }
+        }
+      ]
+    }
+  ],
   [ TargetVersion.V9 ]: [
     {
       pr     : 'https://github.com/NG-ZORRO/ng-zorro-antd/pull/3909',