Loading
×Sorry to interrupt
CSS Error
Lightning Web Component

UI Record API

  • Descriptor

    lightning-ui-record-api

    Targets

    Lightning Experience, Experience Builder Sites, Salesforce Mobile App

The lightning/uiRecordApi module includes wire adapters to record data and get default values to create records. It also includes JavaScript APIs to create, delete, update, and refresh records.

The wire adapters are:

  • getRecord
  • getRecordCreateDefaults
  • getRecordUi (Deprecated)

The JavaScript methods are:

  • createRecord(recordInput)
  • createRecordInputFilteredByEditedFields(recordInput, originalRecord)
  • deleteRecord(recordId)
  • generateRecordInputForCreate(record, objectInfo)
  • generateRecordInputForUpdate(record, objectInfo)
  • getFieldValue(record, field)
  • getFieldDisplayValue(record, field)

For this module's specification and examples, see the Lightning Web Components Developer Guide.

LWC Recipes

The LWC Recipes GitHub repository contains code examples for Lightning Web Components that you can test in an org.

For a recipe that uses lightning/uiRecordApi, see the following components in the LWC Recipes repo.

  • c-wire-get-record-dynamic-contact
  • c-wire-get-record-static-contact
  • c-wire-get-record-user
Documentation
Specification