Beignet API reference
    Preparing search index...

    Type Alias ReactFormContractOptions<TContract, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TSubmitMeta, TValidateOn>

    ReactFormContractOptions: FormOptions<
        FormInput<TContract>,
        TOnMount,
        TOnChange,
        TOnChangeAsync,
        TOnBlur,
        TOnBlurAsync,
        TOnSubmit,
        TOnSubmitAsync,
        TOnDynamic,
        TOnDynamicAsync,
        ServerErrorValidator<FormInput<TContract>>,
        TSubmitMeta,
    > & { validateOn?: TValidateOn }

    Options accepted by formOptions(...) and useForm(...) for one contract.

    These are TanStack Form options for the contract body input, plus validateOn. Both synchronous and asynchronous schemas are awaited. Pass your own validators to add field or form validation alongside the schema; a validator in the async slot validateOn selects overrides it.

    Type Parameters

    • TContract extends HttpContractConfig
    • TOnMount extends undefined | FormValidateOrFn<FormInput<TContract>>
    • TOnChange extends undefined | FormValidateOrFn<FormInput<TContract>>
    • TOnChangeAsync extends undefined | FormAsyncValidateOrFn<FormInput<TContract>>
    • TOnBlur extends undefined | FormValidateOrFn<FormInput<TContract>>
    • TOnBlurAsync extends undefined | FormAsyncValidateOrFn<FormInput<TContract>>
    • TOnSubmit extends undefined | FormValidateOrFn<FormInput<TContract>>
    • TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<FormInput<TContract>>
    • TOnDynamic extends undefined | FormValidateOrFn<FormInput<TContract>>
    • TOnDynamicAsync extends undefined | FormAsyncValidateOrFn<FormInput<TContract>>
    • TSubmitMeta
    • TValidateOn extends ValidateOn

    Type Declaration

    • OptionalvalidateOn?: TValidateOn

      Which TanStack Form async validator slot receives the contract body schema. Defaults to "submit".

    Settings
    Member Visibility