No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Develop Secure Code
HTML Template Directives
HTML Template Errors
Decorators
@salesforce Modules
LWC API Modules
ui*Api Supported Objects
PageReference Types
lightning/ui*Api
Wire Adapters and FunctionsWire 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.
lightning/uiAppsApi
(Beta)lightning/uiLayoutApi
lightning/uiLearningPlatformApi
lightning/uiListsApi
lightning/uiListApi
(Deprecated)lightning/uiObjectInfoApi
lightning/uiRecordApi
lightning/uiRelatedListApi
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