lightning/uiRecordApi

This module includes wire adapters to get record data. It also includes imperative JavaScript functions to create, delete, update, and refresh records.

Get Started
Create Lightning Web Components
Work with Lightning Base Components
Communicate with Events
Work with Salesforce Data
Develop Secure Code
Use Components in Salesforce Targets
Use Components Outside Salesforce with Lightning Out 2.0
Aura Coexistence
Migrate Aura Components
Debug Lightning Web Components
Test Lightning Web Components
Improve Performance
Use DX MCP Tools for LWC (Beta)
LWC API Modules
GraphQL API
experience/cms*Api Wire Adapters and Functions
experience/blockBuilderApi Module
lightning/industriesEducationPublicApi Module
lightning/serviceKnowledgeApi Module
lightning/stateManager* State Managers
lightning/ui*Api Wire Adapters and Functions
ui*Api Supported Objects
lightning/uiAppsApi (Beta)
lightning/uiLayoutApi
lightning/uiLearningPlatformApi
lightning/uiListsApi
lightning/uiListApi (Deprecated)
lightning/uiObjectInfoApi
lightning/uiRecordApi
createRecord(recordInput)
createRecordInputFilteredByEditedFields(recordInput, originalRecord)
deleteRecord(recordId)
generateRecordInputForCreate(record,objectInfo)
generateRecordInputForUpdate(record, objectInfo)
getFieldValue(record, field)
getFieldDisplayValue(record, field)
getRecord
getRecords
getRecordCreateDefaults
getRecordNotifyChange(recordIds) (Deprecated)
getRecordUi (Deprecated)
notifyRecordUpdateAvailable(recordIds)
updateRecord(recordInput, clientOptions)
lightning/uiRelatedListApi
lightning/analyticsSmartDataDiscoveryApi Wire Adapters and Functions
lightning/analyticsWaveApi Wire Adapters and Functions
lightning/cmsDeliveryApi Wire Adapters and Functions (Beta)
lightning/fileDownload Module
lightning/mobileCapabilities Module
lightning/refresh Module
Reference