コンポーネント


この機能は Ver. 3.3.0 で追加予定の、リリース前の機能です

このページは、アルファ版(Ver. 3.3.0-alpha.1)時点の内容です。正式版までに仕様や設定項目が変わる可能性があります。本番サイトでは使わず、検証環境でお試しください。

コンポーネントは、いくつかのフィールドの組に名前を付け、ほかのフィールドセットから使い回す仕組みです。例えば「リンク(URL・リンクテキスト・新しいタブで開く)」をコンポーネントにすると、どの対象のどのフィールドセットにも同じ組を置けます。コンポーネントの中身を変えると、使っているすべての場所に反映されます。

コンポーネントを作る

管理画面の「フィールド定義」の「コンポーネント」タブで、コンポーネントを追加します(ラベル「リンク」、コード link)。コンポーネントに、次の 3 つのフィールドを追加します。

型

キー

ラベル

URL

url

URL

テキスト

label

リンクテキスト

チェックボックス(「複数選択できるようにする」をオフ)

blank

新しいタブで開く

コンポーネントの中のキーには cf_ のような接頭辞は要りません(使う側のキーが前に付きます)。

コンポーネントを使う

使う側は、対象のタブ(ここではエントリー)のフィールドセットで、「レイアウト」の「コンポーネント」を追加します。キー main_link・ラベル「メインのリンク」とし、「使うコンポーネント」で「リンク(link)」を選びます。同じように、キー sub_link・ラベル「サブのリンク」でもう 1 つ追加します。

定義画面のカードには「リンク(link)を展開: main_link_url, main_link_label, main_link_blank」のように、展開後のキーが表示されます。コンポーネントの一覧の「使用箇所」では、どの対象で何回使われているかを確かめられます。

テーマの JSON で書くときは、コンポーネントを admin/field-definitions/component.json に、使う側を各対象のファイルに書きます。

{
  "version": 1,
  "entityType": "component",
  "sets": [
    {
      "code": "link",
      "label": "リンク",
      "fields": [
        { "key": "url", "label": "URL", "type": "url", "validation": { "required": "none", "rules": [] } },
        { "key": "label", "label": "リンクテキスト", "type": "text" },
        { "key": "blank", "label": "新しいタブで開く", "type": "checkbox", "config": { "multiple": false } }
      ]
    }
  ]
}
{
  "version": 1,
  "entityType": "entry",
  "sets": [
    {
      "code": "cta",
      "label": "ボタン",
      "fields": [
        { "key": "main_link", "label": "メインのリンク", "type": "component", "config": { "component": "link" } },
        { "key": "sub_link", "label": "サブのリンク", "type": "component", "config": { "component": "link" } }
      ]
    }
  ]
}

編集画面での見え方

コンポーネントのフィールドは、ラベル(「メインのリンク」)を見出しにしたアコーディオンになり、その中にコンポーネントの中身(URL・リンクテキスト・新しいタブで開く)が並びます。

保存されるキー

コンポーネントの中のフィールドは、<フィールドのキー>_<中のキー> というキーで、使う側の対象(この例ではエントリー)のカスタムフィールドとして保存されます。

使う側のフィールド

保存されるキー

main_link

main_link_url・main_link_label・main_link_blank

sub_link

sub_link_url・sub_link_label・sub_link_blank

コンポーネントの中にフィールドグループがあるときは、器のキーも <フィールドのキー>_<器のキー> になります。

テンプレートの例

展開後のキーを、普通のカスタムフィールドとして書きます。

<!-- BEGIN_MODULE Entry_Field -->
<!-- BEGIN main_link_url:veil -->
<a href="{main_link_url}" class="button-primary"<!-- BEGIN_IF [{main_link_blank}/eq/on] --> target="_blank" rel="noopener"<!-- END_IF -->>{main_link_label}</a>
<!-- END main_link_url:veil -->
<!-- BEGIN sub_link_url:veil -->
<a href="{sub_link_url}" class="button-secondary"<!-- BEGIN_IF [{sub_link_blank}/eq/on] --> target="_blank" rel="noopener"<!-- END_IF -->>{sub_link_label}</a>
<!-- END sub_link_url:veil -->
<!-- END_MODULE Entry_Field -->
{% set f = module('V2_Entry_Field').fields %}
{% if f.main_link_url.value %}
<a href="{{ f.main_link_url.value }}"{% if f.main_link_blank.value == 'on' %} target="_blank" rel="noopener"{% endif %}>{{ f.main_link_label.value }}</a>
{% endif %}

コンポーネントの中にフィールドグループがある例です。コンポーネント faq(中に器 items、その中に q と a)を、キー faq_sec で使った場合は、次のように書きます。

<!-- BEGIN_MODULE Entry_Field -->
<dl class="faq">
  <!-- BEGIN faq_sec_items:loop -->
  <dt>{faq_sec_q}</dt>
  <dd>{faq_sec_a}[nl2br]</dd>
  <!-- END faq_sec_items:loop -->
</dl>
<!-- END_MODULE Entry_Field -->

制約と注意

  • 展開後のキーが 64 文字を超えるとき、ほかのキーと重なるとき(大文字と小文字は区別しません)は保存できません。キーを短くするか、変えてください。

  • コンポーネントの中に、コンポーネントやブロックは置けません。

  • コンポーネントには、5 つの対象(エントリー・カテゴリー・ブログ・ユーザー・モジュール)のすべてで使える型だけを置けます。アーカイブ画像・アーカイブファイルは置けません。

  • コンポーネントの中のフィールドの設定(必須など)は、使う側では変えられません。

  • コンポーネントのフィールドは、フィールドグループの中にも置けます。そのときは、展開した結果がフィールドグループの規則を満たす必要があります。

  • 使われているコンポーネントは削除できません。コンポーネントを無効にすると、使っている場所の編集画面には何も出ません(保存済みの値は残ります)。

  • Twig で、コンポーネントの単位でまとめて読む書き方(f.main_link.url のような形)はありません。展開後のキーで読みます。