アダプティブフォームフラグメントコンポーネント form-fragment-component-adaptive-forms-core-component

アダプティブフォームには、パネルやフィールドのグループなどのフォームセグメントを作成して、別のアダプティブフォームで再利用するための便利な機能が用意されています。 この再利用可能なスタンドアロンのセグメントは、アダプティブフォームフラグメントと呼ばれます。

フラグメントを 1 つのドキュメントに複数回追加し、そのコンポーネントのデータ連結プロパティを使用すると、フラグメントを別のデータソースやスキーマに結び付けることができます。 例えば、同じアドレスフラグメントを永続アドレス、通信アドレス、請求先アドレスに使用し、それをデータソースやスキーマの様々なフィールドに接続することができます。

例

繰り返しオプションを使用すると、フォームフラグメントコンポーネントとその子コンポーネントの複製、最小繰り返し回数と最大繰り返し回数の定義、フォーム内の類似セクションの複製を簡単に行うことができます。

NOTE
最初からアダプティブフォームフラグメントを作成することも、既存のアダプティブフォーム内のパネルをフラグメントとして保存することもできます。

使用方法 usage

  • 再利用性:フォームフラグメントを使用する主な利点は、複数のアダプティブフォームでフォームフラグメントを再利用できることです。 フラグメントに対する変更は、そのフラグメントが使用されるすべてのインスタンスに反映されるので、デザインと機能の一貫性を維持するのに役立ちます。

  • 一貫性のあるユーザーエクスペリエンス:ヘッダーやフッターなどの共通の要素にフォームフラグメントを使用すると、一貫性のあるユーザーエクスペリエンスを実現できます。

  • 容易なメンテナンス:フォームフラグメントに対する変更や修正は、そのフラグメントが使用されているすべてのインスタンスに反映されます。 これによりメンテナンスが容易化され、エラーが発生するリスクを低減できます。

  • 効率性:デザイナーや開発者は、フォームフラグメントの構築とテストを 1 回だけ行うことで、時間を節約できます。 その後、冗長な作業を必要とせずに、複数のアダプティブフォームにフォームフラグメントを簡単に組み込むことができます。

バージョンと互換性 version-and-compatibility

アダプティブフォームフラグメントのコアコンポーネントは、Cloud Service のコアコンポーネント 2.0.50 および AEM 6.5.16.0 Forms 以降のコアコンポーネント 1.1.26 の一部としてリリースされました。 次の表に、サポートされているすべてのバージョン、AEM の互換性、対応するドキュメントへのリンクを示します。

コンポーネントのバージョン
AEM as a Cloud Service
AEM 6.5.16.0 Forms 以降
v1
リリース 2.0.50 以降と互換性あり
リリース 1.1.26 以降、2.0.0 未満と互換性があります。

コアコンポーネントのバージョンとリリースについて詳しくは、コアコンポーネントのバージョンドキュメントをご覧ください。

技術的詳細 technical-details

アダプティブフォームフラグメントのコアコンポーネントの最新情報については、GitHub のテクニカルドキュメントをご覧ください。 コアコンポーネントの開発について詳しくは、コアコンポーネント開発者向けドキュメントをご覧ください。

設定ダイアログ configure-dialog

設定ダイアログを使用すると、フラグメントエクスペリエンスを訪問者に合わせて簡単にカスタマイズできます。 また、フラグメントのプロパティを簡単に定義して、シームレスなユーザーエクスペリエンスを実現することもできます。

「基本」タブ basic-tab

「基本」タブ

  • 名前 - フォームコンポーネントは、フォーム内とルールエディター内の両方で一意の名前で簡単に識別できますが、名前にスペースや特殊文字を含めることはできません。

  • タイトル - タイトルを使用すると、フォーム内のコンポーネントを簡単に識別できます。デフォルトでは、コンポーネントの上にタイトルが表示されます。 タイトルを追加しない場合、コンポーネントの名前がタイトルテキストの代わりに表示されます。

  • タイトルのリッチテキストを許可 - この機能により、ユーザーは、太字、斜体、下線付きのテキスト、様々なフォント、フォントサイズ、カラー、追加オプションなどの機能を組み込んで、プレーンテキストのタイトルを書式設定でき、視覚的なプレゼンテーションとカスタマイズが強化されます。 これにより、ドキュメント、web サイト、アプリケーション内でタイトルを目立たせる際の柔軟性とクリエイティブなコントロールが向上します。
    タイトルのリッチテキストを許可」 チェックボックスをオンにすると、コンポーネントのタイトルをスタイル設定するための書式設定オプションが表示されます。 使用可能なすべての書式設定オプションにアクセスするには、 全画面表示アイコン タブをクリックします。

    リッチテキストのサポート

  • タイトルを非表示 - コンポーネントのタイトルを非表示にするには、このオプションを選択します。

  • フォームの送信時に子コンポーネントのデータをグループ化(オブジェクトにデータを含める) - このオプションを選択すると、子コンポーネントのデータが親コンポーネントの JSON オブジェクト内にネストされます。 ただし、このオプションを選択しないと、送信した JSON データは、親コンポーネントのオブジェクトを持たないフラットな構造になります。 例:

    • このオプションを選択すると、子コンポーネント(番地、市区町村、郵便番号など)のデータが、JSON オブジェクトとして親コンポーネント(住所)内にネストされます。 これにより、階層構造が作成され、データは親コンポーネントの下に整理されます。

      送信したデータの構造:

      code language-json
      { "Address":
      
      { "Street": "123 Main Street", "City": "New York", "Zip Code": "12345" }
      
      }
      
    • このオプションを選択しないと、送信した JSON データは、親コンポーネント(住所)のオブジェクトを持たないフラットな構造になります。 すべてのデータは同じレベルにあり、階層構造はありません。

      送信したデータの構造:

      code language-json
         { "Street": "123 Main Street", "City": "New York", "Zip Code": "12345" }
      
  • フラグメント参照 - フラグメント参照は、外部データソースに保存され、フォーム内で使用されるフォームフラグメントへの参照です。 フラグメント参照を使用すると、フォームフラグメントをフォームに動的に連結できます。

  • バインド参照 - バインド参照は、外部データソースに保存され、フォーム内で使用されるデータ要素への参照です。 バインド参照を使用すると、データをフォームフィールドに動的にバインドして、フォームにデータソースの最新のデータを表示できます。 例えば、フォームに入力された顧客 ID に基づいて、顧客の名前と住所をフォームに表示できます。 さらに、フォームに入力されたデータでデータソースを更新することもできます。 このように AEM Formsで外部データソースとやり取りするフォームを作成して、データの収集と管理のためのシームレスなユーザーエクスペリエンスを提供できます。

  • コンポーネントを非表示 - フォームでコンポーネントを非表示にするには、このオプションを選択します。 このコンポーネントは、他の目的(ルールエディターでの計算に使用するなど)にも利用できます。 これは、ユーザーが表示する必要のない情報や直接変更した情報を保存する必要がある場合に役立ちます。

  • コンポーネントの無効化 - コンポーネントを無効にする場合は、このオプションを選択します。 エンドユーザーは、無効になっているコンポーネントをアクティブにしたり、編集したりすることはできません。 ユーザーはフィールドの値を表示できますが、変更することはできません。 このコンポーネントは、他の目的(ルールエディターでの計算に使用するなど)にも利用できます。

  • 読み取り専用 - コンポーネントを編集不可にするには、このオプションを選択します。 ユーザーはフィールドの値を表示できますが、変更することはできません。 このコンポーネントは、他の目的(ルールエディターでの計算に使用するなど)にも利用できます。

「フラグメントを繰り返す」タブ repeat-tab

「フラグメントを繰り返す」タブ

  • フラグメントを繰り返し可能にする:ユーザーが繰り返し機能を有効または無効にできる切替スイッチの機能です。
  • 最小繰り返し回数:フラグメントコンポーネントを繰り返すことができる最小回数を設定します。 値 0 は、フラグメントコンポーネントが繰り返されないことを示します。デフォルト値は 0 です。
  • 最大繰り返し回数:フラグメントコンポーネントを繰り返すことができる最大回数を設定します。 デフォルトでは、この値は無制限です。

「ヘルプコンテンツ」タブ help-content

「ヘルプコンテンツ」タブ

  • 短い説明 - 短い説明は、特定のフォームフィールドの目的に関する追加の情報や説明を提供する簡単な説明文です。 これにより、ユーザーは、フィールドに入力するデータの種類を理解しやすくなります。また、入力された情報が有効で目的の条件を満たしていることを確認できるように、ガイドラインや例を提供できます。 デフォルトでは、短い説明は非表示になっています。 「短い説明を常に表示」オプションを有効にすると、コンポーネントの下に説明が表示されます。

  • 短い説明を常に表示 - このオプションを有効にすると、コンポーネントの下に短い説明が表示されます。

  • ヘルプテキスト - ヘルプテキストとは、フォームフィールドの正しい入力を支援するためにユーザーに提供される追加の情報やガイダンスを指します。 コンポーネントの横に配置されているヘルプアイコン(i)をクリックすると表示されます。 ユーザーがフィールドの要件や制約を理解できるように設計されているヘルプテキストは、フォームフィールドのラベルやプレースホルダーテキストよりも詳細な情報を提供できます。 また、フォームへの入力をより簡単かつ正確にするための提案や例を提供することも可能です。

アクセシビリティ accessibility

「アクセシビリティ」タブ

  • スクリーンリーダー用テキスト - スクリーンリーダー用テキストとは、視覚に障害のあるユーザーが使用する、支援テクノロジー(スクリーンリーダーなど)によって読み上げられる追加のテキストを指します。 このテキストでは、フォームフィールドの目的に関するオーディオの説明が提供され、フィールドのタイトル、説明、名前および関連するメッセージ(カスタムテキスト)に関する情報を含めることができます。 スクリーンリーダー用のテキストを使用すると、視覚に障害のあるユーザーを含むすべてのユーザーがフォームに確実にアクセスして、フォームフィールドとその要件を完全に理解できるようになります。

    • カスタムテキスト:ARIA アクセシビリティラベルにカスタムテキストを使用する場合は、このオプションを選択します。 このオプションを選択すると、「カスタムテキスト」ダイアログボックスが表示されます。 関連情報は、「カスタムテキスト」ダイアログボックスで追加できます。
    • 説明:ARIA アクセシビリティラベルの説明を使用する場合は、このオプションを選択します。
    • タイトル:ARIA アクセシビリティラベルのタイトルを使用する場合は、このオプションを選択します。
    • 名前:ARIA アクセシビリティラベルの名前を使用する場合は、このオプションを選択します。
    • なし:ARIA アクセシビリティラベルに追加しない場合は、このオプションを選択します。
  • スクリーンリーダーが通知を行うための HTMLの役割 - HTMLの役割は、スクリーンリーダーなどの支援テクノロジーに対する HTML 要素の目的を指定するための属性です。 役割の属性は、要素に追加のコンテキストと意味論的意味を提供するために使用されます。これにより、スクリーンリーダーがコンテンツを解釈して読み上げやすくなります。 例えば AEM Formsでは、フォームフィールドのラベルが「label」という役割を持ち、入力フィールドが「textbox」という役割を持つ場合があります。 これにより、スクリーンリーダーはラベルと入力フィールドの関係を理解し、ユーザーに対して正しく通知できるようになります。

デザインダイアログ design-dialog

デザインダイアログでは、フォームフラグメントコンポーネントの CSS スタイルを定義および管理できます。

「スタイル」タブ styles-tab

アダプティブフォームのフォームフラグメントコアコンポーネントは、AEM のスタイルシステムをサポートしています。

デザインダイアログ

  • デフォルトの CSS クラス:アダプティブフォームのフォームフラグメントコアコンポーネントにデフォルトの CSS クラスを指定できます。

  • 許可されたスタイル:スタイルを表す名前と CSS クラスを指定してスタイルを定義します。 例えば、「bold text」という名前のスタイルを作成し、CSS クラス「font-weight: bold」を指定できます。 アダプティブフォームエディターでアダプティブフォームにこれらのスタイルを使用または適用できます。 スタイルを適用するには、アダプティブフォームエディターでスタイルを適用するコンポーネントを選択し、「プロパティ」ダイアログに移動して「スタイル」ドロップダウンリストから希望のスタイルを選択します。 スタイルを更新または変更する必要がある場合は、デザインダイアログに戻り、「スタイル」タブでスタイルを更新して変更を保存します。

カスタムプロパティ

カスタムプロパティダイアログ

カスタムプロパティを使用すると、フォームテンプレートを使用してカスタム属性(キーと値のペア)をアダプティブフォームのコアコンポーネントに関連付けることができます。 カスタムプロパティは、コンポーネントのヘッドレスレンディションのプロパティセクションに反映されます。 これにより、カスタム属性値に基づいて適応する動的なフォーム動作を作成できます。 例えば、開発者は、モバイル、デスクトップ、web プラットフォーム上にヘッドレスフォームコンポーネントの様々なレンディションをデザインできるので、幅広いデバイスでのユーザーエクスペリエンスが大幅に向上します。

  • グループ名:カスタムプロパティグループを識別する名前を指定できます。 複数のカスタムプロパティグループを追加、削除または並べ替えることができます。 カスタムプロパティグループを追加すると、次のオプションが表示されます。

    • キーと値のペア:各カスタムプロパティグループの「追加」ボタンをクリックすると、複数のカスタムプロパティ名とカスタムプロパティ値を追加できます。

    • 削除:タップまたはクリックすると、カスタムプロパティ名とカスタムプロパティ値を削除できます。

    • 並べ替え:タップまたはクリックしてドラッグすると、カスタムプロパティ名とカスタムプロパティ値の順序を並べ替えることができます。

関連記事 related-articles

関連トピック see-also

recommendation-more-help
d2be9096-a81e-404b-9952-d8925af7219c