compatForm — Angular | Spec-Zone.ru

Создает форму совместимости, обернутую вокруг предоставленных данных модели.

API

function compatForm<TModel>(model: WritableSignal<TModel>): FieldTree<TModel>;
function compatForm<TModel>(
  model: WritableSignal<TModel>,
  schemaOrOptions: any,
): FieldTree<TModel>;
function compatForm<TModel>(
  model: WritableSignal<TModel>,
  schema: SchemaOrSchemaFn<TModel>,
  options: CompatFormOptions<TModel>,
): FieldTree<TModel>;

function compatForm<TModel>(model: WritableSignal<TModel>): FieldTree<TModel>;

Создает форму совместимости, обернутую вокруг предоставленных данных модели.

compatForm — это версия функции form, предназначенная для обратной совместимости с реактивными формами благодаря поддержке реактивных элементов управления в качестве части данных.

@parammodelWritableSignal<TModel>

Записываемый сигнал, содержащий данные модели для формы. Структура полей результата будет соответствовать структуре модели, а любые изменения данных формы будут записываться в модель.

@returnsFieldTree<TModel>

Примечания по использованию

const lastName = new FormControl('lastName');

const nameModel = signal({
   first: '',
   last: lastName
});

const nameForm = compatForm(nameModel, (name) => {
  required(name.first);
});

nameForm.last().value(); // lastName, not FormControl

function compatForm<TModel>(model: WritableSignal<TModel>, schemaOrOptions: any): FieldTree<TModel>;

Создает форму совместимости, обернутую вокруг предоставленных данных модели.

@parammodelWritableSignal<TModel>

@paramschemaOrOptionsany

Второй аргумент может быть одним из следующих вариантов:

Схема или функция, используемая для задания логики формы (например, проверки, отключенные поля и т. д.). При передаче схемы параметры формы при необходимости можно передать третьим аргументом.
Параметры формы (за исключением адаптера, поскольку он предоставляется).

@returnsFieldTree<TModel>

Примечания по использованию

const lastName = new FormControl('lastName');

const nameModel = signal({
   first: '',
   last: lastName
});

const nameForm = compatForm(nameModel, (name) => {
  required(name.first);
});

nameForm.last().value(); // lastName, not FormControl

function compatForm<TModel>(model: WritableSignal<TModel>, schema: SchemaOrSchemaFn<TModel>, options: CompatFormOptions<TModel>): FieldTree<TModel>;

Создает форму совместимости, обернутую вокруг предоставленных данных модели.

@parammodelWritableSignal<TModel>

@paramschemaSchemaOrSchemaFn<TModel>

@paramoptionsCompatFormOptions<TModel>

Параметры формы (за исключением адаптера, поскольку он предоставляется).

@returnsFieldTree<TModel>

Примечания по использованию

const lastName = new FormControl('lastName');

const nameModel = signal({
   first: '',
   last: lastName
});

const nameForm = compatForm(nameModel, (name) => {
  required(name.first);
});

nameForm.last().value(); // lastName, not FormControl

Описание

Создает форму совместимости, обернутую вокруг предоставленных данных модели.

Примечания по использованию

const lastName = new FormControl('lastName');

const nameModel = signal({
   first: '',
   last: lastName
});

const nameForm = compatForm(nameModel, (name) => {
  required(name.first);
});

nameForm.last().value(); // lastName, not FormControl