Documentation Index
Fetch the complete documentation index at: https://mintlify.com/trailheadapps/lwc-recipes/llms.txt
Use this file to discover all available pages before exploring further.
Wire adapters for retrieving picklist values for specific fields or all picklists on an object by record type.
getPicklistValues
Retrieves picklist values for a specific field.
Import
import { getPicklistValues } from 'lightning/uiObjectInfoApi';
Parameters
The record type ID. Use '012000000000000AAA' for the master record type.
The field API name as a field reference from @salesforce/schema.
Basic Usage
import { LightningElement, wire } from 'lwc';
import { getPicklistValues } from 'lightning/uiObjectInfoApi';
import TYPE_FIELD from '@salesforce/schema/Account.Type';
export default class WireGetPicklistValues extends LightningElement {
@wire(getPicklistValues, {
recordTypeId: '012000000000000AAA',
fieldApiName: TYPE_FIELD
})
picklistValues;
}
{
values: [
{
label: 'Display Label',
value: 'API_Value',
validFor: [],
attributes: null
}
],
defaultValue: null,
controllerValues: {}
}
getPicklistValuesByRecordType
Retrieves all picklist field values for an object by record type.
Import
import { getPicklistValuesByRecordType } from 'lightning/uiObjectInfoApi';
Parameters
The API name of the object.
The record type ID. Use '012000000000000AAA' for the master record type.
Basic Usage
import { LightningElement, wire } from 'lwc';
import { getPicklistValuesByRecordType } from 'lightning/uiObjectInfoApi';
import ACCOUNT_RECORD from '@salesforce/schema/Account';
export default class WireGetPicklistValuesByRecordType extends LightningElement {
treeModel;
error;
@wire(getPicklistValuesByRecordType, {
objectApiName: ACCOUNT_RECORD,
recordTypeId: '012000000000000AAA'
})
wiredValues({ error, data }) {
if (data) {
this.treeModel = this.buildTreeModel(data.picklistFieldValues);
this.error = undefined;
} else {
this.error = error;
this.treeModel = undefined;
}
}
buildTreeModel(picklistValues) {
const treeNodes = [];
Object.keys(picklistValues).forEach((picklist) => {
treeNodes.push({
label: picklist,
items: picklistValues[picklist].values.map((item) => ({
label: item.label,
name: item.value
}))
});
});
return treeNodes;
}
}
{
picklistFieldValues: {
FieldApiName: {
values: [...],
defaultValue: null,
controllerValues: {}
}
}
}
Master Record Type
Use the ID '012000000000000AAA' to retrieve picklist values for the master record type:
@wire(getPicklistValues, {
recordTypeId: '012000000000000AAA', // Master record type
fieldApiName: TYPE_FIELD
})
picklistValues;
Reactive Parameters
Make parameters reactive using the $ prefix:
export default class Example extends LightningElement {
recordTypeId = '012000000000000AAA';
@wire(getPicklistValues, {
recordTypeId: '$recordTypeId',
fieldApiName: TYPE_FIELD
})
picklistValues;
}
Source Examples
wireGetPicklistValues - Single field picklist valueswireGetPicklistValuesByRecordType - All picklists for a record type
