IsConsoleNavigation Context Wire Adapter for Lightning Experience

Determines whether the app it’s used within uses console navigation. This wire adapter is available for Lightning Web Components (LWC) only.

To determine if the component is within a console app, use this wire adapter. If a caller component isn’t using the wire adapter inside a tab or subtab, the enclosing utility tab ID is null.

This component checks if it’s within a Lightning console app and returns the tab information using the IsConsoleNavigation wire adapter.

For another example that uses IsConsoleNavigation, see closeTab().

To make your component available for use in a Lightning console app, specify the lightning__AppPage target in the component’s configuration file.

If the current app uses console navigation, this method returns true, or false otherwise.

See Also

• LWC Dev Guide: Understand the Wire Service