docs(abc:date-picker): update (#760)

ng-alain · Dec 30, 2019 · 4ed2c38 · 4ed2c38
1 parent a7ab84a
commit 4ed2c38
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 5 deletions.
diff --git a/packages/abc/date-picker/date-picker.config.ts b/packages/abc/date-picker/date-picker.config.ts
@@ -2,13 +2,13 @@ import { Injectable } from '@angular/core';
 import { getTimeDistance } from '@delon/util';
 
 export class DateRangePickerConfig {
-  nzFormat = 'yyyy-MM-dd';
+  nzFormat?: string = 'yyyy-MM-dd';
   nzClassName?: string;
   nzSize?: string;
   nzStyle?: string;
-  nzAllowClear = true;
-  nzAutoFocus = false;
-  nzDisabled = false;
+  nzAllowClear?: boolean = true;
+  nzAutoFocus?: boolean = false;
+  nzDisabled?: boolean = false;
   nzDisabledDate?: any;
   nzDisabledTime?: any;
   nzLocale?: any;
@@ -17,7 +17,7 @@ export class DateRangePickerConfig {
   nzRenderExtraFooter?: any;
   nzPlaceHolder?: any;
   nzShowTime?: any;
-  nzShowToday = true;
+  nzShowToday?: boolean = true;
   nzMode?: any;
   nzRanges?: any;
   shortcuts?: DateRangePickerShortcut = {

diff --git a/packages/abc/date-picker/index.en-US.md b/packages/abc/date-picker/index.en-US.md
@@ -9,6 +9,10 @@ config: DateRangePickerConfig
 
 Based on the `nz-range-picker` further optimization, better service to start and end dates.
 
+## Note
+
+If using date-fns, muse be modify the default `nzFormat` to` YYYY-MM-DD`.
+
 ## API
 
 ### range-picker

diff --git a/packages/abc/date-picker/index.zh-CN.md b/packages/abc/date-picker/index.zh-CN.md
@@ -9,6 +9,10 @@ config: DateRangePickerConfig
 
 基于 `nz-range-picker` 进一步优化，更好的服务于开始与结束日期。
 
+## 注意
+
+如果采用 date-fns 务必修改默认 `nzFormat` 值为 `YYYY-MM-DD`。
+
 ## API
 
 ### range-picker