tuil
ReferenceComponentsForms and controls

FormProps

FormProps component contract.

View rawEdit

Type

export interface FormProps {
  readonly id?: string;
  readonly controller?: TerminalFormController;
  readonly onSubmit?: (
    values: Readonly<Record<string, unknown>>,
    signal: AbortSignal,
  ) => unknown | Promise<unknown>;
  readonly submitCommand?: string;
  readonly validateCommand?: string;
  readonly children?: ReactNode;
}

Members

MemberTypeRequiredDescriptionRelated types
idstring | undefinedNoThe id member uses the string | undefined contract.
controllerTerminalFormController | undefinedNoThe controller member uses the TerminalFormController | undefined contract.TerminalFormController
onSubmit((values: Readonly<Record<string, unknown>>, signal: AbortSignal) => unknown | Promise<unknown>) | undefinedNoThe onSubmit member uses the ((values: Readonly<Record<string, unknown>>, signal: AbortSignal) => unknown | Promise<unknown>) | undefined contract.
submitCommandstring | undefinedNoThe submitCommand member uses the string | undefined contract.
validateCommandstring | undefinedNoThe validateCommand member uses the string | undefined contract.
childrenReactNodeNoThe children member uses the ReactNode contract.

Source

View the secondary source reference

On this page