Lightning Experience の isConsoleNavigation()
アプリケーションでコンソールナビゲーションが使用されているかどうかを判断します。
引数
なし。
LWC のサンプルコード
このコンポーネントは、自身が Lightning コンソールアプリケーション内にあるかどうかを確認してから、タブの情報を返します。
1import { LightningElement, wire } from 'lwc';
2import { IsConsoleNavigation, getFocusedTabInfo } from 'lightning/platformWorkspaceApi';
3export class ConsoleNavExample extends LightningElement {
4 @wire(IsConsoleNavigation) isConsoleNavigation;
5 handleClick() {
6 if (this.isConsoleNavigation) {
7 getFocusedTabInfo().then((tabInfo) => {
8 // do something with it
9 });
10 }
11 }
12}Aura コンポーネントのサンプルコード
このコンポーネントにはボタンがあり、押すと、現在のアプリケーションでコンソールナビゲーションが使用されているかどうかが出力されます。
コンポーネントコード:
1<aura:component implements="flexipage:availableForAllPageTypes" access="global" >
2 <lightning:workspaceAPI aura:id="workspace" />
3 <lightning:button label="Is Console Navigation?" onclick="{! c.isConsoleNavigation }" />
4</aura:component>コントローラーコード:
1({
2 isConsoleNavigation : function(component, event, helper) {
3 var workspaceAPI = component.find("workspace");
4 workspaceAPI.isConsoleNavigation().then(function(response) {
5 console.log(response);
6 })
7 .catch(function(error) {
8 console.log(error);
9 });
10 }
11})応答
このメソッドは、成功時に true (現在のアプリケーションでコンソールナビゲーションが使用されている場合) または false (使用されていない場合) に解決される Promise を返します。