@openfin/workspace-platform 20.1.7 → 20.1.9

package/client-api/src/shapes/dock.d.ts

@@ -177,6 +177,13 @@ export interface DockProviderConfig {
      * @default false
      */
     disableUserRearrangement?: boolean;
+    /**
+     * Default value for the "Always On Top" setting when no localStorage value exists.
+     * If not defined, defaults to true.
+     *
+     * @default true
+     */
+    defaultToAlwaysOnTop?: boolean;
     /**
      * A UI friendly title for the provider platform.
      */

package/common/src/components/Icon/CustomIcon.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
-import { IconSizeType } from '@openfin/ui-library';
+import { IconSizeType, IconType } from '@openfin/ui-library';
 /**
  * Simple and reusable icon component. The required prop is an iconURL.
  */
@@ -10,6 +10,10 @@ interface CustomIconProps {
     description?: string;
     backgroundColor?: string;
     applyThemeColor?: boolean;
+    fallbackIcon?: IconType;
+    overlayIcon?: IconType;
+    useDynamicDimensions?: boolean;
+    maxHeight?: number;
 }
 export declare const CustomIcon: React.FC<CustomIconProps>;
 export {};

package/common/src/hooks/useLoadCustomIcon.d.ts

@@ -0,0 +1,21 @@
+interface UseLoadCustomIconResult {
+    dynamicDimensions: {
+        width: string;
+        height: string;
+    } | null;
+    isLoading: boolean;
+    hasError: boolean;
+}
+interface UseLoadCustomIconOptions {
+    iconURL?: string;
+    useDynamicDimensions?: boolean;
+    customIconAccessible?: boolean;
+    maxHeight?: number;
+}
+/**
+ * Custom hook that loads an image and extracts its dimensions for dynamic sizing
+ * @param options Configuration options for the hook
+ * @returns Object containing dynamic dimensions, loading state, and error state
+ */
+export declare const useLoadCustomIcon: ({ iconURL, useDynamicDimensions, customIconAccessible, maxHeight }: UseLoadCustomIconOptions) => UseLoadCustomIconResult;
+export {};

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

@@ -1,4 +1,5 @@
 import type OpenFin from '@openfin/core';
+import type { SearchProviderInfo } from '../../../search-api/src/shapes';
 import { ApplicationUUID } from './application';
 export declare enum WindowName {
     Home = "openfin-home",
@@ -165,6 +166,13 @@ export declare const getComponentWindowStatus: () => Promise<{
 }>;
 export declare const deserializeWindowBounds: (serialized: string) => OpenFin.WindowBounds | null;
 export declare const serializeWindowBounds: (bounds: OpenFin.WindowBounds) => string;
+/**
+ * Calculates the dynamic height for the home window based on subheader configuration
+ * @param baseHeight - The base height for the home window
+ * @param subHeaderConfig - The subheader configuration from search provider
+ * @returns The calculated height based on missing subheader elements
+ */
+export declare const calculateHomeWindowHeight: (baseHeight: number, subHeaderConfig?: SearchProviderInfo['subHeader']) => number;
 export declare const getWindowBounds: (window: OpenFin.Window) => Promise<OpenFin.RectangleByEdgePositions>;
 /**
  * calculates the percenage of the window that is present within the monitor (float in range 0-1)