レンダリングバリアントのカスタムトークンを作成する

Version:

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

SXAでは、レンダリングバリアントを使用してコンポーネントのレンダリング方法を変更できます。レンダリングバリアントをすばやく拡張する場合は、カスタムresolveVariantTokensパイプラインを使用してバリアントトークンのセットを拡張できます。

カスタムトークンは、特定のフィールド値を書式設定し、Sitecoreアイテムの値に対して変換を行う場合など、通常のレンダリングバリアントアイテムでは利用できないより複雑なデータを公開するのに役立ちます。これは、たとえば、PageListコンポーネントのレンダリングバリアントに親アイテムフィールドを表示する場合に便利です。

レンダリングバリアントのカスタムトークンを作成するには:

resolveVariantTokensパイプラインに追加のプロセッサを追加して、独自のトークンを定義します。まず、トークンプロセッサを作成します。たとえば、次のように$parentNameします。

public class ResolveParentName : ResolveVariantTokensProcessor
{
    public override string Token => "$parentname";

    public override void ResolveToken(ResolveVariantTokensArgs args)
    {
        // this if statement is quite important in order to support this token in JSON Variants
        if (args.ResultControl != null)
        {
            args.ResultControl.Controls.Add(new LiteralControl
            {
                Text = args.ContextItem.Parent.Name
            });
        }
        else
        {
            args.Result = args.ContextItem.Parent.Name;
        }
    }
}

プロセッサをresolveVariantTokensパイプラインに登録します。

pipelines
    <resolveVariantTokens>
        <processor type="YOUR_NAMESPACE.ResolveParentName, YOUR_ASSEMBLY" resolve="true" />        
    </resolveVariantTokens>
</pipelines>

トークンを適用するには、コンテンツエディタで、トークンを追加するレンダリングバリアントに移動し、Tokenフィールドに $ キーを使用してカスタムトークンを入力します。

この記事を改善するための提案がある場合は、お知らせください!