hub / github.com/TanStack/form / useFieldGroup

Function useFieldGroup

packages/react-form/src/useFieldGroup.tsx:89–258 · view source on GitHub ↗

(opts: {
  form:
    | AppFieldExtendedReactFormApi<
        TFormData,
        TOnMount,
        TOnChange,
        TOnChangeAsync,
        TOnBlur,
        TOnBlurAsync,
        TOnSubmit,
        TOnSubmitAsync,
        TOnDynamic,
        TOnDynamicAsync,
        TOnServer,
        TSubmitMeta,
        TComponents,
        TFormComponents
      >
    | AppFieldExtendedReactFieldGroupApi<
        // Since this only occurs if you nest it within other form lenses, it can be more
        // lenient with the types.
        unknown,
        TFormData,
        string | FieldsMap<unknown, TFormData>,
        any,
        any,
        any,
        any,
        any,
        any,
        any,
        any,
        any,
        any,
        TSubmitMeta,
        TComponents,
        TFormComponents
      >
  fields: TFields
  defaultValues?: TFieldGroupData
  onSubmitMeta?: TSubmitMeta
  formComponents: TFormComponents
})

Source from the content-addressed store, hash-verified

87	}
88
89	export function useFieldGroup<
90	TFormData,
91	TFieldGroupData,
92	TFields extends
93	\| DeepKeysOfType<TFormData, TFieldGroupData \| null \| undefined>
94	\| FieldsMap<TFormData, TFieldGroupData>,
95	TOnMount extends undefined \| FormValidateOrFn<TFormData>,
96	TOnChange extends undefined \| FormValidateOrFn<TFormData>,
97	TOnChangeAsync extends undefined \| FormAsyncValidateOrFn<TFormData>,
98	TOnBlur extends undefined \| FormValidateOrFn<TFormData>,
99	TOnBlurAsync extends undefined \| FormAsyncValidateOrFn<TFormData>,
100	TOnSubmit extends undefined \| FormValidateOrFn<TFormData>,
101	TOnSubmitAsync extends undefined \| FormAsyncValidateOrFn<TFormData>,
102	TOnDynamic extends undefined \| FormValidateOrFn<TFormData>,
103	TOnDynamicAsync extends undefined \| FormAsyncValidateOrFn<TFormData>,
104	TOnServer extends undefined \| FormAsyncValidateOrFn<TFormData>,
105	TComponents extends Record<string, ComponentType<any>>,
106	TFormComponents extends Record<string, ComponentType<any>>,
107	TSubmitMeta = never,
108	>(opts: {
109	form:
110	\| AppFieldExtendedReactFormApi<
111	TFormData,
112	TOnMount,
113	TOnChange,
114	TOnChangeAsync,
115	TOnBlur,
116	TOnBlurAsync,
117	TOnSubmit,
118	TOnSubmitAsync,
119	TOnDynamic,
120	TOnDynamicAsync,
121	TOnServer,
122	TSubmitMeta,
123	TComponents,
124	TFormComponents
125	>
126	\| AppFieldExtendedReactFieldGroupApi<
127	// Since this only occurs if you nest it within other form lenses, it can be more
128	// lenient with the types.
129	unknown,
130	TFormData,
131	string \| FieldsMap<unknown, TFormData>,
132	any,
133	any,
134	any,
135	any,
136	any,
137	any,
138	any,
139	any,
140	any,
141	any,
142	TSubmitMeta,
143	TComponents,
144	TFormComponents
145	>
146	fields: TFields

Callers 1

withFieldGroupFunction · 0.90

Calls

no outgoing calls

Tested by

no test coverage detected