@formily/core/lib/index.d.ts

English | [简体中文](./README.zh-cn.md)

import { FormPath, FormPathPattern, BigData } from '@formily/shared';
import { FormValidator, setValidationLanguage, setValidationLocale } from '@formily/validator';
import { FormGraph } from './shared/graph';
import { IFormState, IFieldState, IFormCreatorOptions, IFieldStateProps, IVirtualFieldStateProps, IFormSubmitResult, IFormResetOptions, IField, IVirtualField, FormHeartSubscriber, IFormExtendedValidateFieldOptions } from './types';
export * from './shared/lifecycle';
export * from './types';
export declare function createForm<FieldProps, VirtualFieldProps>(options?: IFormCreatorOptions): {
    submit: (onSubmit?: (values: {}) => any) => Promise<IFormSubmitResult>;
    reset: ({ selector, forceClear, validate, clearInitialValue }?: IFormResetOptions) => Promise<void | import("@formily/validator").ValidateNodeResult>;
    hasChanged: (target: any, path: FormPathPattern) => boolean;
    clearErrors: (pattern?: FormPathPattern) => void;
    validate: (path?: FormPathPattern, opts?: IFormExtendedValidateFieldOptions) => Promise<import("@formily/validator").ValidateNodeResult>;
    setFormState: (callback?: (state: IFormState<any>) => any, silent?: boolean) => void;
    getFormState: (callback?: (state: IFormState<any>) => any) => any;
    setFieldState: (path: FormPathPattern, callback?: (state: IFieldState<FieldProps>) => void, silent?: boolean) => void;
    getFieldState: (path: FormPathPattern, callback?: (state: IFieldState<FieldProps>) => any) => any;
    registerField: ({ path, name, value, initialValue, required, rules, editable, visible, display, computeState, dataType, useDirty, unmountRemoveValue, props }: IFieldStateProps<any>) => IField;
    registerVirtualField: ({ name, path, props, display, visible, computeState, useDirty }: IVirtualFieldStateProps<any>) => IVirtualField;
    createMutators: (input: any) => {
        change(...values: any[]): any;
        focus(): void;
        blur(): void;
        push(value?: any): any[];
        pop(): any[];
        insert(index: number, value: any): any[];
        remove(index?: string | number): void;
        exist(index?: string | number): any;
        unshift(value: any): any[];
        shift(): any[];
        move($from: number, $to: number): any[];
        moveUp(index: number): any[];
        moveDown(index: number): any[];
        validate(opts?: IFormExtendedValidateFieldOptions): Promise<import("@formily/validator").ValidateNodeResult>;
    };
    getFormGraph: () => any;
    setFormGraph: (nodes: {}) => void;
    setFieldValue: (path: FormPathPattern, value?: any, silent?: boolean) => void;
    unsafe_do_not_use_transform_data_path: (path: FormPathPattern) => FormPath;
    getFieldValue: (path?: FormPathPattern) => any;
    setFieldInitialValue: (path?: FormPathPattern, value?: any, silent?: boolean) => void;
    getFieldInitialValue: (path?: FormPathPattern) => any;
    isHostRendering: () => boolean;
    hostUpdate: (callback?: () => any) => any;
    subscribe: (callback?: FormHeartSubscriber) => number;
    unsubscribe: (id: number) => void;
    notify: <T>(type: string, payload: T) => void;
};
export declare const registerValidationFormats: typeof FormValidator.registerFormats;
export declare const registerValidationRules: typeof FormValidator.registerRules;
export declare const registerValidationMTEngine: (template: any) => void;
export { setValidationLanguage, setValidationLocale, BigData, FormPath, FormPathPattern, FormGraph };
export default createForm;