Introducing LWC Workspace API In #SalesforceWinter24Release

Introducing the LWC Workspace API, your ultimate tool to easily manage workspace tabs and subtabs in a Lightning console app. 

To harness the power of the LWC Workspace API, simply import the lightning/platformWorkspaceApi module. 

This will grant you access to a wide range of methods, wire adapters, and event-based APIs through the Lightning Message Service.

Please keep in mind that Lightning Web Security must be enabled in your Salesforce org, as Lightning Locker doesn't support the LWC Workspace API. 

Rest assured, once enabled, you will be able to utilize these incredible capabilities!

Here are some of the methods available for Lightning console apps using LWC:

- closeTab() - Say goodbye to clutter! 

With this method, you can effortlessly close a workspace tab or subtab.

- disableTabClose() - Prevent accidental closures! 

Safeguard your workspace tabs and subtabs by disabling the close option.

- focusTab() - Stay focused! 

Easily direct your attention to a specific workspace tab or subtab.

- getAllTabInfo() - Get a comprehensive overview! 

Retrieve information about all open tabs at once.

- getFocusedTabInfo() - Stay in the loop! Access essential information about the currently focused workspace tab or subtab.

- getTabInfo() - Dig deeper! 

Obtain specific information about a particular tab within your workspace.

- openSubtab() - Seamless navigation! 

Open a subtab within a workspace tab. 

If it's already open, the subtab will be focused.

- openTab() - Expanding possibilities! 

Unleash the potential of your workspace by opening new tabs. 

Already open? No worries, the tab will be focused.

- refreshTab() - Stay up-to-date! 

Ensure your workspace tab or subtab receives the latest information by refreshing it.

- setTabHighlighted() - Spotlight on! 

Highlight a specific tab with a different background color and a badge.

(Note: Highlights won't persist after reloading the Lightning console app)

- setTabIcon() - Personalize appearance! Set the icon and alternative text for a specific tab.

- setTabLabel() - Easy organization! Customize the label of a specific tab.

In addition to these methods, we also have wire adapters available for Lightning console apps:

- EnclosingTabId() - Discover the ID of the enclosing tab.

- IsConsoleNavigation() - Determine whether the app uses console navigation.

Last but not least, we have Lightning message channels that correspond to the Aura application events, further enriching your Lightning console app experience. 

Subscribe to these channels to listen for the events you're interested in:

- lightning__tabClosed - Know when a tab has been closed.

- lightning__tabCreated - Stay informed when a new tab is created successfully.

- lightning__tabFocused - Receive updates when a tab is being focused.

- lightning__tabRefreshed - Get notified when a tab has been refreshed.

- lightning__tabReplaced - Stay in the loop whenever a tab is replaced successfully.

- lightning__tabUpdated - Get updates when a tab has been updated successfully.