getPicklistValues

指定した項目の選択リスト値を取得するには、このワイヤアダプタを使用します。

構文

1import { LightningElement, wire } from "lwc";
2import { getPicklistValues } from "lightning/uiObjectInfoApi";
3import INDUSTRY_FIELD from "@salesforce/schema/Account.Industry";
4
5export default class Example extends LightningElement {
6  @wire(getPicklistValues, { recordTypeId: "012000000000000AAA", fieldApiName: INDUSTRY_FIELD })
7  propertyOrFunction;
8}

ユーザインターフェース API リソース

1GET /ui-api/object-info/{objectApiName}/picklist-values/{recordTypeId}/{fieldApiName}

getPicklistValues は、このユーザインターフェース API リソースを使用します。

パラメータ

recordTypeId — (必須) レコードタイプの ID。getObjectInfo から返されるオブジェクト情報 defaultRecordTypeId プロパティを使用します。
fieldApiName — (必須) サポートされているオブジェクトの選択リスト項目の API 参照名。
propertyOrFunction — ワイヤサービスからデータのストリームを受信する非公開のプロパティまたは関数。プロパティが @wire でデコレートされている場合、結果はそのプロパティの data プロパティまたは error プロパティに返されます。関数が @wire でデコレートされている場合、結果は data プロパティと error プロパティを持つオブジェクトで返されます。

このワイヤアダプタと組み合わせた objectApiName の使用はサポートされていません。これは、この情報もすでに fieldApiName と一緒に含まれているためです。

Note

戻り値

data — 選択リスト値
error — FetchResponse

使用方法

選択リストの値は、レコードタイプを範囲とします。連動選択リストの場合、getPicklistValues は、項目および項目を選択リストに対応付ける方法を制御するためのデータを返します。詳細は、「選択リストの UI の構築」を参照してください。

レコードタイプのすべての選択リストを取得するには、代わりに getPicklistValuesByRecordType を使用します。

例

lwc-recipes GitHub リポジトリの wireGetPicklistValues コンポーネントを参照してください。

関連トピック

The Japanese Summer '24 guide is now live

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