@transact-open-ux/react/dist/components/TransactForm.d.ts

Library to integrate React with Transact Open UX

import { FormikConfig, FormikProps } from "formik";
import React, { FunctionComponent } from "react";
export declare type Schema = any;
export interface FormProps extends Partial<FormikConfig<any>> {
    /**
     * Specify whether to send a "Form Receipt" email message to the specified user submissionEmailAddress property
     */
    sendEmailFormReceipt?: boolean;
    /**
     * The email address of the user in which the "Form Receipt" will be sent
     */
    submissionEmailAddress?: string;
    /**
     * A transaction milestone event to record with the transaction, maximum length should be 100 characters
     */
    submissionMilestone?: string;
    /**
     * The render prop can be used the render the form, you can access all the render props from the Formik component
     * here.
     * @param props
     */
    render?: (props: FormikProps<any>) => React.ReactNode;
    /**
     * The children prop can be used the render the form, you can access all the render props from the Formik component
     * here.
     * @param props
     */
    children?: (props: object) => React.ReactNode;
    /**
     * [A Yup schema](https://github.com/jquense/yup) or a function that returns a Yup schema.
     * This is used for validation. Errors are mapped by key to the inner component's `errors`.
     * Its keys should match those of `values`
     */
    validationSchema?: Schema | (() => Schema);
    /**
     * A component that will render when the form is loading the initial data
     */
    loadingComponent?: string | React.ComponentType<any>;
}
/**
 * The `TransactForm` Component is a light wrapper on top of [Formik's](https://jaredpalmer.com/formik) `Formik` component.
 * <br>
 * It adds page level validation functionality with Yup and transact support to Formik,
 * while maintaining all of Formik's flexibility and functionality.
 * <br>
 * You can read more about the properties inherited from the `Formik` component [here](https://jaredpalmer.com/formik/docs/api/formik).
 */
declare const TransactForm: FunctionComponent<FormProps>;
export default TransactForm;