Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "frontend-packages/react-cookie-banner-admin/src/hooks/useFormHandler"

Index

Functions

Functions

useFormHandler

  • useFormHandler<Values>(__namedParameters: { defaultValues: Record<string, any>; handleSave: (value: Values) => Promise<void>; i18n: { successMessage: string; unloadConfirm: string; unloadConfirmInitialActive?: string; validationError: string }; initialHasChanges: boolean; trackFieldsDifferFromDefaultValues: keyof Values[] }): { form: FormInstance<Values>; hasChanges: boolean; hasTrackedFieldDifferenceToDefaultValue: hasTrackedFieldDifferenceToDefaultValue; isBusy: boolean; onBeforeUnload: (Anonymous function); onFinish: (values: Values) => void; onFinishFailed: (errorInfo: ValidateErrorEntity<Values>) => void; onValuesChange: (Anonymous function) }
  • Type parameters

    • Values: Record<string, any>

    Parameters

    • __namedParameters: { defaultValues: Record<string, any>; handleSave: (value: Values) => Promise<void>; i18n: { successMessage: string; unloadConfirm: string; unloadConfirmInitialActive?: string; validationError: string }; initialHasChanges: boolean; trackFieldsDifferFromDefaultValues: keyof Values[] }
      • defaultValues: Record<string, any>
      • handleSave: (value: Values) => Promise<void>
          • (value: Values): Promise<void>
          • Parameters

            • value: Values

            Returns Promise<void>

      • i18n: { successMessage: string; unloadConfirm: string; unloadConfirmInitialActive?: string; validationError: string }
        • successMessage: string
        • unloadConfirm: string
        • Optional unloadConfirmInitialActive?: string
        • validationError: string
      • initialHasChanges: boolean
      • trackFieldsDifferFromDefaultValues: keyof Values[]

    Returns { form: FormInstance<Values>; hasChanges: boolean; hasTrackedFieldDifferenceToDefaultValue: hasTrackedFieldDifferenceToDefaultValue; isBusy: boolean; onBeforeUnload: (Anonymous function); onFinish: (values: Values) => void; onFinishFailed: (errorInfo: ValidateErrorEntity<Values>) => void; onValuesChange: (Anonymous function) }

    • form: FormInstance<Values>
    • hasChanges: boolean
    • hasTrackedFieldDifferenceToDefaultValue: hasTrackedFieldDifferenceToDefaultValue
    • isBusy: boolean
    • onBeforeUnload: (Anonymous function)
    • onFinish: (values: Values) => void
        • (values: Values): void
        • Parameters

          • values: Values

          Returns void

    • onFinishFailed: (errorInfo: ValidateErrorEntity<Values>) => void
        • (errorInfo: ValidateErrorEntity<Values>): void
        • Parameters

          • errorInfo: ValidateErrorEntity<Values>

          Returns void

    • onValuesChange: (Anonymous function)

Generated using TypeDoc