@gopowerteam/form-render 0.0.1 → 0.0.3

package/dist/es/interfaces/form-item-options.d.ts

@@ -0,0 +1,32 @@
+import type { FieldRule } from '@arco-design/web-vue';
+import type { FormItemRenders } from '../form-items';
+/**
+ * 表单项配置
+ */
+export interface FormItemOptions<T = Record<string, any>> {
+    key: string;
+    title: string;
+    default?: any | (() => any) | (() => Promise<any>);
+    collapsed?: boolean;
+    visiable?: (record: T) => boolean;
+    span?: number;
+    minWidth?: number;
+    rule?: FieldRule | FieldRule[];
+    render?: FormItemRender<T>;
+}
+/**
+ * 表单配置
+ */
+export type FormItemsOptions<T = Record<string, any>> = Array<FormItemOptions<T>>;
+/**
+ * Render函数
+ */
+export interface FormItemRender<T = Record<string, any>> {
+    (render: FormItemRenderFun): (data: T, itemOptions: FormItemOptions<T>) => JSX.Element;
+}
+/**
+ * Render函数模板
+ */
+export type FormItemRenderFun = typeof FormItemRenders & {
+    [key: string]: any;
+};

package/dist/es/interfaces/index.d.ts

@@ -0,0 +1,7 @@
+export interface DataRecord {
+    [key: string]: any;
+}
+export interface DataProp {
+    [key: string]: any;
+}
+export * from './form-item-options';

package/dist/es/render/form-item-render.d.ts

@@ -0,0 +1,9 @@
+import type { DataRecord, FormItemOptions } from '../interfaces';
+/**
+ * 创建表格列
+ * @param options
+ * @returns
+ */
+export declare function renderFormItem(source: DataRecord, options: FormItemOptions): import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    [key: string]: any;
+}>;

package/dist/es/render/form-render.d.ts

@@ -0,0 +1,330 @@
+import { type PropType } from 'vue';
+import { type FieldRule } from '@arco-design/web-vue/es/form';
+import type { FormItemsOptions } from '../interfaces';
+export declare const FormRender: import("vue").DefineComponent<{
+    form: {
+        type: PropType<FormItemsOptions>;
+        required: true;
+    };
+    minWidth: {
+        type: NumberConstructor;
+        required: false;
+        default: number;
+    };
+    name: {
+        type: StringConstructor;
+        required: false;
+        default: string;
+    };
+    submitable: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+    searchable: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+    footer: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+}, {
+    formId: string;
+    formSource: import("vue").Ref<import("../interfaces").DataRecord>;
+    formInstance: import("vue").Ref<({
+        $: import("vue").ComponentInternalInstance;
+        $data: {};
+        $props: Partial<{
+            disabled: boolean;
+            layout: "horizontal" | "vertical" | "inline";
+            labelColProps: Record<string, any>;
+            wrapperColProps: Record<string, any>;
+            labelAlign: "left" | "right";
+            autoLabelWidth: boolean;
+            scrollToFirstError: boolean;
+        }> & Omit<{
+            readonly model: Record<string, any>;
+            readonly layout: "horizontal" | "vertical" | "inline";
+            readonly size?: "mini" | "medium" | "large" | "small" | undefined;
+            readonly labelColProps: Record<string, any>;
+            readonly wrapperColProps: Record<string, any>;
+            readonly labelColStyle?: Record<string, any> | undefined;
+            readonly wrapperColStyle?: Record<string, any> | undefined;
+            readonly labelAlign: "left" | "right";
+            readonly disabled?: boolean | undefined;
+            readonly rules?: Record<string, FieldRule<any> | FieldRule<any>[]> | undefined;
+            readonly autoLabelWidth: boolean;
+            readonly id?: string | undefined;
+            readonly scrollToFirstError: boolean;
+            onSubmit?: ((data: {
+                values: Record<string, any>;
+                errors: Record<string, import("@arco-design/web-vue/es/form").ValidatedError> | undefined;
+            }, ev: Event) => any) | undefined;
+            onSubmitSuccess?: ((values: Record<string, any>, ev: Event) => any) | undefined;
+            onSubmitFailed?: ((data: {
+                values: Record<string, any>;
+                errors: Record<string, import("@arco-design/web-vue/es/form").ValidatedError>;
+            }, ev: Event) => any) | undefined;
+        } & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps & Readonly<{
+            model?: unknown;
+            layout?: unknown;
+            size?: unknown;
+            labelColProps?: unknown;
+            wrapperColProps?: unknown;
+            labelColStyle?: unknown;
+            wrapperColStyle?: unknown;
+            labelAlign?: unknown;
+            disabled?: unknown;
+            rules?: unknown;
+            autoLabelWidth?: unknown;
+            id?: unknown;
+            scrollToFirstError?: unknown;
+        } & {
+            layout: "horizontal" | "vertical" | "inline";
+            model: Record<string, any>;
+            labelColProps: Record<string, any>;
+            wrapperColProps: Record<string, any>;
+            labelAlign: "left" | "right";
+            autoLabelWidth: boolean;
+            scrollToFirstError: boolean;
+        } & {
+            disabled?: boolean | undefined;
+            size?: "mini" | "medium" | "large" | "small" | undefined;
+            labelColStyle?: Record<string, any> | undefined;
+            wrapperColStyle?: Record<string, any> | undefined;
+            rules?: Record<string, FieldRule<any> | FieldRule<any>[]> | undefined;
+            id?: string | undefined;
+        }> & {
+            onSubmit?: ((data: {
+                values: Record<string, any>;
+                errors: Record<string, import("@arco-design/web-vue/es/form").ValidatedError> | undefined;
+            }, ev: Event) => any) | undefined;
+            onSubmitSuccess?: ((values: Record<string, any>, ev: Event) => any) | undefined;
+            onSubmitFailed?: ((data: {
+                values: Record<string, any>;
+                errors: Record<string, import("@arco-design/web-vue/es/form").ValidatedError>;
+            }, ev: Event) => any) | undefined;
+        }, "disabled" | "labelColProps" | "wrapperColProps" | "autoLabelWidth" | "layout" | "labelAlign" | "scrollToFirstError">;
+        $attrs: {
+            [x: string]: unknown;
+        };
+        $refs: {
+            [x: string]: unknown;
+        };
+        $slots: Readonly<{
+            [name: string]: import("vue").Slot<any> | undefined;
+        }>;
+        $root: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}> | null;
+        $parent: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}> | null;
+        $emit: ((event: "submit", data: {
+            values: Record<string, any>;
+            errors: Record<string, import("@arco-design/web-vue/es/form").ValidatedError> | undefined;
+        }, ev: Event) => void) & ((event: "submitSuccess", values: Record<string, any>, ev: Event) => void) & ((event: "submitFailed", data: {
+            values: Record<string, any>;
+            errors: Record<string, import("@arco-design/web-vue/es/form").ValidatedError>;
+        }, ev: Event) => void);
+        $el: any;
+        $options: import("vue").ComponentOptionsBase<Readonly<{
+            model?: unknown;
+            layout?: unknown;
+            size?: unknown;
+            labelColProps?: unknown;
+            wrapperColProps?: unknown;
+            labelColStyle?: unknown;
+            wrapperColStyle?: unknown;
+            labelAlign?: unknown;
+            disabled?: unknown;
+            rules?: unknown;
+            autoLabelWidth?: unknown;
+            id?: unknown;
+            scrollToFirstError?: unknown;
+        } & {
+            layout: "horizontal" | "vertical" | "inline";
+            model: Record<string, any>;
+            labelColProps: Record<string, any>;
+            wrapperColProps: Record<string, any>;
+            labelAlign: "left" | "right";
+            autoLabelWidth: boolean;
+            scrollToFirstError: boolean;
+        } & {
+            disabled?: boolean | undefined;
+            size?: "mini" | "medium" | "large" | "small" | undefined;
+            labelColStyle?: Record<string, any> | undefined;
+            wrapperColStyle?: Record<string, any> | undefined;
+            rules?: Record<string, FieldRule<any> | FieldRule<any>[]> | undefined;
+            id?: string | undefined;
+        }> & {
+            onSubmit?: ((data: {
+                values: Record<string, any>;
+                errors: Record<string, import("@arco-design/web-vue/es/form").ValidatedError> | undefined;
+            }, ev: Event) => any) | undefined;
+            onSubmitSuccess?: ((values: Record<string, any>, ev: Event) => any) | undefined;
+            onSubmitFailed?: ((data: {
+                values: Record<string, any>;
+                errors: Record<string, import("@arco-design/web-vue/es/form").ValidatedError>;
+            }, ev: Event) => any) | undefined;
+        }, {
+            cls: import("vue").ComputedRef<(string | {
+                [x: string]: boolean;
+            })[]>;
+            formRef: import("vue").Ref<HTMLFormElement | undefined>;
+            handleSubmit: (e: Event) => void;
+            innerValidate: (callback?: ((errors: Record<string, import("@arco-design/web-vue/es/form").ValidatedError> | undefined) => void) | undefined) => Promise<Record<string, import("@arco-design/web-vue/es/form").ValidatedError> | undefined>;
+            innerValidateField: (field: string | string[], callback?: ((errors: Record<string, import("@arco-design/web-vue/es/form").ValidatedError> | undefined) => void) | undefined) => Promise<Record<string, import("@arco-design/web-vue/es/form").ValidatedError> | undefined>;
+            innerResetFields: (field?: string | string[] | undefined) => void;
+            innerClearValidate: (field?: string | string[] | undefined) => void;
+            innerSetFields: (data: Record<string, import("@arco-design/web-vue/es/form/interface").FieldData>) => void;
+            innerScrollToField: (field: string, options?: import("scroll-into-view-if-needed").Options<any> | undefined) => void;
+        }, unknown, {}, {
+            validate(callback?: ((errors: Record<string, import("@arco-design/web-vue/es/form").ValidatedError> | undefined) => void) | undefined): Promise<Record<string, import("@arco-design/web-vue/es/form").ValidatedError> | undefined>;
+            validateField(field: string | string[], callback?: ((errors: Record<string, import("@arco-design/web-vue/es/form").ValidatedError> | undefined) => void) | undefined): Promise<Record<string, import("@arco-design/web-vue/es/form").ValidatedError> | undefined>;
+            resetFields(field?: string | string[] | undefined): void;
+            clearValidate(field?: string | string[] | undefined): void;
+            setFields(data: Record<string, import("@arco-design/web-vue/es/form/interface").FieldData>): void;
+            scrollToField(field: string): void;
+        }, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+            submit: (data: {
+                values: Record<string, any>;
+                errors: Record<string, import("@arco-design/web-vue/es/form").ValidatedError> | undefined;
+            }, ev: Event) => true;
+            submitSuccess: (values: Record<string, any>, ev: Event) => true;
+            submitFailed: (data: {
+                values: Record<string, any>;
+                errors: Record<string, import("@arco-design/web-vue/es/form").ValidatedError>;
+            }, ev: Event) => true;
+        }, string, {
+            disabled: boolean;
+            layout: "horizontal" | "vertical" | "inline";
+            labelColProps: Record<string, any>;
+            wrapperColProps: Record<string, any>;
+            labelAlign: "left" | "right";
+            autoLabelWidth: boolean;
+            scrollToFirstError: boolean;
+        }, {}, string, {}> & {
+            beforeCreate?: ((() => void) | (() => void)[]) | undefined;
+            created?: ((() => void) | (() => void)[]) | undefined;
+            beforeMount?: ((() => void) | (() => void)[]) | undefined;
+            mounted?: ((() => void) | (() => void)[]) | undefined;
+            beforeUpdate?: ((() => void) | (() => void)[]) | undefined;
+            updated?: ((() => void) | (() => void)[]) | undefined;
+            activated?: ((() => void) | (() => void)[]) | undefined;
+            deactivated?: ((() => void) | (() => void)[]) | undefined;
+            beforeDestroy?: ((() => void) | (() => void)[]) | undefined;
+            beforeUnmount?: ((() => void) | (() => void)[]) | undefined;
+            destroyed?: ((() => void) | (() => void)[]) | undefined;
+            unmounted?: ((() => void) | (() => void)[]) | undefined;
+            renderTracked?: (((e: import("vue").DebuggerEvent) => void) | ((e: import("vue").DebuggerEvent) => void)[]) | undefined;
+            renderTriggered?: (((e: import("vue").DebuggerEvent) => void) | ((e: import("vue").DebuggerEvent) => void)[]) | undefined;
+            errorCaptured?: (((err: unknown, instance: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}> | null, info: string) => boolean | void) | ((err: unknown, instance: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}> | null, info: string) => boolean | void)[]) | undefined;
+        };
+        $forceUpdate: () => void;
+        $nextTick: typeof import("vue").nextTick;
+        $watch<T extends string | ((...args: any) => any)>(source: T, cb: T extends (...args: any) => infer R ? (args_0: R, args_1: R) => any : (...args: any) => any, options?: import("vue").WatchOptions<boolean> | undefined): import("vue").WatchStopHandle;
+    } & Readonly<{
+        model?: unknown;
+        layout?: unknown;
+        size?: unknown;
+        labelColProps?: unknown;
+        wrapperColProps?: unknown;
+        labelColStyle?: unknown;
+        wrapperColStyle?: unknown;
+        labelAlign?: unknown;
+        disabled?: unknown;
+        rules?: unknown;
+        autoLabelWidth?: unknown;
+        id?: unknown;
+        scrollToFirstError?: unknown;
+    } & {
+        layout: "horizontal" | "vertical" | "inline";
+        model: Record<string, any>;
+        labelColProps: Record<string, any>;
+        wrapperColProps: Record<string, any>;
+        labelAlign: "left" | "right";
+        autoLabelWidth: boolean;
+        scrollToFirstError: boolean;
+    } & {
+        disabled?: boolean | undefined;
+        size?: "mini" | "medium" | "large" | "small" | undefined;
+        labelColStyle?: Record<string, any> | undefined;
+        wrapperColStyle?: Record<string, any> | undefined;
+        rules?: Record<string, FieldRule<any> | FieldRule<any>[]> | undefined;
+        id?: string | undefined;
+    }> & {
+        onSubmit?: ((data: {
+            values: Record<string, any>;
+            errors: Record<string, import("@arco-design/web-vue/es/form").ValidatedError> | undefined;
+        }, ev: Event) => any) | undefined;
+        onSubmitSuccess?: ((values: Record<string, any>, ev: Event) => any) | undefined;
+        onSubmitFailed?: ((data: {
+            values: Record<string, any>;
+            errors: Record<string, import("@arco-design/web-vue/es/form").ValidatedError>;
+        }, ev: Event) => any) | undefined;
+    } & import("vue").ShallowUnwrapRef<{
+        cls: import("vue").ComputedRef<(string | {
+            [x: string]: boolean;
+        })[]>;
+        formRef: import("vue").Ref<HTMLFormElement | undefined>;
+        handleSubmit: (e: Event) => void;
+        innerValidate: (callback?: ((errors: Record<string, import("@arco-design/web-vue/es/form").ValidatedError> | undefined) => void) | undefined) => Promise<Record<string, import("@arco-design/web-vue/es/form").ValidatedError> | undefined>;
+        innerValidateField: (field: string | string[], callback?: ((errors: Record<string, import("@arco-design/web-vue/es/form").ValidatedError> | undefined) => void) | undefined) => Promise<Record<string, import("@arco-design/web-vue/es/form").ValidatedError> | undefined>;
+        innerResetFields: (field?: string | string[] | undefined) => void;
+        innerClearValidate: (field?: string | string[] | undefined) => void;
+        innerSetFields: (data: Record<string, import("@arco-design/web-vue/es/form/interface").FieldData>) => void;
+        innerScrollToField: (field: string, options?: import("scroll-into-view-if-needed").Options<any> | undefined) => void;
+    }> & {} & {
+        validate(callback?: ((errors: Record<string, import("@arco-design/web-vue/es/form").ValidatedError> | undefined) => void) | undefined): Promise<Record<string, import("@arco-design/web-vue/es/form").ValidatedError> | undefined>;
+        validateField(field: string | string[], callback?: ((errors: Record<string, import("@arco-design/web-vue/es/form").ValidatedError> | undefined) => void) | undefined): Promise<Record<string, import("@arco-design/web-vue/es/form").ValidatedError> | undefined>;
+        resetFields(field?: string | string[] | undefined): void;
+        clearValidate(field?: string | string[] | undefined): void;
+        setFields(data: Record<string, import("@arco-design/web-vue/es/form/interface").FieldData>): void;
+        scrollToField(field: string): void;
+    } & import("vue").ComponentCustomProperties & {}) | undefined>;
+    formColumns: import("vue").Ref<number>;
+    formRules: import("vue").ComputedRef<Record<string, FieldRule<any> | FieldRule<any>[]>>;
+    formCollspased: import("vue").Ref<boolean>;
+    formActiosSpan: import("vue").ComputedRef<number>;
+    toggleFormCollapsed: () => boolean;
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("submit" | "cancel")[], "submit" | "cancel", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    form: {
+        type: PropType<FormItemsOptions>;
+        required: true;
+    };
+    minWidth: {
+        type: NumberConstructor;
+        required: false;
+        default: number;
+    };
+    name: {
+        type: StringConstructor;
+        required: false;
+        default: string;
+    };
+    submitable: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+    searchable: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+    footer: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+}>> & {
+    onSubmit?: ((...args: any[]) => any) | undefined;
+    onCancel?: ((...args: any[]) => any) | undefined;
+}, {
+    footer: boolean;
+    name: string;
+    minWidth: number;
+    submitable: boolean;
+    searchable: boolean;
+}, {}>;
+export type FormRenderInstance = InstanceType<typeof FormRender>;

package/dist/es/utils/create-form-source.d.ts

@@ -0,0 +1,3 @@
+import { type Ref } from 'vue';
+import type { DataRecord, FormItemsOptions } from '../interfaces';
+export declare function createFormSource(form?: FormItemsOptions): [Ref<DataRecord>, (value: DataRecord) => void];