epic-designer/dist/core/src/components/builder/hooks/useBuilder.d.ts

基于vue3的设计器,可视化开发页面表单

import { FormDataModel } from '../../../../../types/src/index';
export declare function useBuilder(): {
    formInstances: import('vue').Ref<any, any>;
    getData: (formName?: string) => Promise<FormDataModel>;
    getFormInstance: (formName?: string) => Promise<any>;
    getForms: () => Promise<Record<string, FormDataModel>>;
    pageManager: {
        addComponentInstance: (id: string, instance: import('../../../../../types/src/index').EpNodeInstance, scopeName?: string) => void;
        componentInstances: import('vue').Ref<import('../../../../../manager/src/index').ComponentInstances, import('../../../../../manager/src/index').ComponentInstances>;
        defaultComponentIds: import('vue').Ref<string[], string[]>;
        doActions: (actions: import('../../../../../manager/src/index').ActionsModel[], scopeName?: string, ...args: unknown[]) => void;
        find: (queryValue: string, queryField?: string, scopeName?: string) => import('../../../../../types/src/index').EpNodeInstance["exposed"] | null;
        findAll: (queryValue: string, queryField?: string, scopeName?: string) => import('../../../../../types/src/index').EpNodeInstance["exposed"][];
        findInstance: (queryValue: string, queryField?: string, scopeName?: string) => import('../../../../../types/src/index').EpNodeInstance | null;
        findInstanceAll: (queryValue: string, queryField?: string, scopeName?: string) => import('../../../../../types/src/index').EpNodeInstance[];
        forms: Record<string, unknown>;
        funcs: import('vue').Ref<Record<string, Function>, Record<string, Function>>;
        getComponentInstance: (queryValue: string, queryField?: string, scopeName?: string) => import('../../../../../types/src/index').EpNodeInstance["exposed"] | null;
        hook: {
            clear: (hookName?: keyof import('epic-designer').Hooks) => void;
            execute: (hookName: keyof import('epic-designer').Hooks, context: any) => Promise<void>;
            getCount: (hookName: keyof import('epic-designer').Hooks) => number;
            register: (hookName: keyof import('epic-designer').Hooks, callback: import('epic-designer').HookCallback) => (() => void);
        };
        isDesignMode: import('vue').Ref<boolean, boolean>;
        mountMonitor: {
            isAllMounted: import('vue').ComputedRef<boolean>;
            pendingIds: import('vue').Ref<string[], string[]>;
            pop: (id: string) => void;
            push: (id: string) => void;
            reset: () => void;
        };
        pageSchema: {
            canvas?: {
                height?: string | undefined;
                mode?: "desktop" | "mobile" | "pad" | "pc" | "tablet" | undefined;
                width?: string | undefined;
            } | undefined;
            schemas: {
                [x: string]: any;
                children?: /*elided*/ any[] | undefined;
                description?: string | undefined;
                editData?: object | undefined;
                field?: string | undefined;
                id?: string | undefined;
                input?: boolean | undefined;
                label?: string | undefined;
                noFormItem?: boolean | undefined;
                on?: {
                    [eventName: string]: import('../../../../../manager/src/index').ActionsModel[];
                } | undefined;
                props?: any;
                rules?: {
                    [x: string]: any;
                    trigger?: string | string[] | undefined;
                    enum?: Array<boolean | null | number | string | undefined> | undefined;
                    isValidator?: boolean | undefined;
                    len?: number | undefined;
                    max?: number | undefined;
                    message?: ((a?: string) => string) | string | undefined;
                    min?: number | undefined;
                    pattern?: (RegExp | string) | undefined;
                    required?: boolean | undefined;
                    type?: string | undefined;
                    validator?: (Function | string) | undefined;
                    whitespace?: boolean | undefined;
                }[] | undefined;
                show?: ((renderCallbackParams: import('../../../../../types/src/index').RenderCallbackParams) => boolean) | boolean | undefined;
                slotName?: string | undefined;
                slots?: {
                    [slotName: string]: import('../../../../../types/src/index').ComponentSchema[];
                } | undefined;
                type: string;
            }[];
            script?: string | undefined;
        };
        removeComponentInstance: (id: string, scopeName?: string) => void;
        setDefaultComponentIds: (schemas: import('../../../../../types/src/index').ComponentSchema[]) => void;
        setDesignMode: (isDesign?: boolean) => void;
        setFormData: (formData: Record<string, unknown>, formName?: string) => Record<string, unknown>;
        setMethods: (scriptStr: string, outputError?: boolean) => void;
        setPageSchema: (schema: import('../../../../../types/src/index').PageSchema) => void;
    };
    ready: import('vue').Ref<boolean, boolean>;
    resetData: () => void;
    setData: (data: FormDataModel, formName?: string) => void;
    setForms: (data: Record<string, FormDataModel>) => void;
    validate: (formName?: string) => Promise<FormDataModel>;
    validateAll: () => Promise<Record<string, FormDataModel>>;
};