この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

メタデータの定義

このトピックでは、メタデータの構造と、ウィザードの作成に使用するウィザードコンポーネントについて説明します。

ウィザードの設定

ウィザードは、ウィザードに組み込まれるコンポーネントのリストを定義したメタデータ JSON 構造と、使用可能なアクションや一般レイアウトを定義した追加のプロパティから生成されます。

表 1. Metadata のプロパティ
プロパティ 必須かどうか デフォルト値 説明
footerLeftButtons Array<String | WizardButtonMetadata> false [] フッターに表示されるボタンアクションのリスト。アクションの [キャンセル][送信] には、デフォルトのボタンスタイルがあります。これらのアクションは文字列として指定できます。カスタムアクションの場合は、WizardButtonMetadata 構造を使用して、ボタンに適したスタイルを定義します。
footerRightButtons Array<String | WizardButtonMetadata> false [] フッターに表示されるボタンアクションのリスト。アクションの [キャンセル][送信] には、デフォルトのボタンスタイルがあります。これらのアクションは文字列として指定できます。カスタムアクションの場合は、WizardButtonMetadata 構造を使用して、ボタンに適したスタイルを定義します。
components Array<WizardComponentMetadata> true ウィザードのコンポーネントのメタデータ定義のリスト。
columns Number false 2 WizardComponent が表示する列の数。
title String true モーダルのヘッダーに表示されるウィザードのタイトル。
size String true ウィザードモーダルのサイズ。
可能な値は次のとおりです。
  • small
  • large

WizardComponentMetadata

このメタデータ型では、ウィザード内のコンポーネントについて記述します。コンポーネントはリストと同じ順序で表示されます。

各コンポーネントには独自の属性がありますが、すべてのコンポーネントは、指定する必要がある共通の属性セットを共有しています。
1{
2    "id": "mySlogan"
3    "type": "Text",
4    "outputProperty": "Slogan",
5    "required": true,
6    "label": "Slogan",
7    "maxLength": 80,
8    "minLength": 1,
9    "defaultValue": ""
10}
表 2. 共有コンポーネントのプロパティ
プロパティ 必須 説明
id String true コンポーネントのインスタンスの一意の識別子。大文字と小文字が区別されます。この ID は、ウィザードのメタデータ設定のすべてのコンポーネント間で一意でなければなりません。
type String true 表示するコンポーネントの種別。この属性は、UI 上で表示されるコンポーネントを示します。また、この属性は、コンポーネントに必要な追加の属性を定義します。

WizardButtonMetadata

このメタデータ構造は、ウィザードの下部に表示されるボタンを定義します。
表 3. ボタンのプロパティ
プロパティ 必須 説明
type String true ボタンをクリックすると実行されるアクション。ボタン種別は自由テキストで、ユーザーがボタンをクリックすると出力オブジェクトと一緒に返されます。
brand String true ボタンの UI 種別。可能な値は次のとおりです。
  • base
  • neutral
  • brand
  • brand-outline
  • destructive
  • destructive-text
  • inverse
  • success
label String true ボタンの表示ラベル。