formio-pr-react/lib/components/Form.d.ts

React renderer for form.io forms.

import { CSSProperties } from 'react';
import { EventEmitter, Form as FormClass, Webform } from 'formio-pr-js';
import { Component, Form as CoreFormType } from '@formio/core';
export type PartialExcept<T, K extends keyof T> = Partial<Omit<T, K>> & Required<Pick<T, K>>;
export type JSON = string | number | boolean | null | undefined | JSON[] | {
    [key: string]: JSON;
};
export type FormOptions = FormClass['options'] & {
    events?: EventEmitter;
    currentForm?: CoreFormType;
};
export type FormType = PartialExcept<CoreFormType, 'components'>;
export type FormSource = string | FormType;
interface FormConstructor {
    new (element: HTMLElement, formSource: FormSource, options: FormOptions): FormClass;
}
export type EventError = string | Error | Error[] | {
    message: string;
} | {
    message: string;
}[];
export type Submission = {
    data: {
        [key: string]: JSON;
    };
    metadata?: {
        [key: string]: JSON;
    };
    state?: string;
} & {
    [key: string]: JSON;
};
export type FormProps = {
    className?: string;
    style?: CSSProperties;
    src: FormSource;
    url?: string;
    form?: FormType;
    submission?: Submission;
    options?: FormOptions;
    formioform?: FormConstructor;
    FormClass?: FormConstructor;
    formReady?: (instance: Webform) => void;
    onFormReady?: (instance: Webform) => void;
    onPrevPage?: (page: number, submission: Submission) => void;
    onNextPage?: (page: number, submission: Submission) => void;
    onCancelSubmit?: () => void;
    onCancelComponent?: (component: Component) => void;
    onChange?: (value: any, flags: any, modified: boolean) => void;
    onCustomEvent?: (event: {
        type: string;
        component: Component;
        data: {
            [key: string]: JSON;
        };
        event?: Event;
    }) => void;
    onComponentChange?: (changed: {
        instance: Webform;
        component: Component;
        value: any;
        flags: any;
    }) => void;
    onSubmit?: (submission: Submission, saved?: boolean) => void;
    onSubmitDone?: (submission: Submission) => void;
    onSubmitError?: (error: EventError) => void;
    onFormLoad?: (form: JSON) => void;
    onError?: (error: EventError | false) => void;
    onRender?: (param: any) => void;
    onAttach?: (param: any) => void;
    onBuild?: (param: any) => void;
    onFocus?: (instance: Webform) => void;
    onBlur?: (instance: Webform) => void;
    onInitialized?: () => void;
    onLanguageChanged?: () => void;
    onBeforeSetSubmission?: (submission: Submission) => void;
    onSaveDraftBegin?: () => void;
    onSaveDraft?: (submission: Submission) => void;
    onRestoreDraft?: (submission: Submission | null) => void;
    onSubmissionDeleted?: (submission: Submission) => void;
    onRequestDone?: () => void;
    otherEvents?: {
        [event: string]: (...args: any[]) => void;
    };
};
export declare const Form: (props: FormProps) => import("react/jsx-runtime").JSX.Element;
export {};
//# sourceMappingURL=Form.d.ts.map