@openfin/workspace-platform 22.5.4 → 22.5.5

package/common/src/api/protocol/browser.d.ts

@@ -58,12 +58,14 @@ export declare enum PageChannelAction {
 export declare enum CompanionDockChannelAction {
     UpdateFavoriteEntries = "update-favorite-entries",
     UpdateContentMenu = "update-content-menu",
-    NavigateContentMenu = "navigate-content-menu"
+    NavigateContentMenu = "navigate-content-menu",
+    MoreMenuCustomOptionClicked = "more-menu-custom-option-clicked"
 }
 export declare const BrowserChannelAction: {
     UpdateFavoriteEntries: CompanionDockChannelAction.UpdateFavoriteEntries;
     UpdateContentMenu: CompanionDockChannelAction.UpdateContentMenu;
     NavigateContentMenu: CompanionDockChannelAction.NavigateContentMenu;
+    MoreMenuCustomOptionClicked: CompanionDockChannelAction.MoreMenuCustomOptionClicked;
     GetPages: PageChannelAction.GetPages;
     GetActivePageForWindow: PageChannelAction.GetActivePageForWindow;
     AttachPagesToWindow: PageChannelAction.AttachPagesToWindow;

package/dock3/src/api/protocol.d.ts

@@ -1 +1,7 @@
-export {};
+/**
+ * Payload for more menu custom option actions
+ */
+export interface MoreMenuCustomOptionPayload {
+    action: string;
+    customData?: any;
+}

package/dock3/src/api/provider.d.ts

@@ -2,6 +2,7 @@ import type { OpenFin } from '@openfin/core';
 import { BookmarkDockEntryPayload, LaunchDockEntryPayload } from '../../../client-api-platform/src/index';
 import { Dock3Config } from '../../../dock3/src/shapes';
 import { Async, CamelCase } from '../../../dock3/src/utils';
+import { MoreMenuCustomOptionPayload } from './protocol';
 import { Dock3ChannelProvider, Dock3ChannelProviderChannelActions } from './protocol';
 type InternalDock3ChannelActions = 'ready';
 type Dock3ProviderAPI = {
@@ -22,6 +23,11 @@ export declare class Dock3Provider {
      */
     get ready(): Promise<void>;
     bookmarkContentMenuEntry(payload: BookmarkDockEntryPayload): Promise<void>;
+    /**
+     * Override this method to handle clicks on custom menu items.
+     * Called when user clicks on a custom menu option.
+     */
+    moreMenuCustomOptionClicked(payload: MoreMenuCustomOptionPayload): Promise<void>;
     /**
      * Read-only access to the current configuration of the Dock3Provider.
      */

package/dock3/src/shapes/shapes.d.ts

@@ -1,5 +1,6 @@
 import type { OpenFin } from '@openfin/core';
 import { WorkspaceButton } from '../../../client-api/src/dock';
+import { BaseCustomDropdownItem } from '../../../client-api/src/shapes';
 import { ContentMenuEntry, DockEntry, TaskbarIcon } from '../../../client-api-platform/src/shapes';
 export type { Dock3Provider, Dock3ConstructorOverride } from '../api/provider';
 export type Dock3Button = WorkspaceButton | 'contentMenu' | 'manageWorkspaces';
@@ -57,6 +58,14 @@ export interface Dock3Config {
                  */
                 skipDialog?: boolean;
             };
+            /**
+             * Custom menu option to display in the dock more menu.
+             * Configuration for customizable menu items that will appear in the dock context menu.
+             */
+            moreMenuCustomOption?: {
+                label: string;
+                options: BaseCustomDropdownItem[];
+            };
         };
         manageWorkspaces?: {
             newWindow?: {

package/externals.report.json

@@ -38,6 +38,12 @@
         }
     ],
     "dexie": [
+        {
+            "type": "root-implicit",
+            "version": "^4.0.11",
+            "packageName": "common/package.json",
+            "issuer": "common/src/api/pages/idb.ts"
+        },
         {
             "type": "explicit",
             "version": "^4.0.11",
@@ -50,12 +56,6 @@
             "packageName": "dock3/package.json",
             "issuer": "dock3/src/api/idb.ts"
         },
-        {
-            "type": "root-implicit",
-            "version": "^4.0.11",
-            "packageName": "common/package.json",
-            "issuer": "common/src/api/pages/idb.ts"
-        },
         {
             "type": "root-implicit",
             "version": "^4.0.11",