コンポーネント設定のレンダリング

コンポーネント設定をレンダリングするには、コンポーネント設定URLおよびコンポーネント設定レンダリング・オプションを使用できます。

コンポーネント設定URL

コンポーネント設定URLは、インライン・フレームを使用してレンダリングされ、ページにドロップされる実際のコンポーネントの特定の設定を可能にするパラメータを使用してコールされます。設定URLのフォーマットは次のとおりです:

{Component Settings URL}?instance=<app-instance>&width=<width>&currCompId=<id of the app associated with the settings panel>&locale=<locale>
名前 タイプ 説明

コンポーネント設定URL

URL

コンポーネントのコンポーネント設定URL

width

数値

設定インライン・フレームの幅(ピクセル単位)

currCompId

文字列

「設定」パネルによって編集されるコンポーネントの現在のコンポーネントID

locale

文字列

ホスト・サイトの現在のロケール(サイト・ビルダー)。フォーマットは<language>_<dialect>です。例: En_us

ローカル・コンポーネント設定のレンダリング・オプション

インライン・フレームのサイズと複雑さに基づいて、ローカル・コンポーネントの「設定」パネルでインライン・フレームをレンダリングするために3つのオプションが用意されています。各オプションは、settingsRenderOptionページに指定されます。

注:

これらのオプションは、ローカル・コンポーネントに対してのみ使用できます。リモート・コンポーネントの「設定」パネルは常にダイアログ内でレンダリングされます。
  • inline
    • このオプションを使用するのは、ユーザーが入力する小さいプロパティがいくつか存在する場合のみです。

    • このインライン・フレームは、「設定」パネルに移動するために一般的なボタンのかわりに「一般」タブに挿入されます。

    • 最も統合されたソリューションを提供し、ユーザーに対して最も少ないクリック数を要求しますが、領域は制限されています。

  • panel
    • このオプションを使用するのは、プロパティのリストが長い場合ですが、これらのプロパティは依然として標準「設定」パネルの300ピクセル内に適切に表示できます。

    • このインライン・フレームはビュー内にスライドし、ユーザーを「一般」タブに戻すために「戻る」ボタンが表示されます。

    • ページ上のインライン・フレームを操作できる統合ソリューションを提供します。

  • dialog
    • 複雑なユーザー・インタフェースを必要とする、より一般的な設定レイアウトを処理するためのデフォルト・モード。

    • ページ上のモーダル・ダイアログにインライン・フレームが表示されます。