Type alias OneBlinkFormBaseProps

OneBlinkFormBaseProps: OneBlinkReadOnlyFormProps & {
    abnLookupAuthenticationGuid?: string;
    attachmentRetentionInDays?: number;
    buttons?: FormsListStyles["buttons"];
    captchaSiteKey?: string;
    disabled?: boolean;
    handleNavigateAway?: (() => unknown);
    isInfoPage?: "YES" | "NO" | "CALCULATED";
    isPendingQueueEnabled: boolean;
    isPreview?: boolean;
    onCancel: (() => unknown);
    onSaveDraft?: ((newDraftSubmission) => unknown);
    onSubmit: ((newFormSubmission) => unknown);
    onUploadAttachment?: typeof __type;
}

Type declaration

  • Optional abnLookupAuthenticationGuid?: string

    An ABN Lookup Authentication Guid. Required if the form contains a abn form element.

  • Optional attachmentRetentionInDays?: number

    Number of days attachments are retained for.

  • Optional buttons?: FormsListStyles["buttons"]

    Change properties for certain buttons on the form.

  • Optional captchaSiteKey?: string

    A reCAPTCHA Site Key. Required if the form contains a captcha form element.

  • Optional disabled?: boolean

    Whether the form is currently able to be submitted. False by default.

  • Optional handleNavigateAway?: (() => unknown)
      • (): unknown

      • The function to call when the user needs to navigate away from the form. e.g. history.push

        Returns unknown

  • Optional isInfoPage?: "YES" | "NO" | "CALCULATED"

    Determines whether the form is submittable or not. Info page type forms show a "Done" button instead of a "Submit" button. Defaults to "CALCULATED"

  • isPendingQueueEnabled: boolean

    If set to false, submission will be prevented while offline. If set to true, the user will be prompted to allow them to continue with attachments uploading in the background later.

  • Optional isPreview?: boolean

    Whether the form is in preview mode. False by default.

  • onCancel: (() => unknown)
      • (): unknown

      • The function to call when the user cancels the form

        Returns unknown

  • Optional onSaveDraft?: ((newDraftSubmission) => unknown)
      • (newDraftSubmission): unknown

      • The function to call when the user wishes to save their submission data as a draft submission. If not specified, drafts cannot be saved. See NewDraftSubmission for the structure of the argument.

        Parameters

        • newDraftSubmission: submissionService.NewDraftSubmission

        Returns unknown

  • onSubmit: ((newFormSubmission) => unknown)
      • (newFormSubmission): unknown

      • The function to call when the user submits the form with valid submission data. See NewFormSubmission for the structure of the argument.

        Parameters

        • newFormSubmission: submissionService.NewFormSubmission

        Returns unknown

  • Optional onUploadAttachment?: typeof __type

    The function to call when a user uploads an attachment through an element that allows attachment upload. See uploadAttachment for the structure of the argument and a sample function to be used.

Settings

Theme