テーマファビコンクライアントエクステンションの使用

テーマファビコンクライアントエクステンションの使用

利用可能 Liferay 7.4 U45+/GA45+

テーマファビコンクライアント拡張機能を使えば、選択したページでテーマのファビコンを上書きすることができます。 サンプルワークスペース を使って、クライアントエクステンションのビルドとデプロイを開始します。

前提条件

クライアントエクステンションの開発を始めるために、

  1. Java(JDK8またはJDK11)をインストールする。

    note

    対応するJDK、データベース、環境については、 互換性マトリックス を確認してください。 推奨されるJVMの設定については、JVM Configuration を参照してください。

  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/liferay-sample-theme-favicon/ フォルダにあります。 client-extension.yaml ファイルで定義されています:

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

このクライアント拡張機能は、IDが liferay-sample-theme-favicon で、タイプや追加するファビコンファイルなど、テーマファビコンのクライアント拡張機能の主要な構成が含まれています。 利用可能なプロパティの詳細については、「 Theme Favicon YAML Configuration Reference」 を参照してください。

また、 assemble YAMLブロックも含まれています:

assemble:
    - from: assets
      into: static

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

LiferayにClient Extensionをデプロイする。

新しいLiferay インスタンスを起動し、以下を実行します。

docker run -it -m 8g -p 8080:8080 liferay/portal:7.4.3.75-ga75。

http://localhost:8080でLiferayへのサインインします。 メールアドレス[email protected]_とパスワード_test_を使用してください。 プロンプトが表示されたら、パスワードを _learn_に変更します。

Liferayが起動したら、サンプルワークスペース内のクライアント拡張のフォルダからこのコマンドを実行します:

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

これはクライアント拡張をビルドし、Liferayの deploy/ フォルダにzipをデプロイします。

note

クライアント拡張を Liferay Experience Cloud にデプロイするには、Liferay Cloud Command-Line Tool を使って lcp deploy を実行します。

tip

ワークスペース内のすべてのクライアント拡張機能を同時に配置するには、client-extensions/フォルダからコマンドを実行します。

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

STARTED liferay-sample-theme-favicon_1.0.0

ページでクライアントエクステンションを使用する

配備したクライアントエクステンションを使用するために、Liferayのページを設定します:

  1. ページで、上部にある 編集(Edit icon) をクリックします。

  2. サイドバーの「ページデザインオプション」メニュー(Page Design Options icon)に移動し、メニュー上部の 構成(Configuration icon) をクリックします。

  3. Look and Feel タブの Favicon セクションで、 Change Favicon をクリックします。

  4. Client Extensions をクリックし、新しく配置したファビコン Sample Theme Favicon を選択します。

    Sample Theme Favicon」クライアント拡張機能を選択し、「保存」をクリックします。

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

  6. ページに戻ってください。 新しいファビコンがブラウザのタブに表示されます。

新しいファビコンがブラウザのタブに表示されます。

次のステップ

Liferayでテーマのファビコンクライアント拡張を使用することに成功しました。 次に、他のクライアントエクステンションタイプのデプロイメントを試してみます。