From 24d12be5876fb4495aba06a7ed3022d926208f5b Mon Sep 17 00:00:00 2001 From: Janry Date: Wed, 17 Jul 2019 13:30:58 +0800 Subject: [PATCH] fix(docs): fix docs without display property description (#176) --- docs/API/createAsyncFormActions.md | 1 + docs/API/createForm.md | 29 +++++++++++++++-------------- docs/API/createFormActions.md | 29 +++++++++++++++-------------- 3 files changed, 31 insertions(+), 28 deletions(-) diff --git a/docs/API/createAsyncFormActions.md b/docs/API/createAsyncFormActions.md index afdbc4970bb..5b3186620cf 100644 --- a/docs/API/createAsyncFormActions.md +++ b/docs/API/createAsyncFormActions.md @@ -63,6 +63,7 @@ interface IFieldState{ valid : boolean //字段是否合法 invalid : boolean //字段是否非法 visible : boolean //字段显示状态 + display : boolean //字段UI展示状态，与visible的差别是，visible会删值，display不会删值 editable : boolean //字段是否可编辑 loading : boolean //字段加载状态 errors : string[] //字段错误消息集合 diff --git a/docs/API/createForm.md b/docs/API/createForm.md index 9b8d7d883c3..3646ebfa162 100644 --- a/docs/API/createForm.md +++ b/docs/API/createForm.md @@ -130,20 +130,21 @@ interface IFormState { 用于描述表单字段状态的模型对象 ```typescript -interface IFieldState { - value: V //字段值 - valid: boolean //字段是否合法 - invalid: boolean //字段是否非法 - visible: boolean //字段显示状态 - editable: boolean //字段是否可编辑 - loading: boolean //字段加载状态 - errors: string[] //字段错误消息集合 - pristine: boolean //字段是否处于原始态 - initialValue: V //字段初始值 - name: string //字段路径 - path: string[] //字段路径，数组形式 - props: ISchema //字段附加属性 - rules: IRuleDescription[] //字段校验规则 +interface IFieldState{ + value : V //字段值 + valid : boolean //字段是否合法 + invalid : boolean //字段是否非法 + visible : boolean //字段显示状态 + display : boolean //字段UI展示状态，与visible的差别是，visible会删值，display不会删值 + editable : boolean //字段是否可编辑 + loading : boolean //字段加载状态 + errors : string[] //字段错误消息集合 + pristine : boolean //字段是否处于原始态 + initialValue: V //字段初始值 + name : string //字段路径 + path : string[] //字段路径，数组形式 + props : ISchema //字段附加属性 + rules : IRuleDescription[] //字段校验规则 } ``` diff --git a/docs/API/createFormActions.md b/docs/API/createFormActions.md index 387ab376595..4ac8da72dcd 100644 --- a/docs/API/createFormActions.md +++ b/docs/API/createFormActions.md @@ -57,20 +57,21 @@ interface IFormState { 用于描述表单字段状态的模型对象 ```typescript -interface IFieldState { - value: V //字段值 - valid: boolean //字段是否合法 - invalid: boolean //字段是否非法 - visible: boolean //字段显示状态 - editable: boolean //字段是否可编辑 - loading: boolean //字段加载状态 - errors: string[] //字段错误消息集合 - pristine: boolean //字段是否处于原始态 - initialValue: V //字段初始值 - name: string //字段路径 - path: string[] //字段路径，数组形式 - props: ISchema //字段附加属性 - rules: IRuleDescription[] //字段校验规则 +interface IFieldState{ + value : V //字段值 + valid : boolean //字段是否合法 + invalid : boolean //字段是否非法 + visible : boolean //字段显示状态 + display : boolean //字段UI展示状态，与visible的差别是，visible会删值，display不会删值 + editable : boolean //字段是否可编辑 + loading : boolean //字段加载状态 + errors : string[] //字段错误消息集合 + pristine : boolean //字段是否处于原始态 + initialValue: V //字段初始值 + name : string //字段路径 + path : string[] //字段路径，数组形式 + props : ISchema //字段附加属性 + rules : IRuleDescription[] //字段校验规则 } ```