Skip to content
Source
Sign inSign up
TanStack/form
Open History to see the last commit

TanStackArrayField.md

212 lines4.4 KB

Defined in: tanstack-field.ts:282

Extends

  • TanStackFieldBase<TSource, TFieldName, TFieldValue, TFieldValidators>

Extended by

Type Parameters

TSource

TSource extends AngularFieldSource

TFieldName

TFieldName extends DeepKeys<AngularFieldData<TSource>>

TFieldValue

TFieldValue extends DeepValue<AngularFieldData<TSource>, TFieldName>

TFieldValidators

TFieldValidators extends FieldValidators<AngularFieldData<TSource>, TFieldName, TFieldValue>

Constructors

Constructor

new TanStackArrayField<TSource, TFieldName, TFieldValue, TFieldValidators>(): TanStackArrayField<TSource, TFieldName, TFieldValue, TFieldValidators>;

Defined in: tanstack-field.ts:201

Returns

TanStackArrayField<TSource, TFieldName, TFieldValue, TFieldValidators>

Inherited from

TanStackFieldBase<
  TSource,
  TFieldName,
  TFieldValue,
  TFieldValidators
>.constructor

Properties

errorBoundary

errorBoundary: InputSignal<boolean | undefined>;

Defined in: tanstack-field.ts:152

Inherited from

TanStackFieldBase.errorBoundary

errorVisibility

errorVisibility: InputSignal<
  | ErrorVisibility<AngularParentFormData<TSource>, AngularSourceFormErrorTypes<TSource>>
| undefined>;

Defined in: tanstack-field.ts:145

Inherited from

TanStackFieldBase.errorVisibility

isArrayField

protected readonly isArrayField: true = true;

Defined in: tanstack-field.ts:298

Overrides

TanStackFieldBase.isArrayField

listeners

listeners: InputSignal<
  | NoInfer<FieldListeners<AngularFieldData<TSource>, TFieldName, TFieldValue, FallbackToValidationIssue<
  | ExtractValidatorFieldError<TFieldValidators, FieldValidators<any, any, any>>
  | ExtractFormFieldError<AngularSourceFormErrorTypes<TSource>>
  | unknown extends AngularSourceGroupFieldError<TSource> ? never : AngularSourceGroupFieldError<TSource>>, AngularParentFormData<TSource>, AngularSourceFormErrorTypes<TSource>>>
| undefined>;

Defined in: tanstack-field.ts:128

Inherited from

TanStackFieldBase.listeners

name

name: InputSignal<TFieldName>;

Defined in: tanstack-field.ts:126

Inherited from

TanStackFieldBase.name

tanstackArrayField

tanstackArrayField: InputSignal<TSource>;

Defined in: tanstack-field.ts:297


validators

validators: InputSignal<NoInfer<TFieldValidators> | undefined>;

Defined in: tanstack-field.ts:127

Inherited from

TanStackFieldBase.validators

Accessors

api

Get Signature

get api(): AngularSourceFieldApi<TSource, TFieldName, TFieldValue, TFieldValidators>;

Defined in: tanstack-field.ts:190

Returns

AngularSourceFieldApi<TSource, TFieldName, TFieldValue, TFieldValidators>

Inherited from

TanStackFieldBase.api

Methods

getSource()

protected getSource(): TSource;

Defined in: tanstack-field.ts:299

Returns

TSource

Overrides

TanStackFieldBase.getSource