テーマファビコンクライアント拡張機能の使用

Liferay 7.4以降

テーマのお気に入りアイコンクライアント拡張を使えば、選択したページでテーマのお気に入りアイコンを上書きすることができます。サンプルワークスペースから、クライアント拡張を構築し、デプロイします。

前提条件

クライアント拡張の開発を開始するには、

1. サポートされているバージョンの Java をインストールしてください。

   注記

   サポートされているJDK、データベース、および環境については、互換性マトリックスをご確認ください。推奨される JVM 設定については、 JVM 構成 を参照してください。

2. サンプルワークスペースをダウンロードして解凍してください。

   curl -o com.liferay.sample.workspace-latest.zip https://repository.liferay.com/nexus/service/local/artifact/maven/content\?r\=liferay-public-releases\&g\=com.liferay.workspace\&a\=com.liferay.sample.workspace\&\v\=LATEST\&p\=zip
   

   unzip com.liferay.sample.workspace-latest.zip
   

これで、最初のテーマのお気に入りアイコンクライアント拡張をデプロイするためのツールがそろいました。

クライアント拡張機能を調べます

テーマのお気に入りアイコンクライアント拡張は、サンプルワークスペースの client-extensions/sample-global-css/ フォルダにあります。 client-extension.yaml ファイルに定義されています。

liferay-sample-theme-favicon:
   name: Liferay Sample Theme Favicon
   type: themeFavicon
   url: favicon.ico

このクライアント拡張は、IDが liferay-sample-theme-faviconで、タイプや追加するお気に入りアイコンファイルなど、テーマのお気に入りアイコンクライアント拡張の主要な設定項目が含まれています。利用可能なプロパティの詳細については、 テーマファビコンYAML設定リファレンス を参照してください。

また、以下のassemble YAMLブロックも含まれています。

assemble:
   - from: assets
   into: static

これは、 assets/ フォルダ内のすべてを、ビルドされたクライアント拡張.zip ファイルに静的リソースとして含めることを指定します。テーマのお気に入りアイコンクライアント拡張のお気に入りアイコンファイルは、Liferayの静的リソースとして使用されます。

Liferayにクライアント拡張機能をデプロイする

Liferay の新しいインスタンスを起動するには、次のコマンドを実行します。

docker run -it -m 8g -p 8080:8080 liferay/portal:7.4.3.132-ga132

http://localhost:8080 で Liferay にサインインしてください。メールアドレス test@liferay.com とパスワード test を使用してください。プロンプトが表示されたら、パスワードを learn に変更してください。

Liferayが起動したら、サンプルワークスペース内のクライアント拡張機能のフォルダから以下のコマンドを実行してください。

../../gradlew clean deploy -Ddeploy.docker.container.id=$(docker ps -lq)

これにより、クライアント拡張が構築され、Liferayのdeploy/フォルダにzipをデプロイします。

Liferayインスタンスのコンソールでデプロイメントを確認します。

STARTED liferay-sample-theme-favicon_1.0.0

ページでクライアント拡張機能を使用する

Liferayで、デプロイ済みのクライアント拡張機能を使用するようにページを設定します。

1. ページ上で、上部の 編集 () をクリックします。

2. サイドバーで、[ページデザインオプション] メニュー () に移動し、メニュー上部の 設定 () をクリックします。

3. ファビコン セクションの ルック アンド フィール タブで、 ファビコンの変更 をクリックします。

4. クライアント拡張機能 をクリックし、新しくデプロイされたファビコン サンプルテーマファビコン を選択します。

   

5. 下にスクロールして、 保存 をクリックします。

6. ページに戻ります。新しいお気に入りアイコンがブラウザのタブに表示されます。

次のステップ

Liferayでテーマファビコンクライアント拡張機能を正常に使用できました。次に、他のクライアント拡張機能タイプをデプロイしてみてください。

• CSSクライアント拡張機能の使用
• JSクライアント拡張機能の使用

関連トピック

• テーマファビコンYAML設定リファレンス