Newer Version Available

This content describes an older version of this product. View Latest

lightning__tabFocused

A Lightning message channel that corresponds to the lightning:tabFocused Aura app event. This message channel is available for Lightning web components used within a Lightning console app.

By default, this event is only received when that component's tab comes into focus, not when it leaves focus. To receive all events and minimize performance impact, use a utility item as the only listener.

Response

The response is the same as that of the lightning:tabFocused Aura app event.

LWC Example

Import the lightning__tabFocused message channel from the @salesforce/messageChannel/ scoped module. The event returns the message in the response.

For more information, see Subscribe and Unsubscribe from a Message Channel.