Considerations for Using RefreshView API

Keep these considerations in mind when developing features that use RefreshView API.

  • Use RefreshView API when you work with Aura components or data from third parties. In those cases, components participating in RefreshView API can use notifyRecordUpdateAvailable(recordIds) or refreshApex or both to refresh data that they receive from Lightning Data Service.
  • Register the refresh() callback with lightning/refresh only for the components that you want to participate in the refresh.
  • Components aren’t responsible for refreshing their descendants — descendants must register their own callbacks to participate in refresh outside of normal value propagation.
  • To allow for scoped refresh trees, containers register similarly to components that want to refresh themselves.

Get Started
Create Lightning Web Components
Work with Lightning Base Components
Communicate with Events
Work with Salesforce Data
Data Guidelines
Lightning Data Service
Work with Records Using Base Components
Use the Wire Service to Get Data
Manage State Across LWC Components
Call Apex Methods
Refresh Component Data with RefreshView API
RefreshView API User Experience
Use RefreshView API
RefreshView API Example
Considerations for Using RefreshView API
Call APIs from Apex
Work with Errors
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
Reference