input — Angular | Spec-Zone.ru

Функция input позволяет объявлять входные параметры в директивах и компонентах Angular.

Можно объявить два варианта входных параметров:

Необязательные входные параметры с начальным значением.
Обязательные входные параметры, которые должны задавать потребители.

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

Входные параметры являются сигналами. Значения входного параметра доступны как Signal. Сигнал всегда содержит последнее значение входного параметра, переданное родительским компонентом.

API

function input<T>();
function input<T>(initialValue, opts?);
function input<T>(initialValue, opts);
function input<T, TransformT>(initialValue, opts);
function input<T, TransformT>(initialValue, opts);
function input<T>(initialValue, opts);
function input<T>(initialValue, opts);

function input.required<T>(opts?);
function input.required<T, TransformT>(opts);

function input<T>(): InputSignal<T | undefined>;

Инициализирует входной параметр типа T с начальным значением undefined. Angular неявно использует undefined в качестве начального значения.

@returnsInputSignal<T | undefined>

function input<T>(initialValue: T, opts?: InputOptionsWithoutTransform<T> | undefined): InputSignal<T>;

Объявляет входной параметр типа T с явно заданным начальным значением.

@paraminitialValueT

@paramoptsInputOptionsWithoutTransform<T> | undefined

@returnsInputSignal<T>

function input<T>(initialValue: undefined, opts: InputOptionsWithoutTransform<T>): InputSignal<T | undefined>;

Объявляет входной параметр типа T|undefined без начального значения, но с параметрами входного значения

@paraminitialValueundefined

@paramoptsInputOptionsWithoutTransform<T>

@returnsInputSignal<T | undefined>

function input<T, TransformT>(initialValue: T, opts: InputOptionsWithTransform<T, TransformT>): InputSignalWithTransform<T, TransformT>;

Объявляет входной параметр типа T с начальным значением и функцией преобразования.

Входной параметр принимает значения типа TransformT, а указанная функция преобразования преобразует значение к типу T.

@paraminitialValueT

@paramoptsInputOptionsWithTransform<T, TransformT>

@returnsInputSignalWithTransform<T, TransformT>

function input<T, TransformT>(initialValue: undefined, opts: InputOptionsWithTransform<T | undefined, TransformT>): InputSignalWithTransform<T | undefined, TransformT>;

Объявляет входной параметр типа T|undefined без начального значения и с функцией преобразования.

Входной параметр принимает значения типа TransformT, а указанная функция преобразования преобразует значение к типу T|undefined.

@paraminitialValueundefined

@paramoptsInputOptionsWithTransform<T | undefined, TransformT>

@returnsInputSignalWithTransform<T | undefined, TransformT>

function input<T>(initialValue: T, opts: InputOptionsWithTransform<T, unknown>): InputSignalWithTransform<T, T>;

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

@paraminitialValueT

@paramoptsInputOptionsWithTransform<T, unknown>

@returnsInputSignalWithTransform<T, T>

function input<T>(initialValue: undefined, opts: InputOptionsWithTransform<T | undefined, unknown>): InputSignalWithTransform<T | undefined, T | undefined>;

Объявляет входной параметр типа T|undefined без начального значения и с функцией преобразования, принимающей значения того же типа.

@paraminitialValueundefined

@paramoptsInputOptionsWithTransform<T | undefined, unknown>

@returnsInputSignalWithTransform<T | undefined, T | undefined>

function input.required<T>(opts?: InputOptionsWithoutTransform<T> | undefined): InputSignal<T>;

Объявляет обязательный входной параметр типа T.

@paramoptsInputOptionsWithoutTransform<T> | undefined

@returnsInputSignal<T>

function input.required<T, TransformT>(opts: InputOptionsWithTransform<T, TransformT>): InputSignalWithTransform<T, TransformT>;

Объявляет обязательный входной параметр типа T с функцией преобразования.

@paramoptsInputOptionsWithTransform<T, TransformT>

@returnsInputSignalWithTransform<T, TransformT>

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

Чтобы использовать входные параметры на основе сигналов, импортируйте input из @angular/core.

import {input} from '@angular/core';

В компоненте добавьте новый член класса и инициализируйте его вызовом input или input.required.

@Component({
  ...
})
export class UserProfileComponent {
  firstName = input<string>();             // Signal<string|undefined>
  lastName  = input.required<string>();    // Signal<string>
  age       = input(0)                     // Signal<number>
}

В шаблоне компонента значения входных параметров можно отображать, вызывая сигнал.

<span>{{firstName()}}</span>