Angular2でNavigationEndイベントを使ってflashメッセージ表示

フォームでデータ送信後に別のページに遷移する際、遷移直後のみ完了メッセージを表示(flashメッセージ)するサンプルを作成しました。
※Angular2の2.0.0版、TypeScriptを使って確認したものです。

1)サンプルの仕様
 
・”ホーム”(HomeComponent)と”次ページ”(PageComponent)の2ページ構成
・メインのコンポーネント(AppComponent)でルーティング設定
・flashメッセージを”FlashService”というサービスで保持。複数のコンポーネントから共用してアクセス。
・”ホーム”でメッセージを登録
→”次ページ”に遷移し、flashメッセージ表示
→”ホーム”に遷移するとflashメッセージが消える
 
2)ルーティング設定
 

const appRoutes: Routes = [
  { path: '', component: HomeComponent },
  { path: 'page', component: PageComponent },
  { path: 'home', component: HomeComponent }
]

 
3)flashメッセージを出し入れするサービスを作成
 
・”_queue”配列にflashメッセージを保持。
・submitメソッドで”_queue”配列にメッセージpush。
・shiftメソッドで”_queue”配列から”_currentMessage”変数にメッセージ取り出し。
・getメソッドでコンポーネットがメッセージ取得。

export class FlashService {
  private _queue: string[] = [];
  private _currentMessage: string;

  get() {
    return this._currentMessage;
  }
  submit(msg: string) {
    this._queue.push(msg);
  }

  shift() {
    this._currentMessage = this._queue.shift() || "";
  }

}

4)”Home”、”Page”コンポーネント
 
①NavigationEndイベントを使って遷移成功時の処理

export class AppComponent{
  constructor(private _flashService: FlashService,
              private _router: Router) {
    this._router.events.subscribe(event => {
      if (event instanceof NavigationEnd) {
        this._flashService.shift();
      }
    });
  }
}

・ルート遷移が成功するとサービス経由で”_queue”配列からメッセージ取り出し(配列から削除して取り出し)
 
②”Home”コンポーネントでメッセージ送信
 
・送信メッセージをサービス経由で”_queue”配列に保持。
・”Page”ビューにルート遷移。
このとき、ルート遷移が成功すると上記①のNavigationEndイベントが処理され、登録されたメッセージが表示される。
 
send() {
 this._flashService.submit(‘テストメッセージ送信’);
 this._router.navigate([‘/page’]);
}
 
再度ルート遷移を行うと”_queue”配列は空になっているので、flashメッセージは表示されない。
 
③flashメッセージを表示
 
・NgIfディレクティブを使って、値を取得できる場合のみ表示。
・Bootstrapの”bg-success”クラスを使って背景色をスタイル。

(テンプレート)
<div *ngIf="get()" class="bg-success">
  <b>flashメッセージ</b>
  <p>{{get()}}</p>
</div>
 
(コンポーネントクラス)
get() {
 return this._flashService.get();
}

●デモ
 
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 { Router, Routes, RouterModule, NavigationEnd } from '@angular/router'; import { FlashService } from './flash.service.ts'; @Component({ template: ` <strong>Home flashメッセージ送信テスト</strong><br /> <button (click)="send()">登録</button> ` }) class HomeComponent { constructor(private _flashService: FlashService, private _router: Router) {} send() { this._flashService.submit('テストメッセージ送信'); this._router.navigate(['/page']); } } @Component({ template: ` <strong>次ページ</strong> <p>次ページのコンテンツ</p> <p>・・・・</p> <p>・・・・</p> ` }) class PageComponent { constructor(private _flashService: FlashService, private _router: Router) {} } const appRoutes: Routes = [ // { path: '', redirectTo: '/home', terminal: true }, { path: '', component: HomeComponent }, { path: 'page', component: PageComponent }, { path: 'home', component: HomeComponent } ] export const routing = RouterModule.forRoot(appRoutes); @Component({ selector: 'my-app', template: ` <h1 class="title">Component Router</h1> <nav> <a [routerLink]="['/home']">ホーム</a> <a [routerLink]="['/page']">次ページ</a> </nav> <div *ngIf="get()" class="bg-success"> <b>flashメッセージ</b> <p>{{get()}}</p> </div> <router-outlet></router-outlet> ` }) export class AppComponent{ constructor(private _flashService: FlashService, private _router: Router) { this._router.events.subscribe(event => { if (event instanceof NavigationEnd) { this._flashService.shift(); } }); } get() { return this._flashService.get(); } } @NgModule({ imports: [ BrowserModule, routing ], declarations: [ AppComponent, HomeComponent, PageComponent ], providers: [ FlashService ], bootstrap: [ AppComponent ] }) export class AppModule { } platformBrowserDynamic().bootstrapModule(AppModule); ●flash.service.ts
import { Injectable } from '@angular/core'; @Injectable() export class FlashService { private _queue: string[] = []; private _currentMessage: string; get() { return this._currentMessage; } submit(msg: string) { this._queue.push(msg); } shift() { this._currentMessage = this._queue.shift() || ""; } }

●サンプルコード(β版)

<html>
  <head>
    <title>Angular 2 Demo</title>
    <base href="/sample/">
    <script src="https://code.angularjs.org/2.0.0-beta.8/angular2-polyfills.js"></script>
    <script src="https://code.angularjs.org/tools/system.js"></script>
    <script src="https://code.angularjs.org/tools/typescript.js"></script>
    <script src="https://code.angularjs.org/2.0.0-beta.8/Rx.js"></script>
    <script src="https://code.angularjs.org/2.0.0-beta.8/angular2.dev.js"></script>
    <script src="https://code.angularjs.org/2.0.0-beta.8/router.dev.js">
    <script>
      System.config({
        transpiler: 'typescript',
        typescriptOptions: { emitDecoratorMetadata: true }
      });
      System.import('./ts/app.ts').then(null, console.error.bind(console));
    </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>

メインコンポーネント
import {bootstrap} from 'angular2/platform/browser' import {Component} from 'angular2/core'; import {RouteConfig, ROUTER_DIRECTIVES, ROUTER_PROVIDERS, Router, OnActivate} from 'angular2/router'; import {FlashService} from './flash.service.ts'; @Component({ selector: 'my-home', template: ` <strong>Home flashメッセージ送信テスト</strong><br /> <button (click)="send()">登録</button> ` }) class HomeComponent implements OnActivate { constructor(private _flashService: FlashService, private _router: Router) {}; routerOnActivate(next: ComponentInstruction, prev: ComponentInstruction) { this._flashService.shift(); } send() { this._flashService.submit('テストメッセージ送信'); this._router.navigate(['Page']); } } @Component({ selector: 'my-page', template: ` <strong>次ページ</strong> <p>次ページのコンテンツ</p> <p>・・・・</p> <p>・・・・</p> `, }) class PageComponent implements OnActivate { constructor(private _flashService: FlashService, private _router: Router) {} routerOnActivate(next: ComponentInstruction, prev: ComponentInstruction) { this._flashService.shift(); } } @Component({ selector: 'my-app', template: ` <ul class="nav nav-pills"> <a [routerLink]="['Home']">ホーム</a> <a [routerLink]="['Page']">次ページ</a> </ul> <div *ngIf="get()" class="bg-success"> <b>flashメッセージ</b> <p>{{get()}}</p> </div> <router-outlet></router-outlet> `, directives: [ROUTER_DIRECTIVES], }) @RouteConfig([ { path: '/page', name: 'Page', component: PageComponent}, { path: '/home', name: 'Home', component: HomeComponent, // useAsDefault: true}, }, ]) export class AppComponent{ constructor(private _flashService: FlashService, private _router: Router) {}; get() { return this._flashService.get(); } } bootstrap(AppComponent, [FlashService,ROUTER_PROVIDERS]); flash.service.ts
import {Injectable} from 'angular2/core'; @Injectable() export class FlashService { private _queue: string[] = []; private _currentMessage: string; get() { return this._currentMessage; } submit(msg: string) { this._queue.push(msg); } shift() { this._currentMessage = this._queue.shift() || ""; } }

関連記事の目次

コメントを残す

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