@openfin/fdc3-api 45.100.29 → 45.100.30

package/out/fdc3-api-alpha.d.ts

@@ -4431,6 +4431,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;
 };
 
 /**
@@ -6598,6 +6619,13 @@ declare type GpuInfo = {
     name: string;
 };
 
+/**
+ * @interface @experimental
+ */
+declare type HeaderControlsContext = {
+    getStack: () => Promise<TabStack>;
+};
+
 /**
  * Generated when a View is hidden.
  *
@@ -10787,6 +10815,7 @@ declare namespace OpenFin {
         LayoutManagerConstructor,
         LayoutManagerOverride,
         LayoutManager,
+        HeaderControlsContext,
         CreateLayoutOptions,
         MultiInstanceViewBehavior,
         PresetLayoutOptions_2 as PresetLayoutOptions,

package/out/fdc3-api-beta.d.ts

@@ -4431,6 +4431,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;
 };
 
 /**
@@ -6598,6 +6619,13 @@ declare type GpuInfo = {
     name: string;
 };
 
+/**
+ * @interface @experimental
+ */
+declare type HeaderControlsContext = {
+    getStack: () => Promise<TabStack>;
+};
+
 /**
  * Generated when a View is hidden.
  *
@@ -10787,6 +10815,7 @@ declare namespace OpenFin {
         LayoutManagerConstructor,
         LayoutManagerOverride,
         LayoutManager,
+        HeaderControlsContext,
         CreateLayoutOptions,
         MultiInstanceViewBehavior,
         PresetLayoutOptions_2 as PresetLayoutOptions,

package/out/fdc3-api-public.d.ts

@@ -4431,6 +4431,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;
 };
 
 /**
@@ -6598,6 +6619,13 @@ declare type GpuInfo = {
     name: string;
 };
 
+/**
+ * @interface @experimental
+ */
+declare type HeaderControlsContext = {
+    getStack: () => Promise<TabStack>;
+};
+
 /**
  * Generated when a View is hidden.
  *
@@ -10787,6 +10815,7 @@ declare namespace OpenFin {
         LayoutManagerConstructor,
         LayoutManagerOverride,
         LayoutManager,
+        HeaderControlsContext,
         CreateLayoutOptions,
         MultiInstanceViewBehavior,
         PresetLayoutOptions_2 as PresetLayoutOptions,

package/out/fdc3-api.d.ts

@@ -4490,6 +4490,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;
 };
 
 /**
@@ -6689,6 +6710,13 @@ declare type GpuInfo = {
     name: string;
 };
 
+/**
+ * @interface @experimental
+ */
+declare type HeaderControlsContext = {
+    getStack: () => Promise<TabStack>;
+};
+
 /**
  * Generated when a View is hidden.
  *
@@ -11121,6 +11149,7 @@ declare namespace OpenFin {
         LayoutManagerConstructor,
         LayoutManagerOverride,
         LayoutManager,
+        HeaderControlsContext,
         CreateLayoutOptions,
         MultiInstanceViewBehavior,
         PresetLayoutOptions_2 as PresetLayoutOptions,

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/fdc3-api",
-    "version": "45.100.29",
+    "version": "45.100.30",
     "description": "OpenFin fdc3 module utilities and types.",
     "license": "SEE LICENSE IN LICENSE.md",
     "private": false,