커스텀 이벤트 보내기

팁: 이 가이드 문서는 핵심 가이드 이후 내용을 다룹니다. 아직 Angular에 익숙하지 않다면 해당 문서를 먼저 읽어보세요.

컴포넌트는 output 함수로 출력 프로퍼티를 선언해서 커스텀 이벤트를 정의할 수 있습니다:

      
@Component({/*...*/})export class ExpandablePanel {  panelClosed = output<void>();}
    

      
<expandable-panel (panelClosed)="savePanelState()" />
    

output 함수를 실행하면 OutputEmitterRef 객체를 반환합니다. 그리고 OutputEmitterRef 객체의 emit 메서드를 실행하면 이벤트를 보낼 수 있습니다:

      
this.panelClosed.emit();
    

Angular에서 output 함수로 초기화한 프로퍼티를 출력 프로퍼티(outputs) 라고 합니다. 출력 프로퍼티는 click과 같은 네이티브 브라우저 이벤트와 비슷하게 동작하는 커스텀 이벤트를 발생시키는 용도로 사용합니다.

Angular 커스텀 이벤트는 DOM을 따라 버블 업(bubble up) 되지 않습니다.

출력 프로퍼티 이름은 대소문자를 구분합니다.

컴포넌트 클래스를 상속하면, 자식 클래스에도 출력 프로퍼티가 상속됩니다.

output 함수는 Angular 컴파일러가 특별하게 감지하는 함수입니다. 컴포넌트나 디렉티브 프로퍼티 선언하는 용도 외 코드에서만 output 함수를 실행할 수 있습니다.

이벤트 데이터 보내기

emit 메서드를 실행하면서 이벤트 데이터를 보낼 수 있습니다:

      
// 기본 자료형을 보낼 수 있습니다.this.valueChanged.emit(7);// 커스텀 이벤트 객체를 보낼 수도 있습니다.this.thumbDropped.emit({pointerX: 123,pointerY: 456,})
    

이벤트 데이터를 활용하려면 템플릿에서 이벤트 리스너를 연결할 때 $event 변수를 인자로 전달하면 됩니다:

      
<custom-slider (valueChanged)="logValue($event)" />
    

별칭으로 사용하기

템플릿에서 이벤트 이름을 프로퍼티 이름과 다르게 사용하려면 output 함수를 실행하면서 설정하면 됩니다:

      
@Component({/*...*/})export class CustomSlider {  changed = output({alias: 'valueChanged'});}
    

      
<custom-slider (valueChanged)="saveVolume()" />
    

이렇게 별칭을 지정해도 TypeScript 코드에는 영향을 주지 않습니다.

일반적으로는 컴포넌트 출력 프로퍼티의 별칭을 지정하지 않는 것이 좋지만, 기존 프로퍼티 이름이 네이티브 DOM 이벤트 이름과 충돌하는 경우 유용할 수 있습니다.

코드로 출력 프로퍼티 구독하기

컴포넌트를 동적으로 생성했다면, 컴포넌트 인스턴스의 출력 프로퍼티 이벤트를 코드로 구독할 수 있습니다. OutputRef 타입의 subscribe 메서드를 실행하면 됩니다:

      
const someComponentRef: ComponentRef<SomeComponent> = viewContainerRef.createComponent(/*...*/);someComponentRef.instance.someEventProperty.subscribe(eventData => {  console.log(eventData);});
    

이렇게 구독하는 이벤트는 컴포넌트 인스턴스가 종료되면 자동으로 종료됩니다. 필요하다면 이벤트를 직접 구독 중지할 수도 있습니다. subscribe 함수가 반환하는 OutputRefSubscription 객체의 unsubscribe 메서드를 실행하면 됩니다:

      
const eventSubscription = someComponent.someEventProperty.subscribe(eventData => {  console.log(eventData);});// ...eventSubscription.unsubscribe();
    

이벤트 이름 결정하기

출력 프로퍼티의 이름을 결정할 때 HTMLElement와 같은 DOM 엘리먼트의 이벤트와 같은 이름은 피하세요. 이벤트 이름이 충돌되면 이벤트가 발생했을 때 이 이벤트가 컴포넌트에서 왔는지 DOM 엘리먼트에서 왔는지 혼동될 수 있습니다.

컴포넌트 셀렉터를 지정하던 것처럼 출력 프로퍼티에 접두사를 추가하지 마세요. 엘리먼트 하나는 컴포넌트 하나만 호스팅 할 수 있기 때문에, 접두사가 없어도 커스텀 프로퍼티는 해당 컴포넌트에서 존재하는 것으로 간주할 수 있습니다.

출력 프로퍼티 이름은 캐멀 케이스(camelCase)로 지정하세요. "on" 접두사는 사용하지 마세요.

RxJS와 함께 사용하기

출력 프로퍼티와 RxJS를 함께 사용하는 방법은 컴포넌트, 디렉티브 출력 프로퍼티와 RxJS 상호작용 문서를 참고하세요.

@Output 데코레이터로 출력 프로퍼티 선언하기

팁: Angular 팀은 새 프로젝트부터 output 함수 사용을 권장하지만, Output 데코레이터를 사용하는 방식도 여전히 완벽하게 지원합니다.

커스텀 이벤트는 프로퍼티에 @Output 데코레이터를 붙이고 EventEmitter 인스턴스를 생성하는 방식으로 선언할 수도 있습니다:

      
@Component({/*...*/})export class ExpandablePanel {  @Output() panelClosed = new EventEmitter<void>();}
    

이 경우는 EventEmitter 객체의 emit 메서드를 실행해서 이벤트를 보낼 수 있습니다.

@Output 데코레이터로 별칭 지정하기

템플릿에서 이벤트 이름을 출력 프로퍼티와 다르게 사용하려면 @Output 데코레이터에 별칭을 지정하면 됩니다:

      
@Component({/*...*/})export class CustomSlider {  @Output('valueChanged') changed = new EventEmitter<number>();}
    

      
<custom-slider (valueChanged)="saveVolume()" />
    

이렇게 별칭을 지정하더라도 TypeScript 코드에서 출력 프로퍼티를 활용하는 코드에는 영향을 주지 않습니다.

@Component 데코레이터로 출력 프로퍼티 선언하기

@Output 데코레이터를 사용하는 방법 외에도, @Component 데코레이터의 outputs 프로퍼티를 사용하면 컴포넌트 출력 프로퍼티를 선언할 수 있습니다. 이 방식은 컴포넌트를 상속받는 경우에 유용합니다:

      
// `CustomSlider` 는 `BaseSlider` 에 있는 `valueChanged` 프로퍼티를 상속받습니다.@Component({  /*...*/  outputs: ['valueChanged'],})export class CustomSlider extends BaseSlider {}
    

그리고 outputs를 선언하면서 콜론을 붙이고 문자열을 붙이면 출력 프로퍼티의 별칭을 지정할 수 있습니다:

      
// `CustomSlider` 는 `BaseSlider` 에 있는 `valueChanged` 프로퍼티를 상속받습니다.@Component({  /*...*/  outputs: ['valueChanged: volumeChanged'],})export class CustomSlider extends BaseSlider {}