Sfoglia il codice sorgente

chore: miss getFormProps type defination in BaseFormApi (#2367)

YyumeiZhang 1 anno fa
parent
commit
0795ac8fbf

+ 1 - 1
content/input/form/index.md

@@ -2107,7 +2107,7 @@ FormState 存储了所有 Form 内部的状态值,包括各表单控件的值
 
 | Function      | 说明                                                                                                                                                                                                                             | example                                                                                                             |
 | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |---------------------------------------------------------------------------------------------------------------------|
-| getFormProps  | 获取 Form 组件上当前所有props的值,例如可用于读取 disabled 等。v 2.57.0 后提供                                                    | formApi.getProps(propNames?: string[])                                                                                              |
+| getFormProps  | 获取 Form 组件上当前所有props的值,例如可用于读取 disabled 等。v 2.57.0 后提供                                                    | formApi.getFormProps(propNames?: string[])                                                                                              |
 | getFormState  | 获取 FormState                                                                                                                                                                                                                   | formApi.getFormState()                                                                                              |
 | submitForm    | 可手动触发 submit 提交操作                                                                                                                                                                                                       | formApi.submitForm()                                                                                                |
 | reset         | 可手动对 form 进行重置                                                                                                                                                                                                           | formApi.reset(fields?: Array <string\>)                                                                             |

+ 2 - 0
packages/semi-foundation/form/interface.ts

@@ -87,6 +87,8 @@ export interface BaseFormApi<T extends object = any> {
     getFieldExist: <K extends keyof T>(field: K) => boolean;
     /** get formState of form */
     getFormState: () => FormState<T extends object ? T : object>;
+    /** get formProps of form */
+    getFormProps: (keys?: Array<string>) => ComponentProps;
     /** submit form manual */
     submitForm: () => void;
     /** reset form manual */