@openfin/core 29.71.15 → 29.71.22

package/OpenFin.d.ts

@@ -1700,11 +1700,11 @@ declare namespace OpenFin {
     export type ExternalApplicationEvents = import('./src/api/events/externalApplication').ExternalApplicationEvents;
 
     export type ContextMenuOptions = {
-        template: Array<PrebuiltContextMenuItems>;
+        template?: Array<PrebuiltContextMenuItem>;
         enabled?: boolean;
     };
 
-    export type PrebuiltContextMenuItems =
+    export type PrebuiltContextMenuItem =
         | 'separator'
         | 'cut'
         | 'copy'

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/core",
-    "version": "29.71.15",
+    "version": "29.71.22",
     "license": "Apache-2.0",
     "main": "./src/mock.js",
     "types": "./src/mock.d.ts",

package/src/api/view/Instance.d.ts

@@ -51,11 +51,27 @@ import UpdatableViewOptions = OpenFin.UpdatableViewOptions;
  * @property {string[]} [contentRedirect.blacklist=[]] List of blacklisted URLs.
  *
  * @property {object} [contextMenuSettings] - _Updatable._
+ * Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
  * Configure the context menu when right-clicking on a view.
  * @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
  * @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
  * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
  *
+ * @property {object} [contextMenuOptions] - _Updatable._
+ * Configure the context menu when right-clicking on a view. Supported menu items:
+ * 'separator'
+ * 'cut'
+ * 'copy'
+ * 'paste'
+ * 'spellCheck'
+ * 'inspect'
+ * 'reload'
+ * 'navigateForward'
+ * 'navigateBack'
+ * 'print'
+ * @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
+ * @property {string[]} [contextMenuOptions.template=[]] List of context menu items to display on right-click.
+ *
  * @property {any} [customData=""] - _Updatable._
  * A field that the user can attach serializable data to be ferried around with the view options.
  * _When omitted, the default value of this property is the empty string (`""`)._

package/src/api/view/Instance.js

@@ -54,11 +54,27 @@ const window_1 = require("../window");
  * @property {string[]} [contentRedirect.blacklist=[]] List of blacklisted URLs.
  *
  * @property {object} [contextMenuSettings] - _Updatable._
+ * Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
  * Configure the context menu when right-clicking on a view.
  * @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
  * @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
  * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
  *
+ * @property {object} [contextMenuOptions] - _Updatable._
+ * Configure the context menu when right-clicking on a view. Supported menu items:
+ * 'separator'
+ * 'cut'
+ * 'copy'
+ * 'paste'
+ * 'spellCheck'
+ * 'inspect'
+ * 'reload'
+ * 'navigateForward'
+ * 'navigateBack'
+ * 'print'
+ * @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
+ * @property {string[]} [contextMenuOptions.template=[]] List of context menu items to display on right-click.
+ *
  * @property {any} [customData=""] - _Updatable._
  * A field that the user can attach serializable data to be ferried around with the view options.
  * _When omitted, the default value of this property is the empty string (`""`)._

package/src/api/window/Instance.d.ts

@@ -160,11 +160,27 @@ import WindowEvents = OpenFin.WindowEvents;
  * Gives access to the devtools for the window.
  *
  * @property {object} [contextMenuSettings] - _Updatable._
+ * Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
  * Configure the context menu when right-clicking on a window.
  * @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
  * @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
  * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
  *
+ * @property {object} [contextMenuOptions] - _Updatable._
+ * Configure the context menu when right-clicking on a window. Supported menu items:
+ * 'separator'
+ * 'cut'
+ * 'copy'
+ * 'paste'
+ * 'spellCheck'
+ * 'inspect'
+ * 'reload'
+ * 'navigateForward'
+ * 'navigateBack'
+ * 'print'
+ * @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
+ * @property {string[]} [contextMenuSettings.template=[]] List of context menu items to display on right-click.
+ *
  * @property {object} [cornerRounding] - _Updatable._
  * Defines and applies rounded corners for a frameless window. **NOTE:** On macOS corner is not ellipse but circle rounded by the
  *  average of _height_ and _width_.

package/src/api/window/Instance.js

@@ -167,11 +167,27 @@ const view_1 = require("../view");
  * Gives access to the devtools for the window.
  *
  * @property {object} [contextMenuSettings] - _Updatable._
+ * Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
  * Configure the context menu when right-clicking on a window.
  * @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
  * @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
  * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
  *
+ * @property {object} [contextMenuOptions] - _Updatable._
+ * Configure the context menu when right-clicking on a window. Supported menu items:
+ * 'separator'
+ * 'cut'
+ * 'copy'
+ * 'paste'
+ * 'spellCheck'
+ * 'inspect'
+ * 'reload'
+ * 'navigateForward'
+ * 'navigateBack'
+ * 'print'
+ * @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
+ * @property {string[]} [contextMenuSettings.template=[]] List of context menu items to display on right-click.
+ *
  * @property {object} [cornerRounding] - _Updatable._
  * Defines and applies rounded corners for a frameless window. **NOTE:** On macOS corner is not ellipse but circle rounded by the
  *  average of _height_ and _width_.