Type alias WizardBaseInfoFormView<TFormCustomFields>

WizardBaseInfoFormView<TFormCustomFields>: React.ComponentType<{
    blockProps: BlockComponentProps;
    defaultValues?: Partial<BasicUserInformationInputFormData<TFormCustomFields>>;
    handleCancel?: (() => void);
    handleSubmit: ((formData) => Promise<unknown>);
    progress: {
        current: number;
        isLastPage: boolean;
        total: number;
    };
}>

Type for a standard Form View for the WizardBaseInfo block

Type Parameters

  • TFormCustomFields

Type declaration

  • blockProps: BlockComponentProps

    Standard BlockProps

  • Optional defaultValues?: Partial<BasicUserInformationInputFormData<TFormCustomFields>>

    Default values for the form

  • Optional handleCancel?: (() => void)

    Callback to handle form cancelation

      • (): void
      • Callback to handle form cancelation

        Returns void

  • handleSubmit: ((formData) => Promise<unknown>)

    Callback to handle form submission

  • progress: {
        current: number;
        isLastPage: boolean;
        total: number;
    }

    Progress information (for displaying step component and similar)

    • current: number

      Current page number (indexed from 1)

    • isLastPage: boolean

      When true, this is the last page in the wizard

    • total: number

      Total number of pages

Generated using TypeDoc