TanStack
API Reference

FieldGroupApi

Interface: FieldGroupApi<TFieldData, TFieldComponents>

Defined in: packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:174

Extends

  • FormApiFieldMethods<TFieldData>.FormApiArrayMethods<TFieldData>

Type Parameters

TFieldData

TFieldData

TFieldComponents

TFieldComponents extends Record<string, FunctionComponent<any>> = Record<never, never>

Properties

ArrayField

ts
ArrayField: FieldGroupArrayFieldComponent<TFieldData, TFieldComponents>;

Defined in: packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:182


atom

ts
atom: ReadonlyAtom<TFieldData>;

Defined in: packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:180


Field

ts
Field: FieldGroupFieldComponent<TFieldData, TFieldComponents>;

Defined in: packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:181


Subscribe

ts
Subscribe: FieldGroupSubscribeComponent;

Defined in: packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:183