lightning/refresh Module

The lightning/refresh module provides you with the RefreshView API to refresh component data in a standard way.

lightning/refresh provides several methods:

When a refresh process completes, the status is returned via a promise. You can signal a refresh with RefreshEvent and register to receive RefreshEvent.

See Also

Release Preview

This release is in preview. Features described here don't become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can't guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

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 Agentforce Vibes for LWC Development
LWC API Modules
GraphQL API
experience/cms*Api Wire Adapters and Functions
experience/blockBuilderApi Module
lightning/commerceCartApi Module
lightning/commerceRegisterGuestBuyerApi Module
lightning/commerceRepricingApi Module
lightning/distributedMarketing Module
lightning/industriesEducationPublicApi Module
lightning/serviceKnowledgeApi Module
lightning/stateManager* State Managers
lightning/ui*Api Wire Adapters and Functions
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
registerRefreshContainer()
registerRefreshHandler()
unregisterRefreshContainer()
unregisterRefreshHandler()
RefreshStatus Constants
RefreshEvent Properties
Reference