TransactForm

The API documentation of the TransactForm React component.

import { TransactForm } from '@transact-open-ux/react';

The TransactForm component is a light wrapper on top of Formik's Formik component.

It adds page level validation functionality with Yup and transact support to Formik, while maintaining all of Formik's flexibility and functionality.

Props

Prop	Description
children	(props: object) => React.ReactNode The children prop can be used to render the form. You can access all the render props from the Formik component.
loadingComponent	union: string | React.ComponentType A component that will render when the form is loading the initial data.
render	(props: FormikProps) => React.ReactNode The render prop can be used to render the form. You can access all the render props from the Formik component.
sendEmailFormReceipt	boolean Whether to send a "Form Receipt" email message to the email address specified in submissionEmailAddress.
submissionEmailAddress	string The email address of the recipient of the "Form Receipt" email.
submissionMilestone	string (Maximum length 100 characters) A transaction milestone event to record with the transaction.
validationSchema	union: Schema | () => Schema A Yup schema 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.