vue-form-craft 4.3.1 → 4.4.0

package/dist/index.d.ts

@@ -2,125 +2,14 @@ import { App } from 'vue';
 import { Component } from 'vue';
 import { ComponentOptionsMixin } from 'vue';
 import { ComponentProvideOptions } from 'vue';
-import { DeepReadonly } from 'vue';
 import { DefineComponent } from 'vue';
 import { ExtractPropTypes } from 'vue';
 import { FormValidationResult } from 'element-plus';
 import { PropType } from 'vue';
 import { PublicProps } from 'vue';
-import { Ref } from 'vue';
-import { ToRefs } from 'vue';
-import { UnwrapNestedRefs } from 'vue';
 import { VNode } from 'vue';
 
-export declare type $Global = {
-    request?: (options: Record<string, any>) => Promise<Record<string, any>>;
-    elements: Record<string, FormElement>;
-};
-
-declare type __VLS_WithTemplateSlots<T, S> = T & {
-    new (): {
-        $slots: S;
-    };
-};
-
-declare const _default: {
-    install: (app: App<Element>, options?: {
-        request?: ((options: Record<string, any>) => Promise<Record<string, any>>) | undefined;
-        extendElements?: Record<string, FormElement> | undefined;
-        lang?: "en" | "zh" | undefined;
-    } | undefined) => void;
-};
-export default _default;
-
-declare type FormChange = {
-    target: string;
-    value?: any;
-    condition?: any;
-};
-
-export declare const FormDesign: DefineComponent<ExtractPropTypes<    {
-modelValue: PropType<FormSchema>;
-schemaContext: {
-type: PropType<Record<string, any>>;
-default: () => {};
-};
-templates: {
-type: PropType<TemplateData>;
-};
-omitMenus: {
-type: PropType<string[]>;
-};
-}>, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
-add: (element: FormElement) => void;
-save: () => void;
-onSave: () => void;
-}, string, PublicProps, Readonly<ExtractPropTypes<    {
-modelValue: PropType<FormSchema>;
-schemaContext: {
-type: PropType<Record<string, any>>;
-default: () => {};
-};
-templates: {
-type: PropType<TemplateData>;
-};
-omitMenus: {
-type: PropType<string[]>;
-};
-}>> & Readonly<{
-onAdd?: ((element: FormElement) => any) | undefined;
-onSave?: (() => any) | undefined;
-onOnSave?: (() => any) | undefined;
-}>, {
-schemaContext: Record<string, any>;
-}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
-
-export declare type FormElement = {
-    name: string;
-    component: string | VNode | Component;
-    icon: string | VNode | Component;
-    type: 'assist' | 'layout' | 'basic' | 'highBasic';
-    order: number;
-    initialValues: Omit<FormItemType, 'name'>;
-    modelName?: string;
-    attrSchema: FormSchema;
-};
-
-export declare type FormInstance = DeepReadonly<UnwrapNestedRefs<FormInstanceSource>>;
-
-declare interface FormInstanceSource extends ToRefs<FormRenderProps> {
-    formValues: Ref<Record<string, any>>;
-    selectData: Record<string, Record<string, any>>;
-    initialValues: Record<string, Record<string, any>>;
-    context: Ref<Record<string, any>>;
-    updateFormValues: (values: Record<string, any>) => void;
-    updateSelectData: (key: string, value: Record<string, any>) => void;
-    updateInitialValues: (values: Record<string, any>) => void;
-    validate: () => FormValidationResult | undefined;
-    resetFields: (names?: string[]) => void;
-    submit: () => Promise<void>;
-}
-
-export declare interface FormItemType {
-    label?: string;
-    name: string;
-    component: string;
-    required?: boolean;
-    props?: Record<string, any>;
-    initialValue?: any;
-    help?: string;
-    children?: FormItemType[];
-    hidden?: boolean | string;
-    hideLabel?: boolean;
-    designKey?: string;
-    rules?: FormRule[];
-    class?: any;
-    style?: any;
-    change?: FormChange[];
-    dialog?: boolean;
-}
-
-export declare const FormRender: __VLS_WithTemplateSlots<DefineComponent<ExtractPropTypes<    {
+declare const __VLS_component: DefineComponent<ExtractPropTypes<    {
 modelValue: PropType<Record<string, any>>;
 schema: {
 type: PropType<FormSchema>;
@@ -198,16 +87,17 @@ updateFormValues: (values: Record<string, any>) => void;
 updateSelectData: (key: string, value: Record<string, any>) => void;
 updateInitialValues: (values: Record<string, any>) => void;
 validate: () => FormValidationResult | undefined;
-resetFields: (names?: string[] | undefined) => void;
+resetFields: (names?: string[]) => void;
 submit: () => Promise<void>;
 schema: {
 readonly labelWidth?: number | undefined;
-readonly labelAlign?: "top" | "left" | "right" | undefined;
+readonly labelAlign?: ("top" | "left" | "right") | undefined;
 readonly labelSuffix?: string | undefined;
-readonly size?: "default" | "small" | "large" | undefined;
+readonly size?: ("default" | "small" | "large") | undefined;
 readonly disabled?: boolean | undefined;
 readonly hideRequiredAsterisk?: boolean | undefined;
 readonly labelBold?: boolean | undefined;
+readonly scrollToError?: boolean | undefined;
 readonly items: readonly {
 readonly label?: string | undefined;
 readonly name: string;
@@ -219,11 +109,11 @@ readonly [x: string]: any;
 readonly initialValue?: any;
 readonly help?: string | undefined;
 readonly children?: readonly any[] | undefined;
-readonly hidden?: string | boolean | undefined;
+readonly hidden?: (boolean | string) | undefined;
 readonly hideLabel?: boolean | undefined;
 readonly designKey?: string | undefined;
 readonly rules?: readonly {
-readonly type: string;
+readonly type: "email" | "url" | "custom" | string;
 readonly customReg?: string | undefined;
 readonly message?: string | undefined;
 readonly trigger: "blur" | "change";
@@ -266,9 +156,1157 @@ type: PropType<boolean>;
 };
 }>> & Readonly<{
 onOnFinish?: ((values: Record<string, any>) => any) | undefined;
-}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>, {
+}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+
+declare function __VLS_template(): {
     default?(_: {}): any;
-}>;
+};
+
+declare type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+
+declare const _default: {
+    install: (app: App<Element>, options?: Options) => void;
+};
+export default _default;
+
+declare type FormChange = {
+    target: string;
+    value?: any;
+    condition?: any;
+};
+
+export declare const FormDesign: DefineComponent<ExtractPropTypes<    {
+modelValue: PropType<FormSchema>;
+schemaContext: {
+type: PropType<Record<string, any>>;
+default: () => {};
+};
+templates: {
+type: PropType<TemplateData>;
+default: () => ({
+name: string;
+schema: {
+labelWidth: number;
+labelAlign: "right";
+size: "default";
+items: ({
+label: string;
+component: string;
+props: {
+placeholder: string;
+autosize?: undefined;
+mode?: undefined;
+options?: undefined;
+optionType?: undefined;
+space?: undefined;
+labelKey?: undefined;
+valueKey?: undefined;
+api?: undefined;
+width?: undefined;
+height?: undefined;
+action?: undefined;
+fileTypes?: undefined;
+size?: undefined;
+uploadKey?: undefined;
+dataPath?: undefined;
+};
+designKey: string;
+name: string;
+required: true;
+} | {
+label: string;
+component: string;
+props: {
+autosize: {
+minRows: number;
+maxRows: number;
+};
+placeholder: string;
+mode?: undefined;
+options?: undefined;
+optionType?: undefined;
+space?: undefined;
+labelKey?: undefined;
+valueKey?: undefined;
+api?: undefined;
+width?: undefined;
+height?: undefined;
+action?: undefined;
+fileTypes?: undefined;
+size?: undefined;
+uploadKey?: undefined;
+dataPath?: undefined;
+};
+designKey: string;
+name: string;
+required?: undefined;
+} | {
+label: string;
+component: string;
+props: {
+mode: string;
+options: {
+label: string;
+value: string;
+}[];
+optionType: string;
+space: number;
+labelKey: string;
+valueKey: string;
+api: {
+url: string;
+dataPath: string;
+method: string;
+params: {};
+data: {};
+};
+placeholder?: undefined;
+autosize?: undefined;
+width?: undefined;
+height?: undefined;
+action?: undefined;
+fileTypes?: undefined;
+size?: undefined;
+uploadKey?: undefined;
+dataPath?: undefined;
+};
+designKey: string;
+name: string;
+required: true;
+} | {
+label: string;
+component: string;
+props: {
+mode: string;
+options: {
+name: string;
+value: number;
+}[];
+optionType: string;
+space: number;
+labelKey: string;
+valueKey: string;
+placeholder?: undefined;
+autosize?: undefined;
+api?: undefined;
+width?: undefined;
+height?: undefined;
+action?: undefined;
+fileTypes?: undefined;
+size?: undefined;
+uploadKey?: undefined;
+dataPath?: undefined;
+};
+designKey: string;
+name: string;
+required: true;
+} | {
+label: string;
+component: string;
+props: {
+width: number;
+height: number;
+action: string;
+fileTypes: string[];
+size: number;
+uploadKey: string;
+dataPath: string;
+placeholder?: undefined;
+autosize?: undefined;
+mode?: undefined;
+options?: undefined;
+optionType?: undefined;
+space?: undefined;
+labelKey?: undefined;
+valueKey?: undefined;
+api?: undefined;
+};
+designKey: string;
+name: string;
+required?: undefined;
+} | {
+label: string;
+component: string;
+designKey: string;
+name: string;
+required: true;
+props?: undefined;
+})[];
+};
+id: string;
+} | {
+name: string;
+schema: {
+labelWidth: number;
+labelAlign: "right";
+size: "default";
+items: ({
+label: string;
+name: string;
+component: string;
+props: {
+'inline-prompt': boolean;
+mode?: undefined;
+};
+designKey: string;
+change: {
+target: string;
+condition: string;
+value: number;
+}[];
+children?: undefined;
+} | {
+label: string;
+component: string;
+children: ({
+label: string;
+component: string;
+props: {
+placeholder: string;
+'inline-prompt'?: undefined;
+'active-value'?: undefined;
+'inactive-value'?: undefined;
+};
+designKey: string;
+name: string;
+change: {
+target: string;
+condition: string;
+value: number;
+}[];
+} | {
+label: string;
+component: string;
+props: {
+placeholder: string;
+'inline-prompt'?: undefined;
+'active-value'?: undefined;
+'inactive-value'?: undefined;
+};
+designKey: string;
+name: string;
+change?: undefined;
+} | {
+label: string;
+component: string;
+designKey: string;
+name: string;
+props: {
+'inline-prompt': boolean;
+'active-value': number;
+'inactive-value': number;
+placeholder?: undefined;
+};
+change?: undefined;
+})[];
+props: {
+mode: string;
+'inline-prompt'?: undefined;
+};
+designKey: string;
+name: string;
+change?: undefined;
+})[];
+};
+id: string;
+} | {
+name: string;
+schema: {
+labelWidth: number;
+labelAlign: "right";
+size: "default";
+items: ({
+label: string;
+component: string;
+props: {
+max: number;
+'allow-half': boolean;
+autocomplete?: undefined;
+showWordLimit?: undefined;
+type?: undefined;
+autosize?: undefined;
+placeholder?: undefined;
+};
+designKey: string;
+name: string;
+required: true;
+hidden?: undefined;
+} | {
+label: string;
+component: string;
+props: {
+autocomplete: string;
+showWordLimit: boolean;
+type: string;
+autosize: {
+minRows: number;
+maxRows: number;
+};
+placeholder: string;
+max?: undefined;
+'allow-half'?: undefined;
+};
+designKey: string;
+name: string;
+hidden: string;
+required?: undefined;
+})[];
+};
+id: string;
+} | {
+name: string;
+schema: {
+labelWidth: number;
+labelAlign: "right";
+size: "default";
+items: ({
+label: string;
+component: string;
+props: {
+mode: string;
+options: {
+name: string;
+id: number;
+}[];
+labelKey: string;
+valueKey: string;
+optionType: string;
+space: number;
+placeholder?: undefined;
+api?: undefined;
+direction?: undefined;
+};
+name: string;
+required: true;
+designKey: string;
+hidden?: undefined;
+} | {
+label: string;
+component: string;
+props: {
+mode: string;
+placeholder: string;
+labelKey: string;
+valueKey: string;
+api: {
+url: string;
+method: string;
+params: {
+filters: {
+category: string;
+};
+};
+dataPath: string;
+};
+optionType: string;
+direction: string;
+space: number;
+options?: undefined;
+};
+name: string;
+required: true;
+hidden: string;
+designKey: string;
+})[];
+};
+id: string;
+} | {
+name: string;
+schema: {
+labelWidth: number;
+labelAlign: "right";
+size: "default";
+items: ({
+label: string;
+component: string;
+props: {
+mode: string;
+options: {
+name: string;
+id: string;
+price: number;
+}[];
+placeholder: string;
+labelKey: string;
+valueKey: string;
+min?: undefined;
+max?: undefined;
+step?: undefined;
+unit?: undefined;
+disabled?: undefined;
+controlsPosition?: undefined;
+};
+designKey: string;
+name: string;
+change: {
+target: string;
+value: string;
+}[];
+} | {
+label: string;
+component: string;
+designKey: string;
+name: string;
+props: {
+min: number;
+max: number;
+step: number;
+unit: string;
+disabled: boolean;
+controlsPosition: string;
+mode?: undefined;
+options?: undefined;
+placeholder?: undefined;
+labelKey?: undefined;
+valueKey?: undefined;
+};
+change?: undefined;
+})[];
+};
+id: string;
+} | {
+name: string;
+schema: {
+labelWidth: number;
+labelAlign: "right";
+size: "default";
+items: ({
+label: string;
+component: string;
+props: {
+mode: string;
+options: {
+label: string;
+value: string;
+vv: string;
+}[];
+labelKey: string;
+valueKey: string;
+optionType: string;
+direction: string;
+space: number;
+placeholder?: undefined;
+};
+designKey: string;
+name: string;
+change: {
+target: string;
+value: string;
+}[];
+} | {
+label: string;
+component: string;
+props: {
+placeholder: string;
+mode?: undefined;
+options?: undefined;
+labelKey?: undefined;
+valueKey?: undefined;
+optionType?: undefined;
+direction?: undefined;
+space?: undefined;
+};
+designKey: string;
+name: string;
+change?: undefined;
+})[];
+};
+id: string;
+} | {
+name: string;
+schema: {
+labelWidth: number;
+labelAlign: "right";
+size: "default";
+items: {
+label: string;
+component: string;
+props: {
+placeholder: string;
+};
+designKey: string;
+name: string;
+}[];
+};
+id: string;
+} | {
+name: string;
+schema: {
+labelWidth: number;
+labelAlign: "right";
+size: "default";
+items: ({
+label: string;
+component: string;
+props: {
+placeholder: string;
+'inline-prompt'?: undefined;
+header?: undefined;
+};
+designKey: string;
+name: string;
+children?: undefined;
+} | {
+label: string;
+component: string;
+props: {
+'inline-prompt': boolean;
+placeholder?: undefined;
+header?: undefined;
+};
+designKey: string;
+name: string;
+children?: undefined;
+} | {
+component: string;
+children: ({
+label: string;
+component: string;
+props: {
+placeholder: string;
+mode?: undefined;
+options?: undefined;
+labelKey?: undefined;
+valueKey?: undefined;
+optionType?: undefined;
+direction?: undefined;
+space?: undefined;
+};
+designKey: string;
+name: string;
+} | {
+label: string;
+component: string;
+props: {
+mode: string;
+options: {
+label: string;
+value: string;
+}[];
+labelKey: string;
+valueKey: string;
+optionType: string;
+direction: string;
+space: number;
+placeholder?: undefined;
+};
+designKey: string;
+name: string;
+})[];
+props: {
+header: string;
+placeholder?: undefined;
+'inline-prompt'?: undefined;
+};
+designKey: string;
+name: string;
+label?: undefined;
+})[];
+};
+id: string;
+})[];
+};
+omitMenus: {
+type: PropType<string[]>;
+default: () => never[];
+};
+}>, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+add: (element: FormElement) => void;
+save: () => void;
+onSave: () => void;
+}, string, PublicProps, Readonly<ExtractPropTypes<    {
+modelValue: PropType<FormSchema>;
+schemaContext: {
+type: PropType<Record<string, any>>;
+default: () => {};
+};
+templates: {
+type: PropType<TemplateData>;
+default: () => ({
+name: string;
+schema: {
+labelWidth: number;
+labelAlign: "right";
+size: "default";
+items: ({
+label: string;
+component: string;
+props: {
+placeholder: string;
+autosize?: undefined;
+mode?: undefined;
+options?: undefined;
+optionType?: undefined;
+space?: undefined;
+labelKey?: undefined;
+valueKey?: undefined;
+api?: undefined;
+width?: undefined;
+height?: undefined;
+action?: undefined;
+fileTypes?: undefined;
+size?: undefined;
+uploadKey?: undefined;
+dataPath?: undefined;
+};
+designKey: string;
+name: string;
+required: true;
+} | {
+label: string;
+component: string;
+props: {
+autosize: {
+minRows: number;
+maxRows: number;
+};
+placeholder: string;
+mode?: undefined;
+options?: undefined;
+optionType?: undefined;
+space?: undefined;
+labelKey?: undefined;
+valueKey?: undefined;
+api?: undefined;
+width?: undefined;
+height?: undefined;
+action?: undefined;
+fileTypes?: undefined;
+size?: undefined;
+uploadKey?: undefined;
+dataPath?: undefined;
+};
+designKey: string;
+name: string;
+required?: undefined;
+} | {
+label: string;
+component: string;
+props: {
+mode: string;
+options: {
+label: string;
+value: string;
+}[];
+optionType: string;
+space: number;
+labelKey: string;
+valueKey: string;
+api: {
+url: string;
+dataPath: string;
+method: string;
+params: {};
+data: {};
+};
+placeholder?: undefined;
+autosize?: undefined;
+width?: undefined;
+height?: undefined;
+action?: undefined;
+fileTypes?: undefined;
+size?: undefined;
+uploadKey?: undefined;
+dataPath?: undefined;
+};
+designKey: string;
+name: string;
+required: true;
+} | {
+label: string;
+component: string;
+props: {
+mode: string;
+options: {
+name: string;
+value: number;
+}[];
+optionType: string;
+space: number;
+labelKey: string;
+valueKey: string;
+placeholder?: undefined;
+autosize?: undefined;
+api?: undefined;
+width?: undefined;
+height?: undefined;
+action?: undefined;
+fileTypes?: undefined;
+size?: undefined;
+uploadKey?: undefined;
+dataPath?: undefined;
+};
+designKey: string;
+name: string;
+required: true;
+} | {
+label: string;
+component: string;
+props: {
+width: number;
+height: number;
+action: string;
+fileTypes: string[];
+size: number;
+uploadKey: string;
+dataPath: string;
+placeholder?: undefined;
+autosize?: undefined;
+mode?: undefined;
+options?: undefined;
+optionType?: undefined;
+space?: undefined;
+labelKey?: undefined;
+valueKey?: undefined;
+api?: undefined;
+};
+designKey: string;
+name: string;
+required?: undefined;
+} | {
+label: string;
+component: string;
+designKey: string;
+name: string;
+required: true;
+props?: undefined;
+})[];
+};
+id: string;
+} | {
+name: string;
+schema: {
+labelWidth: number;
+labelAlign: "right";
+size: "default";
+items: ({
+label: string;
+name: string;
+component: string;
+props: {
+'inline-prompt': boolean;
+mode?: undefined;
+};
+designKey: string;
+change: {
+target: string;
+condition: string;
+value: number;
+}[];
+children?: undefined;
+} | {
+label: string;
+component: string;
+children: ({
+label: string;
+component: string;
+props: {
+placeholder: string;
+'inline-prompt'?: undefined;
+'active-value'?: undefined;
+'inactive-value'?: undefined;
+};
+designKey: string;
+name: string;
+change: {
+target: string;
+condition: string;
+value: number;
+}[];
+} | {
+label: string;
+component: string;
+props: {
+placeholder: string;
+'inline-prompt'?: undefined;
+'active-value'?: undefined;
+'inactive-value'?: undefined;
+};
+designKey: string;
+name: string;
+change?: undefined;
+} | {
+label: string;
+component: string;
+designKey: string;
+name: string;
+props: {
+'inline-prompt': boolean;
+'active-value': number;
+'inactive-value': number;
+placeholder?: undefined;
+};
+change?: undefined;
+})[];
+props: {
+mode: string;
+'inline-prompt'?: undefined;
+};
+designKey: string;
+name: string;
+change?: undefined;
+})[];
+};
+id: string;
+} | {
+name: string;
+schema: {
+labelWidth: number;
+labelAlign: "right";
+size: "default";
+items: ({
+label: string;
+component: string;
+props: {
+max: number;
+'allow-half': boolean;
+autocomplete?: undefined;
+showWordLimit?: undefined;
+type?: undefined;
+autosize?: undefined;
+placeholder?: undefined;
+};
+designKey: string;
+name: string;
+required: true;
+hidden?: undefined;
+} | {
+label: string;
+component: string;
+props: {
+autocomplete: string;
+showWordLimit: boolean;
+type: string;
+autosize: {
+minRows: number;
+maxRows: number;
+};
+placeholder: string;
+max?: undefined;
+'allow-half'?: undefined;
+};
+designKey: string;
+name: string;
+hidden: string;
+required?: undefined;
+})[];
+};
+id: string;
+} | {
+name: string;
+schema: {
+labelWidth: number;
+labelAlign: "right";
+size: "default";
+items: ({
+label: string;
+component: string;
+props: {
+mode: string;
+options: {
+name: string;
+id: number;
+}[];
+labelKey: string;
+valueKey: string;
+optionType: string;
+space: number;
+placeholder?: undefined;
+api?: undefined;
+direction?: undefined;
+};
+name: string;
+required: true;
+designKey: string;
+hidden?: undefined;
+} | {
+label: string;
+component: string;
+props: {
+mode: string;
+placeholder: string;
+labelKey: string;
+valueKey: string;
+api: {
+url: string;
+method: string;
+params: {
+filters: {
+category: string;
+};
+};
+dataPath: string;
+};
+optionType: string;
+direction: string;
+space: number;
+options?: undefined;
+};
+name: string;
+required: true;
+hidden: string;
+designKey: string;
+})[];
+};
+id: string;
+} | {
+name: string;
+schema: {
+labelWidth: number;
+labelAlign: "right";
+size: "default";
+items: ({
+label: string;
+component: string;
+props: {
+mode: string;
+options: {
+name: string;
+id: string;
+price: number;
+}[];
+placeholder: string;
+labelKey: string;
+valueKey: string;
+min?: undefined;
+max?: undefined;
+step?: undefined;
+unit?: undefined;
+disabled?: undefined;
+controlsPosition?: undefined;
+};
+designKey: string;
+name: string;
+change: {
+target: string;
+value: string;
+}[];
+} | {
+label: string;
+component: string;
+designKey: string;
+name: string;
+props: {
+min: number;
+max: number;
+step: number;
+unit: string;
+disabled: boolean;
+controlsPosition: string;
+mode?: undefined;
+options?: undefined;
+placeholder?: undefined;
+labelKey?: undefined;
+valueKey?: undefined;
+};
+change?: undefined;
+})[];
+};
+id: string;
+} | {
+name: string;
+schema: {
+labelWidth: number;
+labelAlign: "right";
+size: "default";
+items: ({
+label: string;
+component: string;
+props: {
+mode: string;
+options: {
+label: string;
+value: string;
+vv: string;
+}[];
+labelKey: string;
+valueKey: string;
+optionType: string;
+direction: string;
+space: number;
+placeholder?: undefined;
+};
+designKey: string;
+name: string;
+change: {
+target: string;
+value: string;
+}[];
+} | {
+label: string;
+component: string;
+props: {
+placeholder: string;
+mode?: undefined;
+options?: undefined;
+labelKey?: undefined;
+valueKey?: undefined;
+optionType?: undefined;
+direction?: undefined;
+space?: undefined;
+};
+designKey: string;
+name: string;
+change?: undefined;
+})[];
+};
+id: string;
+} | {
+name: string;
+schema: {
+labelWidth: number;
+labelAlign: "right";
+size: "default";
+items: {
+label: string;
+component: string;
+props: {
+placeholder: string;
+};
+designKey: string;
+name: string;
+}[];
+};
+id: string;
+} | {
+name: string;
+schema: {
+labelWidth: number;
+labelAlign: "right";
+size: "default";
+items: ({
+label: string;
+component: string;
+props: {
+placeholder: string;
+'inline-prompt'?: undefined;
+header?: undefined;
+};
+designKey: string;
+name: string;
+children?: undefined;
+} | {
+label: string;
+component: string;
+props: {
+'inline-prompt': boolean;
+placeholder?: undefined;
+header?: undefined;
+};
+designKey: string;
+name: string;
+children?: undefined;
+} | {
+component: string;
+children: ({
+label: string;
+component: string;
+props: {
+placeholder: string;
+mode?: undefined;
+options?: undefined;
+labelKey?: undefined;
+valueKey?: undefined;
+optionType?: undefined;
+direction?: undefined;
+space?: undefined;
+};
+designKey: string;
+name: string;
+} | {
+label: string;
+component: string;
+props: {
+mode: string;
+options: {
+label: string;
+value: string;
+}[];
+labelKey: string;
+valueKey: string;
+optionType: string;
+direction: string;
+space: number;
+placeholder?: undefined;
+};
+designKey: string;
+name: string;
+})[];
+props: {
+header: string;
+placeholder?: undefined;
+'inline-prompt'?: undefined;
+};
+designKey: string;
+name: string;
+label?: undefined;
+})[];
+};
+id: string;
+})[];
+};
+omitMenus: {
+type: PropType<string[]>;
+default: () => never[];
+};
+}>> & Readonly<{
+onAdd?: ((element: FormElement) => any) | undefined;
+onSave?: (() => any) | undefined;
+onOnSave?: (() => any) | undefined;
+}>, {
+schemaContext: Record<string, any>;
+templates: TemplateData;
+omitMenus: string[];
+}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+
+export declare type FormElement = {
+    name: string;
+    component: string | VNode | Component;
+    icon: string | VNode | Component;
+    type: 'assist' | 'layout' | 'basic' | 'highBasic';
+    order: number;
+    initialValues: Omit<FormItemType, 'name'>;
+    modelName?: string;
+    attrSchema: FormSchema;
+};
+
+export declare interface FormInstance extends FormRenderProps {
+    formValues: Record<string, any>;
+    selectData: Record<string, Record<string, any>>;
+    initialValues: Record<string, Record<string, any>>;
+    context: Record<string, any>;
+    updateFormValues: (values: Record<string, any>) => void;
+    updateSelectData: (key: string, value: Record<string, any>) => void;
+    updateInitialValues: (values: Record<string, any>) => void;
+    validate: () => FormValidationResult | undefined;
+    resetFields: (names?: string[]) => void;
+    submit: () => Promise<void>;
+}
+
+export declare interface FormItemType {
+    label?: string;
+    name: string;
+    component: string;
+    required?: boolean;
+    props?: Record<string, any>;
+    initialValue?: any;
+    help?: string;
+    children?: FormItemType[];
+    hidden?: boolean | string;
+    hideLabel?: boolean;
+    designKey?: string;
+    rules?: FormRule[];
+    class?: any;
+    style?: any;
+    change?: FormChange[];
+    dialog?: boolean;
+}
+
+export declare const FormRender: __VLS_WithTemplateSlots<typeof __VLS_component, ReturnType<typeof __VLS_template>>;
 
 declare interface FormRenderProps {
     schema: FormSchema;
@@ -293,15 +1331,90 @@ export declare type FormSchema = {
     disabled?: boolean;
     hideRequiredAsterisk?: boolean;
     labelBold?: boolean;
+    scrollToError?: boolean;
     items: FormItemType[];
 };
 
+declare type Options = {
+    request?: (options: Record<string, any>) => Promise<Record<string, any>>;
+    extendElements?: Record<string, FormElement>;
+    lang?: 'zh' | 'en';
+};
+
 export declare type TemplateData = {
     name: string;
     schema: FormSchema;
     id?: string;
 }[];
 
-export declare const useFormInstance: () => FormInstance;
+export declare const useFormInstance: () => {
+    readonly formValues: {
+        readonly [x: string]: any;
+    };
+    readonly selectData: {
+        readonly [x: string]: {
+            readonly [x: string]: any;
+        };
+    };
+    readonly initialValues: {
+        readonly [x: string]: {
+            readonly [x: string]: any;
+        };
+    };
+    readonly context: {
+        readonly [x: string]: any;
+    };
+    readonly updateFormValues: (values: Record<string, any>) => void;
+    readonly updateSelectData: (key: string, value: Record<string, any>) => void;
+    readonly updateInitialValues: (values: Record<string, any>) => void;
+    readonly validate: () => FormValidationResult | undefined;
+    readonly resetFields: (names?: string[]) => void;
+    readonly submit: () => Promise<void>;
+    readonly schema: {
+        readonly labelWidth?: number | undefined;
+        readonly labelAlign?: ("top" | "left" | "right") | undefined;
+        readonly labelSuffix?: string | undefined;
+        readonly size?: ("default" | "small" | "large") | undefined;
+        readonly disabled?: boolean | undefined;
+        readonly hideRequiredAsterisk?: boolean | undefined;
+        readonly labelBold?: boolean | undefined;
+        readonly scrollToError?: boolean | undefined;
+        readonly items: readonly {
+            readonly label?: string | undefined;
+            readonly name: string;
+            readonly component: string;
+            readonly required?: boolean | undefined;
+            readonly props?: {
+                readonly [x: string]: any;
+            } | undefined;
+            readonly initialValue?: any;
+            readonly help?: string | undefined;
+            readonly children?: readonly any[] | undefined;
+            readonly hidden?: (boolean | string) | undefined;
+            readonly hideLabel?: boolean | undefined;
+            readonly designKey?: string | undefined;
+            readonly rules?: readonly {
+                readonly type: "email" | "url" | "custom" | string;
+                readonly customReg?: string | undefined;
+                readonly message?: string | undefined;
+                readonly trigger: "blur" | "change";
+            }[] | undefined;
+            readonly class?: any;
+            readonly style?: any;
+            readonly change?: readonly {
+                readonly target: string;
+                readonly value?: any;
+                readonly condition?: any;
+            }[] | undefined;
+            readonly dialog?: boolean | undefined;
+        }[];
+    };
+    readonly schemaContext?: {
+        readonly [x: string]: any;
+    } | undefined;
+    readonly design?: boolean | undefined;
+    readonly footer?: boolean | undefined;
+    readonly read?: boolean | undefined;
+};
 
 export { }