lightning/ui*Api Wire Adapters and Functions

Wire adapters and JavaScript functions in these modules are built on top of Lightning Data Service (LDS) and User Interface API. Use these wire adapters and functions to work with Salesforce data and metadata.

The Syntax sections in the following topics use TypeScript formatting. We use this formatting to make the API syntax easier to understand. For example, functions may be described by the function name, parameter name and type, and a return type like this.

createRecord(recordInput: Record): Promise<Record>

Optional parameters are appended with ? like objectInfo?: ObjectInfo. For more information, see the TypeScript Handbook.

TypeScript support is in developer preview. We're working on adding type definitions for components and modules in the lightning namespace.

Note

For information about how LDS and User Interface API work, see Lightning Data Service.

See Also

The Summer '25 guide is now live

Looking for the Component Reference? Go to https://developer.salesforce.com/docs/component-library/.

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
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
Aura Coexistence
Migrate Aura Components
Debug Lightning Web Components
Test Lightning Web Components
Improve Performance
Reference
XML Configuration File Elements
HTML Template Directives
HTML Template Errors
Decorators
Salesforce Objects Support in LWC
@salesforce Modules
LWC API Modules
experience/cms*Api Wire Adapters and Functions
lightning/industriesEducationPublicApi Module
lightning/serviceKnowledgeApi Module
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
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
lightning/uiGraphQLApi Wire Adapters and Functions
PageReference Types