API reference > @kontsedal/olas-core > FieldArray

FieldArray type

A dynamically-sized list of Field or Form items. Created viacreateFieldArray(ctx, itemFactory, options?). The factory is invoked per insertion. Spec §8, §20.7.

A field array is a ReadSignal of its items' values, like a Field:array.value is FieldArrayValue<I>. items holds the item nodes.

Signature:

type FieldArray<I extends Field<any> | Form<any>> = ReadSignal<FieldArrayValue<I>> & {
  readonly items: ReadSignal<ReadonlyArray<I>>;
  readonly errors: ReadSignal<Array<FieldArrayItemErrors<I> | undefined>>;
  readonly topLevelErrors: ReadSignal<string[]>;
  readonly isValid: ReadSignal<boolean>;
  readonly isDirty: ReadSignal<boolean>;
  readonly touched: ReadSignal<boolean>;
  readonly isValidating: ReadSignal<boolean>;
  readonly size: ReadSignal<number>;
  add(initial?: ItemInitial<I>): void;
  insert(index: number, initial?: ItemInitial<I>): void;
  remove(index: number): void;
  move(from: number, to: number): void;
  at(index: number): I | undefined;
  clear(): void;
  set(values: ReadonlyArray<ItemInitial<I>>): void;
  setAsInitial(values: ReadonlyArray<ItemInitial<I>>): void;
  reset(): void;
  markAllTouched(): void;
  validate(): Promise<boolean>;
  dispose(): void;
};

References: Field, Form, ReadSignal, FieldArrayValue, FieldArrayItemErrors, ItemInitial