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

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

(1)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’]
})
 

(2)カスタムイベントを使ったサンプル


 
●仕様
 
①メインコンポーネント
・会員データを保持し、リストを表示。
・各メンバー表示ディレクティブからの”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メソッドを実行する。
 

(3)デモ


Angular : 2.0.0
Bootstrap : 3.2.0

Loading…

<html>
  <head>
    <title>Angular 2 Demo</title>
    <script src="https://npmcdn.com/core-js/client/shim.min.js"></script>
    <script src="https://npmcdn.com/zone.js@0.6.23?main=browser"></script>
    <script src="https://npmcdn.com/reflect-metadata@0.1.3"></script>
    <script src="https://npmcdn.com/systemjs@0.19.27/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 = '@2.0.0';
  var routerVer = '@3.0.0';
  var formsVer = '@2.0.0';
  var routerDeprecatedVer = '@2.0.0-rc.2';
  var map = {
    'app':                        'app',
    '@angular':                   'https://npmcdn.com/@angular',
    '@angular/router':            'https://npmcdn.com/@angular/router' + routerVer,
    '@angular/forms':             'https://npmcdn.com/@angular/forms' + formsVer,
    '@angular/router-deprecated': 'https://npmcdn.com/@angular/router-deprecated' + routerDeprecatedVer,
    'angular2-in-memory-web-api': 'https://npmcdn.com/angular2-in-memory-web-api',
    'rxjs':                       'https://npmcdn.com/rxjs@5.0.0-beta.12',
    'ts':                         'https://npmcdn.com/plugin-typescript@4.0.10/lib/plugin.js',
    'typescript':                 'https://npmcdn.com/typescript@1.9.0-dev.20160409/lib/typescript.js',
 };
  var packages = {
    'app':                        { main: 'main.ts',  defaultExtension: 'ts' },
    'rxjs':                       { defaultExtension: 'js' },
    'angular2-in-memory-web-api': { main: 'index.js', defaultExtension: 'js' },
  };

  var ngPackageNames = [
    'common',
    'compiler',
    'core',
    'http',
    'platform-browser',
    'platform-browser-dynamic',
    'upgrade',
  ];
  ngPackageNames.forEach(function(pkgName) {
    map['@angular/'+pkgName] = 'https://npmcdn.com/@angular/' + pkgName + ngVer;
  });
  ngPackageNames.concat(['forms', 'router', 'router-deprecated']).forEach(function(pkgName) {
    packages['@angular/'+pkgName] = { main: '/bundles/' + pkgName + '.umd.js', defaultExtension: 'js' };
  });

  var config = {
    transpiler: 'ts',
    meta: {
      'typescript': {
        "exports": "ts"
      }
    },
    map: map,
    packages: packages
  };

  System.config(config);

})(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); } }

関連記事の目次

コメントを残す

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