Accepting data with input properties

When creating a component, you can mark specific class properties as bindable by adding the @Input decorator on the property:

      
@Component({...})
export class CustomSlider {
  @Input() value = 0;
}
    

This lets you bind to the property in a template:

      
<custom-slider [value]="50" />
    

Angular refers to properties marked with the @Input decorator as inputs. When using a component, you pass data to it by setting its inputs.

Angular records inputs statically at compile-time. Inputs cannot be added or removed at run-time.

When extending a component class, inputs are inherited by the child class.

Input names are case-sensitive.

Customizing inputs

The @Input decorator accepts a config object that lets you change the way that input works.

Required inputs

You can specify the required option to enforce that a given input must always have a value.

      
@Component({...})
export class CustomSlider {
  @Input({required: true}) value = 0;
}
    

If you try to use a component without specifying all of its required inputs, Angular reports an error at build-time.

Input transforms

You can specify a transform function to change the value of an input when it's set by Angular.

      
@Component({
  selector: 'custom-slider',
  ...
})
export class CustomSlider {
  @Input({transform: trimString}) label = '';
}
function trimString(value: string | undefined) {
  return value?.trim() ?? '';
}
    

      
<custom-slider [label]="systemVolume" />
    

In the example above, whenever the value of systemVolume changes, Angular runs trimString and sets label to the result.

The most common use-case for input transforms is to accept a wider range of value types in templates, often including null and undefined.

Input transform function must be statically analyzable at build-time. You cannot set transform functions conditionally or as the result of an expression evaluation.

Input transform functions should always be pure functions. Relying on state outside of the transform function can lead to unpredictable behavior.

Type checking

When you specify an input transform, the type of the transform function's parameter determines the types of values that can be set to the input in a template.

      
@Component({...})
export class CustomSlider {
  @Input({transform: appendPx}) widthPx: string = '';
}
function appendPx(value: number) {
  return `${value}px`;
}
    

In the example above, the widthPx input accepts a number while the property on the class is a string.

Built-in transformations

Angular includes two built-in transform functions for the two most common scenarios: coercing values to boolean and numbers.

      
import {Component, Input, booleanAttribute, numberAttribute} from '@angular/core';
@Component({...})
export class CustomSlider {
  @Input({transform: booleanAttribute}) disabled = false;
  @Input({transform: numberAttribute}) number = 0;
}
    

booleanAttribute imitates the behavior of standard HTML boolean attributes, where the presence of the attribute indicates a "true" value. However, Angular's booleanAttribute treats the literal string "false" as the boolean false.

numberAttribute attempts to parse the given value to a number, producing NaN if parsing fails.

Input aliases

You can specify the alias option to change the name of an input in templates.

      
@Component({...})
export class CustomSlider {
  @Input({alias: 'sliderValue'}) value = 0;
}
    

      
<custom-slider [sliderValue]="50" />
    

This alias does not affect usage of the property in TypeScript code.

While you should generally avoid aliasing inputs for components, this feature can be useful for renaming properties while preserving an alias for the original name or for avoiding collisions with the name of native DOM element properties.

The @Input decorator also accepts the alias as its first parameter in place of the config object.

Inputs with getters and setters

A property implemented with a getter and setter can be an input:

      
export class CustomSlider {
  @Input()
  get value(): number {
    return this.internalValue;
  }
  set value(newValue: number) {
    this.internalValue = newValue;
  }
  private internalValue = 0;
}
    

You can even create a write-only input by only defining a public setter:

      
export class CustomSlider {
  @Input()
  set value(newValue: number) {
    this.internalValue = newValue;
  }
  private internalValue = 0;
}
    

Prefer using input transforms instead of getters and setters if possible.

Avoid complex or costly getters and setters. Angular may invoke an input's setter multiple times, which may negatively impact application performance if the setter performs any costly behaviors, such as DOM manipulation.

Specify inputs in the @Component decorator

In addition to the @Input decorator, you can also specify a component's inputs with the inputs property in the @Component decorator. This can be useful when a component inherits a property from a base class:

      
// `CustomSlider` inherits the `disabled` property from `BaseSlider`.
@Component({
  ...,
  inputs: ['disabled'],
})
export class CustomSlider extends BaseSlider { }
    

You can additionally specify an input alias in the inputs list by putting the alias after a colon in the string:

      
// `CustomSlider` inherits the `disabled` property from `BaseSlider`.
@Component({
  ...,
  inputs: ['disabled: sliderDisabled'],
})
export class CustomSlider extends BaseSlider { }
    

Choosing input names

Avoid choosing input names that collide with properties on DOM elements like HTMLElement. Name collisions introduce confusion about whether the bound property belongs to the component or the DOM element.

Avoid adding prefixes for component inputs like you would with component selectors. Since a given element can only host one component, any custom properties can be assumed to belong to the component.