@openfin/workspace-platform 9.1.6 → 9.1.7

package/common/src/utils/layout.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="@openfin/core" />
 import { AttachedPage, PageLayout } from '../../../client-api-platform/src/shapes';
+import { WindowIdentity } from './window';
 export declare type LayoutComponentStateExtended = OpenFin.LayoutComponent['componentState'] & {
     name: string;
     uuid: string;
@@ -38,6 +39,10 @@ export interface LayoutDOMEvent {
     isInitialized: boolean;
 }
 export declare type LayoutDOMEventListener = (ev: LayoutDOMEvent) => void;
+export declare const getFirstViewFromLayout: (identity?: WindowIdentity) => Promise<{
+    name: any;
+    uuid: any;
+}>;
 /**
  * Deep clones a layout and adds view names if they don't exist.
  * @param layout The Layout to be cloned

package/common/src/utils/menu-window-provider.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="@openfin/core" />
-import { ModalResponseContent, ResponseModalConfig } from '../../../common/src/utils/menu-config';
+import { ModalResponseContent } from '../../../common/src/utils/menu-config';
 import { Listener } from '../../../common/src/utils/shared-emitter';
 import type { OptionalExceptFor } from '../../../common/src/utils/types';
 import { _Window } from '@openfin/core/src/api/window';
@@ -37,9 +37,8 @@ export declare function createMenuPosition(windowOptions: OptionalExceptFor<Open
     top: number;
     left: number;
 }>;
-export declare function showChildWindow({ options, parameters }: ShowChildOptions, shouldCenterOnMonitor?: boolean): Promise<_Window>;
-export declare const getResponseModalBounds: (modalOptions: ResponseModalConfig['windowOptions'], parentWindowIdentity?: OpenFin.Identity, shouldCenterOnMonitor?: boolean) => Promise<import("@common/utils/window").Point>;
-export declare const waitForModalResponse: ({ options, content }: ResponseModalOptions, shouldCenterOnMonitor?: boolean) => Promise<{
+export declare function showChildWindow({ options, parameters }: ShowChildOptions): Promise<_Window>;
+export declare const waitForModalResponse: ({ options, content }: ResponseModalOptions) => Promise<{
     data: ModalResponse;
 }>;
 export {};

package/common/src/utils/response-modal-bounds.d.ts

@@ -0,0 +1,20 @@
+/// <reference types="@openfin/core" />
+import { ResponseModalConfig } from './menu-config';
+import { Point } from './window';
+/**
+ * returns the correct bounds for the response modal to be displayed at
+ * this will return the correct bounds regardless of whether the window is maximized
+ *
+ * @param modalOptions window options including height/width so that we can calculate the correct bounds
+ * @param parentWindowIdentity the window to get the bounds from
+ * @param centerOnMonitor whether the modal should be centered on the monitor
+ * @returns a point (top/left) as to where the window should be placed
+ */
+export declare const getResponseModalBounds: (modalOptions: ResponseModalConfig['windowOptions'], parentWindowIdentity?: OpenFin.Identity, centerOnMonitor?: boolean) => Promise<Point>;
+/**
+ * calculates the percenage of the window that is present within the monitor (float in range 0-1)
+ *
+ * @param bounds the bounds of the window
+ * @param monitor the monitor to check against
+ */
+export declare function getPercentageOfBoundsInMonitor(bounds: OpenFin.Bounds, monitor: OpenFin.MonitorDetails): number;