registerComponentメソッド
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
コンポーネントビルダー内で外部コンポーネントを登録するフローの一部としてregisterComponentメソッドを呼び出します。
輸入
registerComponent関数を有効にするには、まずインポートする必要があります。
import {registerComponent} from '@sitecore-feaas/clientside' registerComponent(...);
構文論
registerComponent(component, options)
オプション
以下はサポート可能なパラメータの一覧です。必要なパラメータはnameのみです。 propertiesの一覧は、このコンポーネントの入力フィールドの定義であり、ページビルダー内でコンポーネントを使用する際にコンテンツ作成者が閲覧できます。 requiredパラメータとuiパラメータはこれらの性質を参照しています。
名称
種類
概要
名称
文字列、必須
コンポーネントおよびページインターフェースで表示するコンポーネントの名前。
説明
ストリング
コンポーネントおよびページインターフェースで表示するコンポーネントの説明。
サムネイル
URL
このコンポーネントのComponentsビルダーに表示されるサムネイル画像のURL。推奨寸法は280×520ピクセルです。
グループ
ストリング
例えば「デフォルトコレクション」のように、このコンポーネントが属するコンポーネントの集合です。
性質
JSONスキーマオブジェクト
コンポーネント入力プロパティを記述するJSONスキーマです。このコンポーネントを使用すると、Pagesユーザーにはそのスキーマに基づいて自動的に生成される設定インターフェース(UI)が表示されます。UIはuiプロパティにあるuiSchemaでカスタマイズ可能です。
必須
文字列配列
Pagesユーザーの入力を必要とするプロパティキーの配列です。
UI
JSONスキーマオブジェクト
指定されたプロパティに対するUI固有の構成。このオプションはuiSchemaオブジェクトを前提としています。
例
FEAAS.registerComponent(MyComponent, { name: 'MyComponent', description: 'Description of MyComponent.', required: 'firstName', properties: { firstName: { type: 'string', title: 'First name', required: true }, telephone: { type: 'string', title: 'Telephone', minLength: 10 }, }, ui: { firstName: { 'ui
': true, 'ui': 'Write your first name' }, telephone: { 'ui': { inputType: 'tel' } } } });