Note: 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.

Event Handler Behavior for Active Components

To prevent active event handlers on cached pages from causing problems, add a workaround to your code to check if the component is still visible. To avoid this scenario and the workaround, use Lightning message service instead to communicate across the DOM within a Lightning page. The default scope used by Lightning message service channels publishes only to active components.

When navigating away from a page in Lightning Experience, the framework caches the components in the page so that they remain active, along with their event handlers. This caching speeds up navigation, but it can cause the cached component to respond to events that are not intended for it, such as force:refreshView or force:recordSaveSuccess.

This workaround uses the offsetParent property for the component to get its handlers while they’re visible. The workaround is good only if the component definition has an HTML element in it.

This component includes an event handler and some HTML.

1<!--myComponent.cmp-->
2<aura:component>
3  <aura:handler event="c:appEvent" action="{!c.onEvent}>
4  <h1>This component has a handler</h1>
5</aura:component>

Here’s the client-side controller that uses the offsetParent property to get the component’s handlers while they’re still visible.

1/* myComponentController.js */
2({
3  onEvent: function(component, event, helper) {
4    var elem = component.getElement();
5    if (elem && elem.offsetParent !== null) {
6      // event handling logic here
7    }
8  }
9})

Lightning Aura Components Developer Guide

Event Handler Behavior for Active Components

See Also