@openfin/fdc3-api 43.100.106 → 43.100.109

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

@@ -6624,7 +6624,28 @@ declare type Hotkey = {
      */
     keys: string;
     /**
-     * Prevent default key handling before emitting the event.
+     * Controls the event phase at which the hotkey is triggered.
+     *
+     * - `'capture'`: The hotkey fires **before** the event is sent to the renderer/page.
+     * This is the only phase where the `preventDefault` property is effective.
+     *
+     * - `'bubble'`: The hotkey fires **after** the page has processed the key event.
+     * This behaves exactly like a standard JavaScript event listener attached to the window:
+     * 1. If the page calls `event.preventDefault()` (on either **keydown** or **keyup**), this hotkey will **not** fire.
+     * 2. If the hotkey is browser-reserved (e.g. `Ctrl+Tab` to switch tabs for which keyup/keydown do not fire in a web browser), that action takes precedence and this hotkey will **not** fire.
+     *
+     * @default 'capture'
+     */
+    phase?: 'capture' | 'bubble';
+    /**
+     * Determines if the event should continue to the renderer.
+     *
+     * - `true`: The event is consumed immediately. It will **never** reach the renderer/page.
+     * - `false`: The event is sent to the renderer after this hotkey executes.
+     *
+     * @remarks
+     * This property is **only valid** when `phase` is set to `'capture'`.
+     * If `phase` is `'bubble'`, this property is ignored (as the renderer has already received and processed the event).
      *
      * @default false
      */

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

@@ -6624,7 +6624,28 @@ declare type Hotkey = {
      */
     keys: string;
     /**
-     * Prevent default key handling before emitting the event.
+     * Controls the event phase at which the hotkey is triggered.
+     *
+     * - `'capture'`: The hotkey fires **before** the event is sent to the renderer/page.
+     * This is the only phase where the `preventDefault` property is effective.
+     *
+     * - `'bubble'`: The hotkey fires **after** the page has processed the key event.
+     * This behaves exactly like a standard JavaScript event listener attached to the window:
+     * 1. If the page calls `event.preventDefault()` (on either **keydown** or **keyup**), this hotkey will **not** fire.
+     * 2. If the hotkey is browser-reserved (e.g. `Ctrl+Tab` to switch tabs for which keyup/keydown do not fire in a web browser), that action takes precedence and this hotkey will **not** fire.
+     *
+     * @default 'capture'
+     */
+    phase?: 'capture' | 'bubble';
+    /**
+     * Determines if the event should continue to the renderer.
+     *
+     * - `true`: The event is consumed immediately. It will **never** reach the renderer/page.
+     * - `false`: The event is sent to the renderer after this hotkey executes.
+     *
+     * @remarks
+     * This property is **only valid** when `phase` is set to `'capture'`.
+     * If `phase` is `'bubble'`, this property is ignored (as the renderer has already received and processed the event).
      *
      * @default false
      */

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

@@ -6624,7 +6624,28 @@ declare type Hotkey = {
      */
     keys: string;
     /**
-     * Prevent default key handling before emitting the event.
+     * Controls the event phase at which the hotkey is triggered.
+     *
+     * - `'capture'`: The hotkey fires **before** the event is sent to the renderer/page.
+     * This is the only phase where the `preventDefault` property is effective.
+     *
+     * - `'bubble'`: The hotkey fires **after** the page has processed the key event.
+     * This behaves exactly like a standard JavaScript event listener attached to the window:
+     * 1. If the page calls `event.preventDefault()` (on either **keydown** or **keyup**), this hotkey will **not** fire.
+     * 2. If the hotkey is browser-reserved (e.g. `Ctrl+Tab` to switch tabs for which keyup/keydown do not fire in a web browser), that action takes precedence and this hotkey will **not** fire.
+     *
+     * @default 'capture'
+     */
+    phase?: 'capture' | 'bubble';
+    /**
+     * Determines if the event should continue to the renderer.
+     *
+     * - `true`: The event is consumed immediately. It will **never** reach the renderer/page.
+     * - `false`: The event is sent to the renderer after this hotkey executes.
+     *
+     * @remarks
+     * This property is **only valid** when `phase` is set to `'capture'`.
+     * If `phase` is `'bubble'`, this property is ignored (as the renderer has already received and processed the event).
      *
      * @default false
      */

package/out/fdc3-api.d.ts

@@ -6715,7 +6715,28 @@ declare type Hotkey = {
      */
     keys: string;
     /**
-     * Prevent default key handling before emitting the event.
+     * Controls the event phase at which the hotkey is triggered.
+     *
+     * - `'capture'`: The hotkey fires **before** the event is sent to the renderer/page.
+     * This is the only phase where the `preventDefault` property is effective.
+     *
+     * - `'bubble'`: The hotkey fires **after** the page has processed the key event.
+     * This behaves exactly like a standard JavaScript event listener attached to the window:
+     * 1. If the page calls `event.preventDefault()` (on either **keydown** or **keyup**), this hotkey will **not** fire.
+     * 2. If the hotkey is browser-reserved (e.g. `Ctrl+Tab` to switch tabs for which keyup/keydown do not fire in a web browser), that action takes precedence and this hotkey will **not** fire.
+     *
+     * @default 'capture'
+     */
+    phase?: 'capture' | 'bubble';
+    /**
+     * Determines if the event should continue to the renderer.
+     *
+     * - `true`: The event is consumed immediately. It will **never** reach the renderer/page.
+     * - `false`: The event is sent to the renderer after this hotkey executes.
+     *
+     * @remarks
+     * This property is **only valid** when `phase` is set to `'capture'`.
+     * If `phase` is `'bubble'`, this property is ignored (as the renderer has already received and processed the event).
      *
      * @default false
      */

package/package.json

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