docs(module:calendar): fix calendar doc (NG-ZORRO#2973)

Ricbet · Apr 9, 2020 · de84893 · de84893
1 parent b4c5674
commit de84893
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 17 deletions.
diff --git a/components/calendar/demo/card.ts b/components/calendar/demo/card.ts
@@ -4,7 +4,7 @@ import { Component } from '@angular/core';
   selector: 'nz-demo-calendar-card',
   template: `
     <div [ngStyle]="{ width: '300px', border: '1px solid #d9d9d9', borderRadius: '4px' }">
-      <nz-calendar nzCard (nzValueChange)="onValueChange($event)" (nzModeChange)="onModeChange($event)"></nz-calendar>
+      <nz-calendar nzCard (nzSelectChange)="onValueChange($event)" (nzPanelChange)="onPanelChange($event)"></nz-calendar>
     </div>
   `
 })
@@ -13,7 +13,8 @@ export class NzDemoCalendarCardComponent {
     console.log(`Current value: ${value}`);
   }
 
-  onModeChange(mode: 'month'|'year'): void {
-    console.log(`Current mode: ${mode}`);
+  onPanelChange(change: {date: Date, mode: string}): void {
+    console.log(`Current value: ${change.date}`);
+    console.log(`Current mode: ${change.mode}`);
   }
 }
diff --git a/components/calendar/demo/select.ts b/components/calendar/demo/select.ts
@@ -5,8 +5,7 @@ import { Component } from '@angular/core';
   template: `
     <nz-alert nzMessage="Your selected date: {{ selectedValue | date:'yyyy-MM-dd' }}"></nz-alert>
     <nz-calendar [(ngModel)]="selectedValue"
-      (selectChange)="selectChange($event)"
-      (nzValueChange)="valueChange($event)"
+      (nzSelectChange)="selectChange($event)"
     ></nz-calendar>
   `
 })
@@ -16,8 +15,4 @@ export class NzDemoCalendarSelectComponent {
   selectChange(select: Date): void {
     console.log(`Select value: ${select}`);
   }
-
-  valueChange(value: Date): void {
-    console.log(`Current value: ${value}`);
-  }
 }
diff --git a/components/calendar/doc/index.en-US.md b/components/calendar/doc/index.en-US.md
@@ -28,8 +28,7 @@ registerLocaleData(en);
   [(ngModel)]="selectedDate"
   [(nzMode)]="mode"
   (nzPanelChange)="panelChange($event)"
-  (nzSelectChange)="selectChange($event)"
-  (nzValueChange)="valueChange($event)">
+  (nzSelectChange)="selectChange($event)">
   <!-- Another method for cell definition -->
   <div *nzDateCell>Foo</div>
 </nz-calendar>
@@ -50,5 +49,3 @@ registerLocaleData(en);
 | `[nzMonthCell]` | (Contentable) Customize the display of the month cell, the template content will be appended to the cell | `TemplateRef<Date>` | - |
 | `[nzMonthFullCell]` | (Contentable) Customize the display of the month cell, the template content will override the cell | `TemplateRef<Date>` | - |
 | `(nzPanelChange)` | Callback for when panel changes | `EventEmitter<{ date: Date, mode: 'month'｜'year' }>` | - |
-| `(nzSelectChange)` | Callback for when a date is selected | `EventEmitter<Date>` | - |
-| `(nzValueChange)` | Callback for when date changes | `EventEmitter<Date>` | - |
diff --git a/components/calendar/doc/index.zh-CN.md b/components/calendar/doc/index.zh-CN.md
@@ -17,7 +17,7 @@ title: Calendar
 **注意：**Calendar 的部分 locale 来自于 Angular 自身的国际化支持，需要在 app.module.ts 文件中 引入相应的 Angular 语言包。
 
 例如：
-```typescript	
+```typescript
 import { registerLocaleData } from '@angular/common';
 import zh from '@angular/common/locales/zh';
 registerLocaleData(zh);
@@ -29,8 +29,7 @@ registerLocaleData(zh);
   [(ngModel)]="selectedDate"
   [(nzMode)]="mode"
   (nzPanelChange)="panelChange($event)"
-  (nzSelectChange)="selectChange($event)"
-  (nzValueChange)="valueChange($event)">
+  (nzSelectChange)="selectChange($event)">
   <!-- 定义 Cell 的另一种方式 -->
   <div *dateCell>Foo</div>
 </nz-calendar>
@@ -52,4 +51,3 @@ registerLocaleData(zh);
 | `[nzMonthFullCell]` | （可作为内容）自定义渲染月单元格，模版内容覆盖单元格 | `TemplateRef<Date>` | - |
 | `(nzPanelChange)` | 面板变化的回调 | `EventEmitter<{ date: Date, mode: 'month'｜'year' }>` | - |
 | `(nzSelectChange)` | 选择日期的回调 | `EventEmitter<Date>` | - |
-| `(nzValueChange)` | 日期变化的回调 | `EventEmitter<Date>` | - |