Type AliasOneBlinkFormBaseProps

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

Type declaration

  • OptionalabnLookupAuthenticationGuid?: string

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

  • OptionalattachmentRetentionInDays?: number

    Number of days attachments are retained for.

  • Optionalbuttons?: FormsListStyles["buttons"]

    Change properties for certain buttons on the form.

  • OptionalcaptchaSiteKey?: string

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

  • OptionalcaptchaType?: CaptchaType

    Determines whether to use checkboxes or invisible recaptcha v2 for captcha elements. Defaults to "CHECKBOX"

  • Optionaldisabled?: boolean

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

  • OptionalhandleNavigateAway?: (() => unknown)

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

      • (): unknown

      • Returns unknown

  • OptionalisInfoPage?: "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.

  • OptionalisPreview?: boolean

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

  • OptionalnavigableValidationErrorsNotificationSettings?: {
        navigationTopOffset?: number;
        scrollableContainerId?: string;
    }

    Various settings for the navigable validation errors notification

    • OptionalnavigationTopOffset?: number

      A pixel offset for validation error navigation markers. Use this to account for any headers your page might have. If not set, we will attempt to calculate the offset for you. Please note: Calculating this value is not supported when passing in a scrollableContainerId.

    • OptionalscrollableContainerId?: string

      The HTML Element ID of the scrollable container your form resides in. If not set, will scroll on the window.

  • onCancel: (() => unknown)

    The function to call when the user cancels the form

      • (): unknown

      • Returns unknown

  • OptionalonSaveDraft?: ((newDraftSubmission: submissionService.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.

      • (newDraftSubmission): unknown

      • Parameters

        • newDraftSubmission: submissionService.NewDraftSubmission

        Returns unknown

  • onSubmit: ((newFormSubmission: submissionService.NewFormSubmission) => unknown)

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

      • (newFormSubmission): unknown

      • Parameters

        • newFormSubmission: submissionService.NewFormSubmission

        Returns unknown

  • OptionalonUploadAttachment?: 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.

  • OptionalshouldUseNavigableValidationErrorsNotification?: boolean

    Whether the form should use a navigable validation errors notification, or a simple validation errors notification

    Default

    true

Settings