d48cda4081
CI / Test (ubuntu-latest, Node 18.x, bun) (push) Failing after 15m1s
CI / Test (ubuntu-latest, Node 18.x, npm) (push) Failing after 15m1s
CI / Test (ubuntu-latest, Node 18.x, pnpm) (push) Failing after 15m1s
CI / Test (ubuntu-latest, Node 18.x, yarn) (push) Failing after 15m1s
CI / Test (ubuntu-latest, Node 20.x, bun) (push) Failing after 17m13s
CI / Test (ubuntu-latest, Node 20.x, npm) (push) Failing after 18m42s
CI / Test (ubuntu-latest, Node 20.x, pnpm) (push) Failing after 15m0s
CI / Test (ubuntu-latest, Node 20.x, yarn) (push) Failing after 49m44s
CI / Test (ubuntu-latest, Node 22.x, bun) (push) Failing after 51m55s
CI / Test (ubuntu-latest, Node 22.x, pnpm) (push) Failing after 21m57s
CI / Test (ubuntu-latest, Node 22.x, npm) (push) Failing after 37m39s
CI / Test (ubuntu-latest, Node 22.x, yarn) (push) Failing after 34m7s
CI / Validate Components (push) Failing after 37m15s
CI / Python Tests (push) Failing after 10m1s
CI / Security Scan (push) Failing after 10m1s
CI / Lint (push) Failing after 17m12s
CI / Coverage (push) Failing after 20m19s
CI / Test (macos-latest, Node 18.x, bun) (push) Has been cancelled
CI / Test (macos-latest, Node 18.x, npm) (push) Has been cancelled
CI / Test (macos-latest, Node 18.x, pnpm) (push) Has been cancelled
CI / Test (macos-latest, Node 18.x, yarn) (push) Has been cancelled
CI / Test (windows-latest, Node 18.x, npm) (push) Has been cancelled
CI / Test (windows-latest, Node 18.x, pnpm) (push) Has been cancelled
CI / Test (windows-latest, Node 18.x, yarn) (push) Has been cancelled
CI / Test (macos-latest, Node 20.x, bun) (push) Has been cancelled
CI / Test (macos-latest, Node 20.x, npm) (push) Has been cancelled
CI / Test (macos-latest, Node 20.x, pnpm) (push) Has been cancelled
CI / Test (macos-latest, Node 20.x, yarn) (push) Has been cancelled
CI / Test (windows-latest, Node 20.x, npm) (push) Has been cancelled
CI / Test (windows-latest, Node 20.x, pnpm) (push) Has been cancelled
CI / Test (windows-latest, Node 20.x, yarn) (push) Has been cancelled
CI / Test (macos-latest, Node 22.x, bun) (push) Has been cancelled
CI / Test (macos-latest, Node 22.x, npm) (push) Has been cancelled
CI / Test (macos-latest, Node 22.x, pnpm) (push) Has been cancelled
CI / Test (macos-latest, Node 22.x, yarn) (push) Has been cancelled
CI / Test (windows-latest, Node 22.x, npm) (push) Has been cancelled
CI / Test (windows-latest, Node 22.x, pnpm) (push) Has been cancelled
CI / Test (windows-latest, Node 22.x, yarn) (push) Has been cancelled
102 lines
2.4 KiB
Markdown
102 lines
2.4 KiB
Markdown
# Inputs
|
|
|
|
Inputs allow data to flow from a parent component to a child component. Angular recommends using the signal-based `input` API for modern applications.
|
|
|
|
## Signal-based Inputs
|
|
|
|
Declare inputs using the `input()` function. This returns an `InputSignal`.
|
|
|
|
```ts
|
|
import {Component, input, computed} from '@angular/core';
|
|
|
|
@Component({
|
|
selector: 'app-user',
|
|
template: `<p>User: {{ name() }} ({{ age() }})</p>`,
|
|
})
|
|
export class User {
|
|
// Optional input with default value
|
|
name = input('Guest');
|
|
|
|
// Required input
|
|
age = input.required<number>();
|
|
|
|
// Inputs are reactive signals
|
|
label = computed(() => `Name: ${this.name()}`);
|
|
}
|
|
```
|
|
|
|
### Usage in Template
|
|
|
|
```html
|
|
<app-user [name]="userName" [age]="25" />
|
|
```
|
|
|
|
## Configuration Options
|
|
|
|
The `input` function accepts a config object:
|
|
|
|
- **Alias**: Change the property name used in templates.
|
|
- **Transform**: Modify the value before it reaches the component.
|
|
|
|
```ts
|
|
import { input, booleanAttribute } from '@angular/core';
|
|
|
|
@Component({...})
|
|
export class CustomButton {
|
|
// Alias example
|
|
label = input('', { alias: 'btnLabel' });
|
|
|
|
// Transform example using built-in helper
|
|
disabled = input(false, { transform: booleanAttribute });
|
|
}
|
|
```
|
|
|
|
## Model Inputs (Two-Way Binding)
|
|
|
|
Use `model()` to create an input that supports two-way data binding.
|
|
|
|
```ts
|
|
@Component({
|
|
selector: 'custom-counter',
|
|
template: `<button (click)="increment()">+</button>`,
|
|
})
|
|
export class CustomCounter {
|
|
value = model(0);
|
|
|
|
increment() {
|
|
this.value.update((v) => v + 1);
|
|
}
|
|
}
|
|
```
|
|
|
|
### Usage
|
|
|
|
```html
|
|
<!-- Two-way binding with a signal -->
|
|
<custom-counter [(value)]="mySignal" />
|
|
|
|
<!-- Two-way binding with a plain property -->
|
|
<custom-counter [(value)]="myProperty" />
|
|
```
|
|
|
|
## Decorator-based Inputs (@Input)
|
|
|
|
The legacy API remains supported but is not recommended for new code.
|
|
|
|
```ts
|
|
import { Component, Input } from '@angular/core';
|
|
|
|
@Component({...})
|
|
export class Legacy {
|
|
@Input({ required: true }) value = 0;
|
|
@Input({ transform: trimString }) label = '';
|
|
}
|
|
```
|
|
|
|
## Best Practices
|
|
|
|
- **Prefer Signals**: Use `input()` instead of `@Input()` for better reactivity and type safety.
|
|
- **Required Inputs**: Use `input.required()` for mandatory data to get build-time errors.
|
|
- **Pure Transforms**: Ensure input transform functions are pure and statically analyzable.
|
|
- **Avoid Collisions**: Do not use input names that collide with standard DOM properties (e.g., `id`, `title`).
|