@openfin/core 45.100.29 → 45.100.32

package/out/mock-alpha.d.ts

@@ -4434,6 +4434,27 @@ declare type CreateLayoutOptions = {
      * @default 'default'
      */
     multiInstanceViewBehavior?: MultiInstanceViewBehavior;
+    /**
+     * Callback invoked for each stack when its header controls area is rendered.
+     * The callback receives the `.lm_controls` DOM element and a context object
+     * with a {@link HeaderControlsContext.getStack | getStack()} async getter.
+     * Use this to inject custom controls (e.g. search buttons) into stack headers.
+     *
+     * Optionally return a cleanup function that will be called when the stack is destroyed.
+     *
+     * Custom controls are not serialized into snapshots since callbacks are not
+     * serializable. The callback is re-invoked when layouts are restored.
+     *
+     * **NOTE**: This feature is currently only supported in OpenFin Runtime environments.
+     *
+     * @param controlsElement The `.lm_controls` DOM element for the stack header.
+     * @param context Context object providing an async {@link HeaderControlsContext.getStack | getStack()} to
+     * retrieve the {@link TabStack} instance.
+     * @returns A callback to be called when the rendered element needs to be cleaned up.
+     *
+     * @experimental
+     */
+    renderCustomHeaderControls?: (controlsElement: HTMLElement, context: HeaderControlsContext) => (() => void) | void;
 };
 
 /**
@@ -6256,6 +6277,13 @@ declare type GpuInfo = {
     name: string;
 };
 
+/**
+ * @interface @experimental
+ */
+declare type HeaderControlsContext = {
+    getStack: () => Promise<TabStack>;
+};
+
 /**
  * Generated when a View is hidden.
  *
@@ -10445,6 +10473,7 @@ declare namespace OpenFin_2 {
         LayoutManagerConstructor,
         LayoutManagerOverride,
         LayoutManager,
+        HeaderControlsContext,
         CreateLayoutOptions,
         MultiInstanceViewBehavior,
         PresetLayoutOptions_2 as PresetLayoutOptions,

package/out/mock-beta.d.ts

@@ -4434,6 +4434,27 @@ declare type CreateLayoutOptions = {
      * @default 'default'
      */
     multiInstanceViewBehavior?: MultiInstanceViewBehavior;
+    /**
+     * Callback invoked for each stack when its header controls area is rendered.
+     * The callback receives the `.lm_controls` DOM element and a context object
+     * with a {@link HeaderControlsContext.getStack | getStack()} async getter.
+     * Use this to inject custom controls (e.g. search buttons) into stack headers.
+     *
+     * Optionally return a cleanup function that will be called when the stack is destroyed.
+     *
+     * Custom controls are not serialized into snapshots since callbacks are not
+     * serializable. The callback is re-invoked when layouts are restored.
+     *
+     * **NOTE**: This feature is currently only supported in OpenFin Runtime environments.
+     *
+     * @param controlsElement The `.lm_controls` DOM element for the stack header.
+     * @param context Context object providing an async {@link HeaderControlsContext.getStack | getStack()} to
+     * retrieve the {@link TabStack} instance.
+     * @returns A callback to be called when the rendered element needs to be cleaned up.
+     *
+     * @experimental
+     */
+    renderCustomHeaderControls?: (controlsElement: HTMLElement, context: HeaderControlsContext) => (() => void) | void;
 };
 
 /**
@@ -6256,6 +6277,13 @@ declare type GpuInfo = {
     name: string;
 };
 
+/**
+ * @interface @experimental
+ */
+declare type HeaderControlsContext = {
+    getStack: () => Promise<TabStack>;
+};
+
 /**
  * Generated when a View is hidden.
  *
@@ -10445,6 +10473,7 @@ declare namespace OpenFin_2 {
         LayoutManagerConstructor,
         LayoutManagerOverride,
         LayoutManager,
+        HeaderControlsContext,
         CreateLayoutOptions,
         MultiInstanceViewBehavior,
         PresetLayoutOptions_2 as PresetLayoutOptions,

package/out/mock-public.d.ts

@@ -4434,6 +4434,27 @@ declare type CreateLayoutOptions = {
      * @default 'default'
      */
     multiInstanceViewBehavior?: MultiInstanceViewBehavior;
+    /**
+     * Callback invoked for each stack when its header controls area is rendered.
+     * The callback receives the `.lm_controls` DOM element and a context object
+     * with a {@link HeaderControlsContext.getStack | getStack()} async getter.
+     * Use this to inject custom controls (e.g. search buttons) into stack headers.
+     *
+     * Optionally return a cleanup function that will be called when the stack is destroyed.
+     *
+     * Custom controls are not serialized into snapshots since callbacks are not
+     * serializable. The callback is re-invoked when layouts are restored.
+     *
+     * **NOTE**: This feature is currently only supported in OpenFin Runtime environments.
+     *
+     * @param controlsElement The `.lm_controls` DOM element for the stack header.
+     * @param context Context object providing an async {@link HeaderControlsContext.getStack | getStack()} to
+     * retrieve the {@link TabStack} instance.
+     * @returns A callback to be called when the rendered element needs to be cleaned up.
+     *
+     * @experimental
+     */
+    renderCustomHeaderControls?: (controlsElement: HTMLElement, context: HeaderControlsContext) => (() => void) | void;
 };
 
 /**
@@ -6256,6 +6277,13 @@ declare type GpuInfo = {
     name: string;
 };
 
+/**
+ * @interface @experimental
+ */
+declare type HeaderControlsContext = {
+    getStack: () => Promise<TabStack>;
+};
+
 /**
  * Generated when a View is hidden.
  *
@@ -10445,6 +10473,7 @@ declare namespace OpenFin_2 {
         LayoutManagerConstructor,
         LayoutManagerOverride,
         LayoutManager,
+        HeaderControlsContext,
         CreateLayoutOptions,
         MultiInstanceViewBehavior,
         PresetLayoutOptions_2 as PresetLayoutOptions,

package/out/stub.d.ts

@@ -4493,6 +4493,27 @@ declare type CreateLayoutOptions = {
      * @default 'default'
      */
     multiInstanceViewBehavior?: MultiInstanceViewBehavior;
+    /**
+     * Callback invoked for each stack when its header controls area is rendered.
+     * The callback receives the `.lm_controls` DOM element and a context object
+     * with a {@link HeaderControlsContext.getStack | getStack()} async getter.
+     * Use this to inject custom controls (e.g. search buttons) into stack headers.
+     *
+     * Optionally return a cleanup function that will be called when the stack is destroyed.
+     *
+     * Custom controls are not serialized into snapshots since callbacks are not
+     * serializable. The callback is re-invoked when layouts are restored.
+     *
+     * **NOTE**: This feature is currently only supported in OpenFin Runtime environments.
+     *
+     * @param controlsElement The `.lm_controls` DOM element for the stack header.
+     * @param context Context object providing an async {@link HeaderControlsContext.getStack | getStack()} to
+     * retrieve the {@link TabStack} instance.
+     * @returns A callback to be called when the rendered element needs to be cleaned up.
+     *
+     * @experimental
+     */
+    renderCustomHeaderControls?: (controlsElement: HTMLElement, context: HeaderControlsContext) => (() => void) | void;
 };
 
 /**
@@ -6347,6 +6368,13 @@ declare type GpuInfo = {
     name: string;
 };
 
+/**
+ * @interface @experimental
+ */
+declare type HeaderControlsContext = {
+    getStack: () => Promise<TabStack>;
+};
+
 /**
  * Generated when a View is hidden.
  *
@@ -10779,6 +10807,7 @@ declare namespace OpenFin_2 {
         LayoutManagerConstructor,
         LayoutManagerOverride,
         LayoutManager,
+        HeaderControlsContext,
         CreateLayoutOptions,
         MultiInstanceViewBehavior,
         PresetLayoutOptions_2 as PresetLayoutOptions,

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/core",
-    "version": "45.100.29",
+    "version": "45.100.32",
     "description": "The core renderer entry point of OpenFin",
     "license": "SEE LICENSE IN LICENSE.md",
     "main": "out/stub.js",