@openfin/core 28.72.8 → 28.72.10

package/package.json

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

package/src/api/platform/layout/controllers/tab-drag-controller.d.ts

@@ -9,17 +9,24 @@ export declare class TabDragController {
     constructor(viewOverlay: ViewOverlay);
     private dropZonePreview?;
     /**
-     * When a tab is dragged from a stack greater than one, it's view will need to be hidden and the
-     * view next in the stack shown.
      *
-     * Conversely, when a view is the last view in a window, it will need to remain visible.
+     * When a tab is dragged out of a stack, it will need to be hidden from the stack.
      *
-     * This function implements this logic accordingly
-     * @param movingView The view which is currently being dragged
-     * @param currentView The current active view of the tabstack
-     * @param isOnlyViewInWindow Indicates whether the moving view is the only in the platform window.
+     * Additionally, if there is a new view to show in the stack, it will be shown at the position specified by
+     * containerBounds
+     *
+     * As drag interactions can under extreme circumstances complete before this chain of promises has completed,
+     * we need to pass in a isDragging() function which returns whether the drag is in progress.
+     * This allows us to cancel any layout affecting operations.
+     *
+     * @param draggingView The view which is currently being dragged
+     * @param isLastViewInWindow Whether the draggin view is the last view in a window or not. If false, the dragging view will not hide.
+     * @param isDragging A function which returns true if the drag is still in progress. As we chain some async calls here, we want to avoid
+     * modifying any views if the drag has completed (as the post drag procedure will have taken care of it.)
+     * @param containerBounds The bounds of the container of the view to be shown in the stack
+     * @param nextView The view which has become active after dragging the draggingView out.
      */
-    handleTabStackActiveView: (movingView: View, currentView: View, isOnlyViewInWindow: boolean) => Promise<void>;
+    handleTabStackActiveView: (draggingView: View, isLastViewInWindow: boolean, isDragging: () => boolean, containerBounds?: OpenFin.Bounds, nextView?: View) => Promise<void>;
     /**
      * Extracts the border and backgroundColor css values from the drop zone preview,
      * and sets the viewOverlay to match them.
@@ -38,6 +45,8 @@ export declare class TabDragController {
      * Disables the click through setting on every view in the platform.
      */
     endDrag: () => Promise<void>;
+    private disposeObserve?;
+    disposeOverlayObserver: () => void;
     /**
      * Observes a golden-layout drop zone preview in order to render a BrowserView
      * overlay whenever a tab is dragged over a droppable region.

package/src/api/platform/layout/controllers/tab-drag-controller.js

@@ -11,29 +11,36 @@ class TabDragController {
     constructor(viewOverlay) {
         this.viewOverlay = viewOverlay;
         /**
-         * When a tab is dragged from a stack greater than one, it's view will need to be hidden and the
-         * view next in the stack shown.
          *
-         * Conversely, when a view is the last view in a window, it will need to remain visible.
+         * When a tab is dragged out of a stack, it will need to be hidden from the stack.
          *
-         * This function implements this logic accordingly
-         * @param movingView The view which is currently being dragged
-         * @param currentView The current active view of the tabstack
-         * @param isOnlyViewInWindow Indicates whether the moving view is the only in the platform window.
+         * Additionally, if there is a new view to show in the stack, it will be shown at the position specified by
+         * containerBounds
+         *
+         * As drag interactions can under extreme circumstances complete before this chain of promises has completed,
+         * we need to pass in a isDragging() function which returns whether the drag is in progress.
+         * This allows us to cancel any layout affecting operations.
+         *
+         * @param draggingView The view which is currently being dragged
+         * @param isLastViewInWindow Whether the draggin view is the last view in a window or not. If false, the dragging view will not hide.
+         * @param isDragging A function which returns true if the drag is still in progress. As we chain some async calls here, we want to avoid
+         * modifying any views if the drag has completed (as the post drag procedure will have taken care of it.)
+         * @param containerBounds The bounds of the container of the view to be shown in the stack
+         * @param nextView The view which has become active after dragging the draggingView out.
          */
-        this.handleTabStackActiveView = async (movingView, currentView, isOnlyViewInWindow) => {
+        this.handleTabStackActiveView = async (draggingView, isLastViewInWindow, isDragging, containerBounds, nextView) => {
             if (this.dropZonePreview) {
-                const hideMovingViewIfPossible = async () => {
-                    if (!isOnlyViewInWindow) {
-                        await movingView.hide();
+                if (nextView && containerBounds) {
+                    if (isDragging()) {
+                        await (nextView === null || nextView === void 0 ? void 0 : nextView.show());
                     }
-                };
-                const showCurrentView = async () => {
-                    if (currentView.identity.name !== movingView.identity.name) {
-                        await currentView.show();
+                    if (isDragging()) {
+                        await (nextView === null || nextView === void 0 ? void 0 : nextView.setBounds(containerBounds));
                     }
-                };
-                await Promise.all([hideMovingViewIfPossible(), showCurrentView()]);
+                }
+                if (isDragging() && !isLastViewInWindow) {
+                    await draggingView.hide();
+                }
             }
         };
         /**
@@ -63,6 +70,12 @@ class TabDragController {
         this.endDrag = async () => {
             await this.viewOverlay.setIgnoreViewMouseEvents(false);
         };
+        this.disposeOverlayObserver = () => {
+            if (this.disposeObserve) {
+                this.disposeObserve();
+            }
+            this.dropZonePreview = undefined;
+        };
         /**
          * Observes a golden-layout drop zone preview in order to render a BrowserView
          * overlay whenever a tab is dragged over a droppable region.
@@ -74,7 +87,7 @@ class TabDragController {
                 this.dropZonePreview = dropZonePreview;
                 let lastBounds;
                 dropZonePreview.style.visibility = 'hidden';
-                dropZonePreview.addEventListener('drop-area-highlighted', async (e) => {
+                const onDropAreaHighlighted = async (e) => {
                     try {
                         const { bounds } = e.detail;
                         if (!lastBounds || !bounds_observer_1.isDomRectEqual(lastBounds, bounds)) {
@@ -85,8 +98,8 @@ class TabDragController {
                     catch (error) {
                         console.warn('Unexpected error encountered rendering tab drag preview.', error);
                     }
-                });
-                dropZonePreview.addEventListener('drop-area-hidden', async () => {
+                };
+                const onDropAreaHidden = async () => {
                     try {
                         lastBounds = undefined;
                         await this.viewOverlay.detachOverlay();
@@ -94,7 +107,16 @@ class TabDragController {
                     catch (error) {
                         console.warn('Unexpected error encountered hiding tab drag preview.', error);
                     }
-                });
+                };
+                dropZonePreview.addEventListener('drop-area-highlighted', onDropAreaHighlighted);
+                dropZonePreview.addEventListener('drop-area-hidden', onDropAreaHidden);
+                this.disposeObserve = () => {
+                    dropZonePreview.removeEventListener('drop-area-highlighted', onDropAreaHighlighted);
+                    dropZonePreview.removeEventListener('drop-area-hidden', onDropAreaHidden);
+                };
+            }
+            else {
+                console.warn('Tried to observe a drop zone overlay without disposing the previous.');
             }
         };
     }

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

@@ -16,6 +16,36 @@ import UpdatableViewOptions = OpenFin.UpdatableViewOptions;
  *
  * @property {boolean} [experimental.childWindows] Configure if the runtime should enable child windows for views.
  *
+ * @property {object} [accelerator]
+ * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
+ *
+ * @property {boolean} [accelerator.devtools=false]
+ * If `true`, enables the devtools keyboard shortcut:<br>
+ * `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
+ *
+ * @property {boolean} [accelerator.reload=false]
+ * If `true`, enables the reload keyboard shortcuts:<br>
+ * `Ctrl` + `R` _(Windows)_<br>
+ * `F5` _(Windows)_<br>
+ * `Command` + `R` _(Mac)_
+ *
+ * @property {boolean} [accelerator.reloadIgnoringCache=false]
+ * If `true`, enables the reload-from-source keyboard shortcuts:<br>
+ * `Ctrl` + `Shift` + `R` _(Windows)_<br>
+ * `Shift` + `F5` _(Windows)_<br>
+ * `Command` + `Shift` + `R` _(Mac)_
+ *
+ * @property {boolean} [accelerator.zoom=false]
+ * If `true`, enables the zoom keyboard shortcuts:<br>
+ * `Ctrl` + `+` _(Zoom In)_<br>
+ * `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
+ * `Ctrl` + `NumPad+` _(Zoom In)_<br>
+ * `Ctrl` + `-` _(Zoom Out)_<br>
+ * `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
+ * `Ctrl` + `NumPad-` _(Zoom Out)_<br>
+ * `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
+ * `Ctrl` + `0` _(Restore to 100%)_
+ *
  * @property {object} [api]
  * Configurations for API injection.
  *
@@ -127,7 +157,7 @@ import UpdatableViewOptions = OpenFin.UpdatableViewOptions;
  * really no need to provide it.
  */
 /**
- * @classdesc a View can be used to embed additional web content into a Window.
+ * @classdesc A View can be used to embed additional web content into a Window.
  * It is like a child window, except it is positioned relative to its owning window.
  * It has the ability to listen for <a href="tutorial-View.EventEmitter.html">View-specific events</a>.
  *

package/src/api/view/Instance.js

@@ -19,6 +19,36 @@ const window_1 = require("../window");
  *
  * @property {boolean} [experimental.childWindows] Configure if the runtime should enable child windows for views.
  *
+ * @property {object} [accelerator]
+ * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
+ *
+ * @property {boolean} [accelerator.devtools=false]
+ * If `true`, enables the devtools keyboard shortcut:<br>
+ * `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
+ *
+ * @property {boolean} [accelerator.reload=false]
+ * If `true`, enables the reload keyboard shortcuts:<br>
+ * `Ctrl` + `R` _(Windows)_<br>
+ * `F5` _(Windows)_<br>
+ * `Command` + `R` _(Mac)_
+ *
+ * @property {boolean} [accelerator.reloadIgnoringCache=false]
+ * If `true`, enables the reload-from-source keyboard shortcuts:<br>
+ * `Ctrl` + `Shift` + `R` _(Windows)_<br>
+ * `Shift` + `F5` _(Windows)_<br>
+ * `Command` + `Shift` + `R` _(Mac)_
+ *
+ * @property {boolean} [accelerator.zoom=false]
+ * If `true`, enables the zoom keyboard shortcuts:<br>
+ * `Ctrl` + `+` _(Zoom In)_<br>
+ * `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
+ * `Ctrl` + `NumPad+` _(Zoom In)_<br>
+ * `Ctrl` + `-` _(Zoom Out)_<br>
+ * `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
+ * `Ctrl` + `NumPad-` _(Zoom Out)_<br>
+ * `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
+ * `Ctrl` + `0` _(Restore to 100%)_
+ *
  * @property {object} [api]
  * Configurations for API injection.
  *
@@ -130,7 +160,7 @@ const window_1 = require("../window");
  * really no need to provide it.
  */
 /**
- * @classdesc a View can be used to embed additional web content into a Window.
+ * @classdesc A View can be used to embed additional web content into a Window.
  * It is like a child window, except it is positioned relative to its owning window.
  * It has the ability to listen for <a href="tutorial-View.EventEmitter.html">View-specific events</a>.
  *