Hex Core JS
    Preparing search index...

    Type Alias FormProps<FV>

    FormProps: {
        formState: FormState<FV>;
        mergeUnsavedChangesAutomatically?: boolean;
        name?: string;
        noChangesDialog?: boolean;
        noCloseConfirmation?: boolean;
        noLocalStorage?: boolean;
        noNavigationPrompt?: boolean;
        noToasts?: boolean;
        onSubmit: ReturnType<FormState<FV>["onSubmitWrapper"]>;
    } & Pick<
        UseFormToastsArgs,
        | "ValidationFailureToast"
        | "SubmissionFailureToast"
        | "SubmissionSuccessToast",
    > & Partial<ClassNameProps & StyleProps & ChildrenProps>

    Type Parameters

    Type Declaration

    • formState: FormState<FV>

      The state of the form.

    • OptionalmergeUnsavedChangesAutomatically?: boolean

      Indicates whether unsaved changes should be merged automatically into the form state.

    • Optionalname?: string

      The name of the form, controls localStorage handling, should be unique to the form (including the instance if there is one). Should be in standard localStorage key case style (camelCase with periods to separate for namespacing and hierarchy).

    • OptionalnoChangesDialog?: boolean

      Disables the changes dialog presented for update forms.

    • OptionalnoCloseConfirmation?: boolean

      Disables setting close confirmation (e.g. in a Modal).

    • OptionalnoLocalStorage?: boolean

      Disables localStorage for unsaved changes.

    • OptionalnoNavigationPrompt?: boolean

      Disables navigation blocking with changed fields.

    • OptionalnoToasts?: boolean

      Disables toasts related to submission events.

    • onSubmit: ReturnType<FormState<FV>["onSubmitWrapper"]>

      A submission function to call when the user clicks save/submit.

    Settings

    Member Visibility