fix(module:page-header): location inject error (#5013)

close #4945
NG-ZORRO · Apr 13, 2020 · 9073fa5 · 9073fa5
1 parent 9760238
commit 9073fa5
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 3 deletions.
diff --git a/components/page-header/doc/index.en-US.md b/components/page-header/doc/index.en-US.md
@@ -28,7 +28,7 @@ import { NzPageHeaderModule } from 'ng-zorro-antd/page-header';
 | `[nzTitle]` | Title string | `string \| TemplateRef<void>` | - | - |
 | `[nzSubtitle]` | SubTitle string | `string \| TemplateRef<void>` | - | - |
 | `[nzBackIcon]` | Custom back icon | `string \| TemplateRef<void>` | - | - |
-| `(nzBack)` | Back icon click event | `EventEmitter<void>` | Call [Location[back]](https://angular.io/api/common/Location#back) when the event not subscribed | - |
+| `(nzBack)` | Back icon click event | `EventEmitter<void>` | Call [Location[back]](https://angular.io/api/common/Location#back) when the event not subscribed（you need import [RouterModule](https://angular.io/api/router/RouterModule) or register [Location](https://angular.io/api/common/Location)）| - |
 
 ### Page header sections
 | Element | Description |

diff --git a/components/page-header/doc/index.zh-CN.md b/components/page-header/doc/index.zh-CN.md
@@ -29,7 +29,7 @@ import { NzPageHeaderModule } from 'ng-zorro-antd/page-header';
 | `[nzTitle]` | title 文字 | `string \| TemplateRef<void>` | - | - |
 | `[nzSubtitle]` | subTitle 文字 | `string \| TemplateRef<void>` | - | - |
 | `[nzBackIcon]` | 自定义 back icon | `string \| TemplateRef<void>` | - | - |
-| `(nzBack)` | 返回按钮的点击事件 | `EventEmitter<void>` | 未订阅该事件时默认调用 [Location[back]](https://angular.cn/api/common/Location#back) | - |
+| `(nzBack)` | 返回按钮的点击事件 | `EventEmitter<void>` | 未订阅该事件时默认调用 [Location[back]](https://angular.cn/api/common/Location#back)（需要引入 [RouterModule](https://angular.io/api/router/RouterModule) 或者注册 [Location](https://angular.io/api/common/Location))）| - |
 
 ### Page header 组成部分
 | 元素 | 说明 |

diff --git a/components/page-header/page-header.component.ts b/components/page-header/page-header.component.ts
@@ -14,6 +14,7 @@ import {
   EventEmitter,
   Input,
   OnChanges,
+  Optional,
   Output,
   SimpleChanges,
   TemplateRef,
@@ -22,6 +23,7 @@ import {
 
 import { Location } from '@angular/common';
 import { NzConfigService, WithConfig } from 'ng-zorro-antd/core/config';
+import { PREFIX } from 'ng-zorro-antd/core/logger';
 import { NzPageHeaderBreadcrumbDirective, NzPageHeaderFooterDirective } from './page-header-cells';
 
 const NZ_CONFIG_COMPONENT_NAME = 'pageHeader';
@@ -82,7 +84,7 @@ export class NzPageHeaderComponent implements OnChanges {
 
   @ContentChild(NzPageHeaderBreadcrumbDirective, { static: false }) nzPageHeaderBreadcrumb: ElementRef<NzPageHeaderBreadcrumbDirective>;
 
-  constructor(private location: Location, public nzConfigService: NzConfigService) {}
+  constructor(@Optional() private location: Location, public nzConfigService: NzConfigService) {}
 
   ngOnChanges(changes: SimpleChanges): void {
     if (changes.hasOwnProperty('nzBackIcon')) {
@@ -95,6 +97,9 @@ export class NzPageHeaderComponent implements OnChanges {
     if (this.nzBack.observers.length) {
       this.nzBack.emit();
     } else {
+      if (!this.location) {
+        throw new Error(`${PREFIX} you should import 'RouterModule' or register 'Location' if you want to use 'nzBack' default event!`);
+      }
       this.location.back();
     }
   }