Lightning コンポーネントライブラリ

Lightning コンポーネントライブラリには、コンポーネントのリファレンス情報と Lightning Web Security および Lightning Locker 用のツールが含まれています。

コンポーネントライブラリは、公開サイトと Salesforce 組織にリンクされた認証済みサイトの 2 か所にあります。認証済みサイトでは、コンポーネントライブラリのコンポーネントの参照セクションに、追加の機能が用意されています。

公開コンポーネントライブラリ

このサイトは、Salesforce にログインしなくても見ることができます。コンポーネントの参照には、基本コンポーネントのドキュメントや参考情報があります。

https://developer.salesforce.com/docs/component-library

組織のコンポーネントライブラリ

このサイトを見るには、Salesforce 組織にログインしてから https://<myDomainName>.lightning.force.com/docs/component-library にアクセスします。もしくは、公開サイトの一番上にある組織へのリンクをクリックします。

認証済みサイトのコンポーネントの参照にはその他の機能があります。

• 組織に対して一意の Lightning コンポーネントを表示します。
• 管理パッケージにインストールされている Lightning コンポーネントを表示します。組織が所有するコンポーネントやパッケージにインストールされているコンポーネントのみを表示するように絞り込むことができます。

コンポーネントの参照は、各 Lightning 基本コンポーネントの詳細情報を提供します。Lightning Web Components と Aura プログラミングモデルの両方の基本コンポーネントが、すべてドキュメント化されています。

コンポーネントの参照に関するハイライトを次に示します。

コンポーネントの絞り込み

[概要] ページで、関心のあるコンポーネントに絞り込んで表示します。たとえば、ナビゲーションに関連したコンポーネントのみを表示するには、[検索条件] | [カテゴリ] | [移動] を選択します。

対象の表示

コンポーネントを選択すると、そのコンポーネントを使用できる場所が画面の一番上の [対象] パネルに表示されます。対象としては、Salesforce アプリケーション、Lightning Experience、エクスペリエンスビルダーサイト、Salesforce モバイルアプリケーション、スタンドアロン Lightning アプリケーションなどがあります。

コンポーネント間の切り替え

[Aura コンポーネントとして表示] と [Lightning Web コンポーネントとして表示] ボタンをクリックすると、コンポーネントのバージョンを切り替えることができます。

[例]、[ドキュメント]、[仕様] ページの表示

ほとんどのコンポーネントには [例]、[ドキュメント]、[仕様] ページがあります。lightning-record-form や lightning-input-field など、コンポーネントによっては、Salesforce データが必要なものもあります。これらは組織の外部では使用できず、[例] ページはありません。

対話型の例の修正

[例] ページには、コンポーネントの見た目と動作を実際に示すための対話型のコード例があります。実行中のコードを表示できます。Lightning Web コンポーネントでは、Lightning Mini Playground でコード例を編集できます。コードを編集すると、対話型の例に直ちに反映されます。

Lightning Web Security Console と LWS Distortion Viewer を使用すると、Lightning Web セキュリティとともに実行する安全な JavaScript コードを開発できます。

これらのツールの使用についての詳細は、「Lightning Web Security Console での JavaScript の評価」と「LWS Distortion Viewer でのディストーションの詳細の確認」を参照してください。

Lightning Web セキュリティ、および Lightning Web セキュリティと Lightning Locker の比較についての詳細は、「Lightning Web セキュリティ」を参照してください。

Locker Console と Locker API Viewer を使用すると、Lightning Locker と互換性があり、Lightning Locker と共に効率的に実行できる安全な JavaScript コードを開発できます。

これらのツールの使用についての詳細は、_『Lightning Aura コンポーネント開発者ガイド』_の「Lightning Locker ツール」を参照してください。

Lightning Locker と Lightning Web コンポーネントについての詳細は、「Lightning Locker のセキュリティ」を参照してください。

コンポーネント例は Playground で実行されます。例でいろいろなことを試してみるには、例を修正して [実行] をクリックします。webcomponents.dev/org/lwc のコンポーネント例を試すこともできます。

コンポーネントの参照はまだ完成していません。いくつかの既知の問題を示します。

公開コンポーネントの参照と認証済みコンポーネントの参照での非 Lightning 名前空間の違い

公開サイトでは、非 Lightning 名前空間のコンポーネントの参照に古いコンテンツを含めることができます。wave:waveDashboard や force:createRecord などの非 Lightning コンポーネントについては、https://<myDomainName>.lightning.force.com/docs/component-library で仕様とドキュメントを確認してください。

ユーザ組織で開発された Lightning Web コンポーネントのドキュメントはサポートされない

コンポーネントの参照では、カスタム Lightning Web コンポーネントのドキュメントは表示されません。

[仕様] パネルの内容が表示されない

モジュールの [仕様] ページには説明やメソッドは表示されません。説明とメソッドは [ドキュメント] ページにあります。モジュールには次のものがあります。

• lightning/empApi
• lightning/flowSupport
• lightning/messageService
• lightning/navigation

属性によっては、デフォルト値があっても、[デフォルト] 列に値が表示されないものがあります。デフォルト値については、[説明] 列を参照してください。

[仕様] ページには、カスタムイベントは表示されません。この情報については、コンポーネントの [ドキュメント] ページを参照してください。

バージョン設定とローカライズがサポートされない

コンポーネントの参照には、現在のリリースのみに対応するドキュメントが表示されます。『Lightning Web Components 開発者ガイド』にあるバージョンや言語ピッカーはサポートされていません。