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

wp-admin

7年前

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

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

１．サンプルの仕様
２．サンプルコードの説明
３．デモ

サンプルの仕様

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

サンプルコードの説明

１）ルーティング設定
　

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

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

}

　
３）”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 : 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 { 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() || "";
  }

}

モバイルバージョンを終了