Migrate のインターフェース

Aura インターフェースを実装すると、コンテキストデータを受信したり、Lightning アプリケーションビルダーやエクスペリエンスビルダーなどの別のコンテキストでカスタムコンポーネントを表示したりできます。

Lightning Web コンポーネントでコンテキストデータを受信するには、対応するモジュールをインポートします。異なるコンテキストでコンポーネントを表示するには、*.js-meta.xml 設定ファイルで targets メタデータを使用します。

リストされていない Aura インターフェースは、現在 Lightning Web コンポーネントに相当するものがないイベントです。

clients:availableForMailAppPage

*.js-meta.xml 内:

1<targets>
2  <target>lightning__Inbox</target>
3</targets>

Lightning アプリケーションビルダーでコンポーネントを使用して、Outlook および Gmail インテグレーションのメールアプリケーションペインに追加できることを示します。「Outlook および Gmail インテグレーションのコンポーネントの作成」を参照してください。

clients:hasEventContext

1import { LightningElement, api } from 'lwc';
2  @api dates;
3  @api location;

*.js-meta.xml 内:

1<targets>
2  <target>lightning__Inbox</target>
3</targets>

Outlook および Gmail インテグレーションで使用される場合、コンポーネントでイベントに関するコンテキスト情報を取得することを示します。「Outlook および Gmail インテグレーションのコンポーネントの作成」を参照してください。

clients:hasItemContext

1import { LightningElement, api } from 'lwc';
2  @api mode;
3  @api people;
4  @api source;
5  @api subject;
6  @api messageBody;

場所: *.js-meta.xml:

1<targets>
2  <target>lightning__Inbox</target>
3</targets>

Outlook および Gmail インテグレーションで使用される場合、コンポーネントでメールまたはカレンダーの行動に関するコンテキスト情報を取得することを示します。「Outlook および Gmail インテグレーションのコンポーネントの作成」を参照してください。

flexipage:availableForAllPageTypes

場所: *.js-meta.xml:

1<targets>
2  <target>lightning__AppPage</target>
3  <target>lightning__RecordPage</target>
4  <target>lightning__HomePage</target>
5  <target>lightning__UtilityBar</target>
6</targets>

コンポーネントをレコードページ、ユーティリティバー、および他のページ種別で使用できることを示します。明示的に各ページ種別を対象として指定します。「Lightning アプリケーションビルダーのコンポーネントの設定」および「ユーティリティバーのコンポーネントの設定」を参照してください。

flexipage:availableForRecordHome

1<targets>
2  <target>lightning__RecordPage</target>
3</targets>

コンポーネントをレコードページでのみ使用できることを示します。

force:hasRecordId

1import { LightningElement, api } from 'lwc';
2  @api recordId;

場所: *.js-meta.xml:

1<targets>
2  <target>lightning__RecordPage</target>
3</targets>

コンポーネントでレコード ID を属性として取得することを示します。「コンポーネントでのレコードコンテキストの認識」を参照してください。

force:hasSObjectName

1import { LightningElement, api } from 'lwc';
2  @api objectApiName;

場所: *.js-meta.xml:

1<targets>
2  <target>lightning__RecordPage</target>
3</targets>

コンポーネントで現在のレコードのオブジェクト種別の API 参照名を取得することを示します。「コンポーネントでのオブジェクトコンテキストの認識」を参照してください。

force:lightningQuickAction

場所: *.js-meta.xml:

1<targets>
2  <target>lightning__RecordAction</target>
3</targets>
4<targetConfigs>
5  <targetConfig targets="lightning__RecordAction">
6    <actionType>ScreenAction</actionType>
7  </targetConfig>
8</targetConfigs>

コンポーネントがクイックアクションであることを示します。「クイックアクション用のコンポーネントの設定」を参照してください。

現在、LWC クイックアクションは、レコードページでのみサポートされています。

Note

force:lightningQuickActionWithoutHeader

場所: *.js-meta.xml:

1<targets>
2  <target>lightning__RecordAction</target>
3</targets>
4<targetConfigs>
5  <targetConfig targets="lightning__RecordAction">
6    <actionType>ScreenAction</actionType>
7  </targetConfig>
8</targetConfigs>

コンポーネントがヘッダーのないクイックアクションであることを示します。「クイックアクション用のコンポーネントの設定」を参照してください。

現在、LWC クイックアクションは、レコードページでのみサポートされています。

Note

forceCommunity:availableForAllPageTypes

場所: *.js-meta.xml:

1<targets>
2  <target>lightningCommunity__Page</target>
3</targets>

コンポーネントがエクスペリエンスビルダーで使用できることを示します。「エクスペリエンスビルダーのコンポーネントの設定」を参照してください。

lightning:hasPageReference

1import { CurrentPageReference } from 'lightning/navigation';
2  @wire(CurrentPageReference) pageRef;

コンポーネントで PageReference を受け入れることを示します。「ページ、レコード、リストへの移動」を参照してください。

The Japanese Summer '24 guide is now live

日本語の Summer '24 ガイドが公開されました! 「Component Reference (コンポーネントリファレンス)」は、以前と同様にコンポーネントライブラリにあります。