Lightning アプリケーションビルダーを使用する場合のヒント

Lightning アプリケーションビルダーで公開するコンポーネントを作成する場合、次のガイドラインを参考にしてください。

• コンポーネントが表示領域の 100% の幅 (余白を含む) を占めるようにします。「コンポーネントでの幅の認識」を参照してください。
• コンポーネントがユーザ操作を必要とする場合は、Lightning アプリケーションビルダーで適切なプレースホルダ動作を指定します。
• 空白のボックスは表示しないでくだい。他のサイトがどのように動作するかを考えます。たとえば、Facebook では、実際のフィード項目がサーバから返されるまでフィードの概要が表示されます。この概要により、UI 応答のユーザの認識が向上します。
• 起動されたイベントにコンポーネントが連動する場合は、イベントが起動される前に表示するデフォルトの状態を指定します。
• Salesforce Design System を使用してコンポーネントのスタイルを設定します。

• 設定ファイルで masterLabel タグを使用して、わかりやすい名前をコンポーネントに設定します。
• 設定ファイルを使用して、Lightning アプリケーションビルダーにプロパティを公開します。
• サポートされるフォーム要素の情報をすべてのコンポーネントの設定ファイルに含めることを強くお勧めします。
• すべてのプロパティに、わかりやすい表示名を使用した表示ラベルを指定します。
• 説明を提供して、データ形式や予期される値範囲など、予期されるデータおよびガイドラインを説明します。説明テキストは、Lightning アプリケーションビルダーのプロパティエディタにツールチップとして表示されます。
• 必須プロパティにはデフォルト値を指定します。デフォルト値のない必須プロパティを持つコンポーネントをアプリケーションビルダーに追加すると、無効と表示され、ユーザの操作性が低下します。
• 公開されるプロパティには、サポートされる基本のデータ型 (string、integer、boolean) を使用します。
• コンポーネントプロパティを定義する場合は、.js ファイルと設定ファイルで同じ種別 (String、Integer、Boolean) が割り当てられていることを確認してください。割り当て種別が一致しない場合は、設定ファイルの種別の割り当てが優先されます。
• 整数プロパティに最小属性と最大属性を指定して、有効な値範囲を制御します。
• 文字列プロパティでは、事前定義された一連の値を持つデータ取得元を指定して、プロパティの設定を選択リストとして公開できます。
• コンポーネントが Lightning ページまたは管理パッケージで使用されている場合、コンポーネントが破損する可能性がある破壊的な変更を行うことができません。破壊的な変更には次のようなものがあります。
  • そのオブジェクトのレコードページでコンポーネントが使用されている場合に、オブジェクトタグを削除する。
  • その種別のページでコンポーネントが使用されている場合に、ページ種別サポートを削除する。
  • Lightning ページでコンポーネントが使用されている場合に、最小または最大プロパティ値を変更する。

• Lightning アプリケーションビルダーは、Map 型、Object 型、または java:// 複合型をサポートしません。
• コンポーネントが一度 Lightning ページで使用されると、サポートされるフォーム要素を増やすことはできますが、減らすことはできなくなります。
• 「プルして更新」は、Salesforce モバイルアプリケーションのカスタム Lightning Web コンポーネントでは機能しません。