Angular2でoutputs、@Output、EventEmitterを使ってカスタムイベントを定義

ユーザー定義のディレクティブで、outputs、@Output、EventEmitterを使ってカスタムイベントを定義する方法を確認し、サンプルを作成しました。
※Angular2の2.0.0版、TypeScriptを使って確認したものです。(デモはv4.4.3、v2.0.0で動作確認)

※目次をクリックすると目次の下部にコンテンツが表示されます。

outputs属性、@Output
カスタムディレクティブで、output属性を使って、呼び出し側ディレクティブへイベント発行行う事ができます。
 
●宣言方法
 
①コンポーネントのクラス内で宣言
 
@Output() propertyName = new EventEmitter();
 
※以下のようにOutput、EventEmitterをインポートする必要がある。
import {Output, EventEmitter} from ‘@angular/core’;
 
②@Componentデコレーターの属性で指定
 
@Component({
 outputs: [‘propertyName’],
})
※EventEmitterのインポートは必要。
import {EventEmitter} from ‘angular2/core’;
 
●プロパティ名を別名にする場合
 
①コンポーネントのクラス内で宣言
 
@Output(‘alias’) propertyName = new EventEmitter();
 
②デコレーター内の属性で指定
 
@Directive({
 outputs:[‘propertyName:alias’]
})

カスタムイベントを使ったサンプル
●仕様
 
①メインコンポーネント
・会員データを保持し、リストを表示。
・各メンバー表示ディレクティブからの”done”イベント受信で該当会員を削除。
 
②各メンバー表示ディレクティブ
・各会員データの表示、削除処理を行う。
・以下のように利用する”member-item”というセレクタ名のカスタムディレクティブを作成。
<member-item [item]=”member”
(done)=”removeItem($event)”></member-item>
・プロパティバインディング([item]=”member”)でメイン側から各メンバー情報をinputs属性で受け取る。
・”done”という名称のカスタムイベントを定義。各メンバーを削除した際、outputs属性を使ってイベントを発行し、呼び出し先に削除した会員のIDを通知する。
 
●設定方法
 
①各メンバー表示ディレクティブでカスタムイベント”done”を定義
@Output() done = new EventEmitter();
 
②メインコンポーネントで”done”イベント受信時のハンドラーを定義

(テンプレート)
<member-item [item]="member"
          (done)="removeItem($event)"></member-item>
 
(コンポーネントクラス)
  removeItem(id) {
    for(var i=0; i<this.members.length; i++){
      if(this.members[i].id == id){
        this.members.splice(i, 1);
      }
    }
  }

 
③各メンバー表示ディレクティブでイベント発行の定義
ユーザーが”Delete”ボタンクリック時に”done”イベントを発行する。
“done”イベントは、EventEmitter()のemitメソッドで該当会員のIDを渡す。

(テンプレート)
<button class="btn btn-default btn-xs" 
       (click)="doneClicked()">Delete</button>
 
(コンポーネントクラス)
  doneClicked() {
    this.done.emit(this.item.id);
  }

 
④メインコンポーネントが”done”イベントを受信するとremoveItemメソッドを実行する。

デモ
Angular : 4.4.3(2.0.0でも動作確認済み)
Bootstrap : 3.x

Loading…

<html>
  <head>
    <title>Angular 2 Demo</title>
    <script src="https://npmcdn.com/core-js/client/shim.min.js"></script>
    <script src="https://unpkg.com/zone.js@0.7.4?main=browser"></script>
    <script src="https://npmcdn.com/systemjs@0.19.39/dist/system.src.js"></script>
    <script src="./js/systemjs.config.js"></script>
    <script>
      System.import('./ts/app.ts').catch(function(err){ console.error(err);  });    </script>
    <link rel="stylesheet" href="./css/bootstrap.min.css">
    <link rel="stylesheet" href="./css/styles.css">
  </head>
  <body>
    <div class="container">
      <my-app>Loading...</my-app>
    </div>
  </body>
</html>

(systemjs.config.js)
(function (global) {
  var ngVer = '@4.4.3';
  System.config({
    transpiler: 'ts',
    typescriptOptions: {
      "target": "es5",
      "module": "commonjs",
      "moduleResolution": "node",
      "sourceMap": true,
      "emitDecoratorMetadata": true,
      "experimentalDecorators": true,
      "lib": ["es2015", "dom"],
      "noImplicitAny": true,
      "suppressImplicitAnyIndexErrors": true,
      "strict": true
    },
    meta: {
      'typescript': {
        "exports": "ts"
      }
    },
    paths: {
      'npm:': 'https://unpkg.com/'
    },
    map: {
      'app': 'app',
      '@angular/animations': 'npm:@angular/animations' + ngVer + '/bundles/animations.umd.js',
      '@angular/animations/browser': 'npm:@angular/animations' + ngVer + '/bundles/animations-browser.umd.js',
      '@angular/core': 'npm:@angular/core' + ngVer + '/bundles/core.umd.js',
      '@angular/common': 'npm:@angular/common' + ngVer + '/bundles/common.umd.js',
      '@angular/common/http': 'npm:@angular/common' + ngVer + '/bundles/common-http.umd.js',
      '@angular/compiler': 'npm:@angular/compiler' + ngVer + '/bundles/compiler.umd.js',
      '@angular/platform-browser': 'npm:@angular/platform-browser' + ngVer + '/bundles/platform-browser.umd.js',
      '@angular/platform-browser/animations': 'npm:@angular/platform-browser' + ngVer + '/bundles/platform-browser-animations.umd.js',
      '@angular/platform-browser-dynamic': 'npm:@angular/platform-browser-dynamic' + ngVer + '/bundles/platform-browser-dynamic.umd.js',
      '@angular/http': 'npm:@angular/http' + ngVer + '/bundles/http.umd.js',
      '@angular/router': 'npm:@angular/router' + ngVer + '/bundles/router.umd.js',
      '@angular/router/upgrade': 'npm:@angular/router' + ngVer + '/bundles/router-upgrade.umd.js',
      '@angular/forms': 'npm:@angular/forms' + ngVer + '/bundles/forms.umd.js',
      '@angular/upgrade': 'npm:@angular/upgrade' + ngVer + '/bundles/upgrade.umd.js',
      '@angular/upgrade/static': 'npm:@angular/upgrade' + ngVer + '/bundles/upgrade-static.umd.js',

      // other libraries
      'rxjs':                      'npm:rxjs@5.0.1',
      'tslib':                     'npm:tslib/tslib.js',
      'angular-in-memory-web-api': 'npm:angular-in-memory-web-api/bundles/in-memory-web-api.umd.js',
      'ts':                        'npm:plugin-typescript@5.2.7/lib/plugin.js',
      'typescript':                'npm:typescript@2.3.2/lib/typescript.js',

    },
    // packages tells the System loader how to load when no filename and/or no extension
    packages: {
      app: {
        main: './main.ts',
        defaultExtension: 'ts',
        meta: {
          './*.ts': {
            loader: 'systemjs-angular-loader.js'
          }
        }
      },
      rxjs: {
        defaultExtension: 'js'
      }
    }
  });

})(this);

import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
import { NgModule } from '@angular/core';
import { BrowserModule }  from '@angular/platform-browser';
import { Component } from '@angular/core';
import { MemberItem } from './memberitem.component.ts';

interface Member {
  id: number,
  name: string
}

@Component({
  selector: 'my-app',
  template:`
    <strong>メンバーリスト</strong>
    <ul>
      <li *ngFor="let member of members">
        <member-item [item]="member"
          (done)="removeItem($event)"></member-item>
      </li>
    </ul>
  `,
  directives: [MemberItem]
})
export class AppComponent {
  public members: Member[] = MEMBERS;
  removeItem(id) {
    for(var i=0; i<this.members.length; i++){
      if(this.members[i].id == id){
        this.members.splice(i, 1);
      }
    }
  }
}
@NgModule({
  imports: [
    BrowserModule
  ],
  declarations: [
    AppComponent,
    MemberItem
  ],
  bootstrap: [ AppComponent ]
})
export class AppModule { }

platformBrowserDynamic().bootstrapModule(AppModule);

var MEMBERS = [
  {"id": 1 ,"name": "相田"},
・・・・
];

(memberitem.component.ts)
import {Component, Input, Output, EventEmitter} from '@angular/core'; interface Member { id: number, name: string } @Component({ selector: 'member-item', template: ` <span class="badge">{{item.id}}</span> {{item.name}} <button class="btn btn-default btn-xs" (click)="doneClicked()">Delete</button> `, }) export class MemberItem { @Input() item: Member; @Output() done = new EventEmitter(); doneClicked() { this.done.emit(this.item.id); } }

関連記事の目次

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です