Webページ要素を操作できる「Angular」のディレクティブを自作してみよう

次世代Webアプリケーションフレームワーク「Angular」の活用 第20回

　本連載では、Webアプリケーションフレームワーク「Angular」の活用方法を、サンプルとともに紹介しています。前回は、サーバー側でAngularのWebページを生成するサーバーサイドレンダリングについて説明しました。今回は、HTMLタグの属性と似た記法で指定して要素を操作できる「ディレクティブ」を取り上げ、自作ディレクティブを作成する方法を説明していきます。

はじめに

　Angularは、Googleとオープンソースコミュニティで開発されているJavaScriptフレームワークです。最初のバージョンはAngularJS（AngularJS 1）と呼ばれていましたが、バージョン2で全面的に刷新され、以降、おおむね半年に1回アップデートされています。

　今回取り上げるAngularの「ディレクティブ」は、HTMLタグの属性と似た記法で指定して、その要素を操作する仕組みです。

［リスト1］ディレクティブの例（ここでは「ngModel」がディレクティブ）

<input type="text" [(ngModel)]="modelValue">

　ディレクティブには、背景色や文字色など、要素の属性を変更する「属性ディレクティブ（Attribute Directive）」と、要素を追加／削除して構造を変更する「構造ディレクティブ（Structural Directive）」があります。

　Angularが提供する属性ディレクティブの例を表1に示します。

表1：Angularが提供する属性ディレクティブの例

No.	ディレクティブ	機能
1	ngModel	フォーム要素にコンポーネントの変数を関連付け（バインディング）
2	ngStyle	要素にCSSのスタイルを設定
3	ngClass	要素にCSSのクラスを設定

　構造ディレクティブの例を表2に示します。表1、2のディレクティブの利用方法は、それぞれの公式ドキュメントを参照してください。なお、基本的な実装の例を、ダウンロードできるサンプル（p001-predefined）に含めています。

表2：Angularが提供する構造ディレクティブの例

No.	ディレクティブ	機能
1	ngIf	条件に合致したときに要素を追加
2	ngFor	配列内容に対応した要素を繰り返し追加

　本記事では、属性ディレクティブと構造ディレクティブを自作して利用する方法を説明していきます。また、自作ディレクティブの再利用を想定して、Webページ本体のプロジェクトとは別のライブラリープロジェクトを利用する方法も説明します。

［補足］コンポーネントはディレクティブの一種

　Angularのコンポーネントは、技術的には「テンプレートを含むディレクティブ」です。実際、コンポーネントを定義するときに利用する@Componentデコレーターは、ディレクティブを定義するときに利用する@Directiveデコレーターのサブクラスです。

対象読者

• AngularのWebページで、ちょっとした調整を要素に加えたい方
• Angularが提供するディレクティブが微妙に合わず、自分で作りたい方
• 自作したディレクティブを再利用したい方

必要な環境

　Angularの開発ではTypeScript（変換してJavaScriptを生成する、いわゆるAltJS言語）を利用する場合が多く、本記事のサンプルコードもTypeScriptで記述しています。

　今回は以下の環境で動作を確認しています。

• Windows 10 64bit版 　
  • Angular 7.2.8
  • Angular CLI 7.3.5
  • Node.js v10.15.3 64bit版
  • Microsoft Edge 44.17763.1.0

　サンプルコードを実行するには、サンプルのフォルダーで「npm install」コマンドを実行してライブラリーをダウンロード後、「ng serve」コマンドを実行して、Webブラウザーで「http://localhost:4200」を開きます。「ng serve --open」とオプション指定すると、実行時にWebブラウザーを自動で起動してページを表示できます。

　なお、以降で説明するサンプルはライブラリープロジェクト（my-libs）を含むので、「npm install」コマンド実行後、「ng build --project=my-libs」コマンドを実行して、ライブラリーをビルドしておく必要があります。詳細は後述します。