FunctionOneBlinkAutoSaveForm

This component is a drop in replacement for OneBlinkForm with the addition of auto save happening periodically to prevent users from losing submission data.

If you need auto saving with a controlled form, see the OneBlinkFormControlled component for a full example.

Param: props

Returns

  • OneBlinkAutoSaveForm(props): null | ReactElement<any, string | JSXElementConstructor<any>>

  • NOTE: Exotic components are not callable.

    Parameters

    • props: OneBlinkReadOnlyFormProps & {
          abnLookupAuthenticationGuid?: string;
          attachmentRetentionInDays?: number;
          buttons?: {
              cancel?: ButtonConfiguration;
              cancelPromptNo?: ButtonConfiguration;
              cancelPromptYes?: ButtonConfiguration;
              saveDraft?: ButtonConfiguration;
              submit?: ButtonConfiguration;
          };
          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: NewDraftSubmission) => unknown);
          onSubmit: ((newFormSubmission: NewFormSubmission) => unknown);
          onUploadAttachment?: ((options: UploadAttachmentConfiguration, abortSignal?: AbortSignal) => Promise<FormSubmissionAttachment>);
          shouldUseNavigableValidationErrorsNotification?: boolean;
      } & OneBlinkFormUncontrolledProps & {
          resumeAtElement?: FormElement;
      } & {
          autoSaveKey: string;
          removeAutoSaveDataBeforeSaveDraft?: boolean;
          removeAutoSaveDataBeforeSubmit?: boolean;
      }

    Returns null | ReactElement<any, string | JSXElementConstructor<any>>

Properties

$$typeof displayName? type

Properties

Readonly$$typeof

$$typeof: symbol

OptionaldisplayName

displayName?: string

Readonlytype

type: ((__namedParameters: OneBlinkReadOnlyFormProps & {
    abnLookupAuthenticationGuid?: string;
    attachmentRetentionInDays?: number;
    buttons?: {
        cancel?: ButtonConfiguration;
        cancelPromptNo?: ButtonConfiguration;
        cancelPromptYes?: ButtonConfiguration;
        saveDraft?: ButtonConfiguration;
        submit?: ButtonConfiguration;
    };
    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: NewDraftSubmission) => unknown);
    onSubmit: ((newFormSubmission: NewFormSubmission) => unknown);
    onUploadAttachment?: ((options: UploadAttachmentConfiguration, abortSignal?: AbortSignal) => Promise<FormSubmissionAttachment>);
    shouldUseNavigableValidationErrorsNotification?: boolean;
} & OneBlinkFormUncontrolledProps & {
    resumeAtElement?: FormElement;
} & {
    autoSaveKey: string;
    removeAutoSaveDataBeforeSaveDraft?: boolean;
    removeAutoSaveDataBeforeSubmit?: boolean;
}) => Element)

Settings

On This Page

Properties