@openfin/fdc3-api 46.100.71 → 46.100.73

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -9630,8 +9630,26 @@ declare type LayoutOptions = {
9630
9630
  content?: LayoutContent;
9631
9631
  dimensions?: {
9632
9632
  borderWidth?: number;
9633
+ /**
9634
+ * Minimum height a layout item can be resized to, in pixels.
9635
+ * On web layouts this is mapped to Golden Layout 2 `defaultMinItemHeight`.
9636
+ */
9633
9637
  minItemHeight?: number;
9638
+ /**
9639
+ * Minimum width a layout item can be resized to, in pixels.
9640
+ * On web layouts this is mapped to Golden Layout 2 `defaultMinItemWidth`.
9641
+ */
9634
9642
  minItemWidth?: number;
9643
+ /**
9644
+ * Minimum height a layout item can be resized to (CSS size, e.g. `'500px'`).
9645
+ * Web layouts only. Takes precedence over {@link LayoutOptions.dimensions.minItemHeight} when both are set.
9646
+ */
9647
+ defaultMinItemHeight?: string;
9648
+ /**
9649
+ * Minimum width a layout item can be resized to (CSS size, e.g. `'500px'`).
9650
+ * Web layouts only. Takes precedence over {@link LayoutOptions.dimensions.minItemWidth} when both are set.
9651
+ */
9652
+ defaultMinItemWidth?: string;
9635
9653
  headerHeight?: number;
9636
9654
  };
9637
9655
  };
@@ -10295,6 +10313,18 @@ declare type MutableViewOptions = {
10295
10313
  interop?: InteropConfig;
10296
10314
  /* Excluded from this release type: _internalWorkspaceData */
10297
10315
  /* Excluded from this release type: workspacePlatform */
10316
+ /**
10317
+ * Per-view tab icon. Exception to `showFavicons` / `defaultFaviconUrl`.
10318
+ *
10319
+ * Distinct from Window `icon` (taskbar).
10320
+ *
10321
+ * - Omitted / `''` / `'unset'`: inherit — if `showFavicons`, page favicon then `defaultFaviconUrl`, else hide
10322
+ * - URL string: always show that URL, even when `showFavicons` is false. Load failure uses `defaultFaviconUrl`
10323
+ * - `'hide'`: always hide, even when `showFavicons` is true
10324
+ *
10325
+ * On `updateOptions`, omitted keys are a no-op; set `'unset'` to return to inherit.
10326
+ */
10327
+ icon?: ViewTabIcon;
10298
10328
  /**
10299
10329
  * {@inheritDoc ViewThrottling}
10300
10330
  *
@@ -11038,6 +11068,7 @@ declare namespace OpenFin {
11038
11068
  ViewInfo,
11039
11069
  WindowThrottling,
11040
11070
  ViewThrottling,
11071
+ ViewTabIcon,
11041
11072
  UpdatableViewOptions,
11042
11073
  ViewCreationOptions,
11043
11074
  MutableViewOptions,
@@ -19152,6 +19183,13 @@ declare type ViewTabAccessibilityOptions = {
19152
19183
  */
19153
19184
  declare type ViewTabElements = 'active-tab' | 'inactive-tab' | 'active-tab-close-button' | 'inactive-tab-close-button' | 'add-tab-button' | 'active-tab-custom-control' | 'inactive-tab-custom-control';
19154
19185
 
19186
+ /**
19187
+ * Per-view tab icon. A URL, or the reserved sentinels `'hide'` / `'unset'`.
19188
+ *
19189
+ * `'hide'` and `'unset'` are not URLs. `''` is also unset (inherit) and is the default.
19190
+ */
19191
+ declare type ViewTabIcon = string | 'hide' | 'unset';
19192
+
19155
19193
  /**
19156
19194
  * View throttling state.
19157
19195
  *
@@ -9630,8 +9630,26 @@ declare type LayoutOptions = {
9630
9630
  content?: LayoutContent;
9631
9631
  dimensions?: {
9632
9632
  borderWidth?: number;
9633
+ /**
9634
+ * Minimum height a layout item can be resized to, in pixels.
9635
+ * On web layouts this is mapped to Golden Layout 2 `defaultMinItemHeight`.
9636
+ */
9633
9637
  minItemHeight?: number;
9638
+ /**
9639
+ * Minimum width a layout item can be resized to, in pixels.
9640
+ * On web layouts this is mapped to Golden Layout 2 `defaultMinItemWidth`.
9641
+ */
9634
9642
  minItemWidth?: number;
9643
+ /**
9644
+ * Minimum height a layout item can be resized to (CSS size, e.g. `'500px'`).
9645
+ * Web layouts only. Takes precedence over {@link LayoutOptions.dimensions.minItemHeight} when both are set.
9646
+ */
9647
+ defaultMinItemHeight?: string;
9648
+ /**
9649
+ * Minimum width a layout item can be resized to (CSS size, e.g. `'500px'`).
9650
+ * Web layouts only. Takes precedence over {@link LayoutOptions.dimensions.minItemWidth} when both are set.
9651
+ */
9652
+ defaultMinItemWidth?: string;
9635
9653
  headerHeight?: number;
9636
9654
  };
9637
9655
  };
@@ -10295,6 +10313,18 @@ declare type MutableViewOptions = {
10295
10313
  interop?: InteropConfig;
10296
10314
  /* Excluded from this release type: _internalWorkspaceData */
10297
10315
  /* Excluded from this release type: workspacePlatform */
10316
+ /**
10317
+ * Per-view tab icon. Exception to `showFavicons` / `defaultFaviconUrl`.
10318
+ *
10319
+ * Distinct from Window `icon` (taskbar).
10320
+ *
10321
+ * - Omitted / `''` / `'unset'`: inherit — if `showFavicons`, page favicon then `defaultFaviconUrl`, else hide
10322
+ * - URL string: always show that URL, even when `showFavicons` is false. Load failure uses `defaultFaviconUrl`
10323
+ * - `'hide'`: always hide, even when `showFavicons` is true
10324
+ *
10325
+ * On `updateOptions`, omitted keys are a no-op; set `'unset'` to return to inherit.
10326
+ */
10327
+ icon?: ViewTabIcon;
10298
10328
  /**
10299
10329
  * {@inheritDoc ViewThrottling}
10300
10330
  *
@@ -11038,6 +11068,7 @@ declare namespace OpenFin {
11038
11068
  ViewInfo,
11039
11069
  WindowThrottling,
11040
11070
  ViewThrottling,
11071
+ ViewTabIcon,
11041
11072
  UpdatableViewOptions,
11042
11073
  ViewCreationOptions,
11043
11074
  MutableViewOptions,
@@ -19152,6 +19183,13 @@ declare type ViewTabAccessibilityOptions = {
19152
19183
  */
19153
19184
  declare type ViewTabElements = 'active-tab' | 'inactive-tab' | 'active-tab-close-button' | 'inactive-tab-close-button' | 'add-tab-button' | 'active-tab-custom-control' | 'inactive-tab-custom-control';
19154
19185
 
19186
+ /**
19187
+ * Per-view tab icon. A URL, or the reserved sentinels `'hide'` / `'unset'`.
19188
+ *
19189
+ * `'hide'` and `'unset'` are not URLs. `''` is also unset (inherit) and is the default.
19190
+ */
19191
+ declare type ViewTabIcon = string | 'hide' | 'unset';
19192
+
19155
19193
  /**
19156
19194
  * View throttling state.
19157
19195
  *
@@ -9630,8 +9630,26 @@ declare type LayoutOptions = {
9630
9630
  content?: LayoutContent;
9631
9631
  dimensions?: {
9632
9632
  borderWidth?: number;
9633
+ /**
9634
+ * Minimum height a layout item can be resized to, in pixels.
9635
+ * On web layouts this is mapped to Golden Layout 2 `defaultMinItemHeight`.
9636
+ */
9633
9637
  minItemHeight?: number;
9638
+ /**
9639
+ * Minimum width a layout item can be resized to, in pixels.
9640
+ * On web layouts this is mapped to Golden Layout 2 `defaultMinItemWidth`.
9641
+ */
9634
9642
  minItemWidth?: number;
9643
+ /**
9644
+ * Minimum height a layout item can be resized to (CSS size, e.g. `'500px'`).
9645
+ * Web layouts only. Takes precedence over {@link LayoutOptions.dimensions.minItemHeight} when both are set.
9646
+ */
9647
+ defaultMinItemHeight?: string;
9648
+ /**
9649
+ * Minimum width a layout item can be resized to (CSS size, e.g. `'500px'`).
9650
+ * Web layouts only. Takes precedence over {@link LayoutOptions.dimensions.minItemWidth} when both are set.
9651
+ */
9652
+ defaultMinItemWidth?: string;
9635
9653
  headerHeight?: number;
9636
9654
  };
9637
9655
  };
@@ -10295,6 +10313,18 @@ declare type MutableViewOptions = {
10295
10313
  interop?: InteropConfig;
10296
10314
  /* Excluded from this release type: _internalWorkspaceData */
10297
10315
  /* Excluded from this release type: workspacePlatform */
10316
+ /**
10317
+ * Per-view tab icon. Exception to `showFavicons` / `defaultFaviconUrl`.
10318
+ *
10319
+ * Distinct from Window `icon` (taskbar).
10320
+ *
10321
+ * - Omitted / `''` / `'unset'`: inherit — if `showFavicons`, page favicon then `defaultFaviconUrl`, else hide
10322
+ * - URL string: always show that URL, even when `showFavicons` is false. Load failure uses `defaultFaviconUrl`
10323
+ * - `'hide'`: always hide, even when `showFavicons` is true
10324
+ *
10325
+ * On `updateOptions`, omitted keys are a no-op; set `'unset'` to return to inherit.
10326
+ */
10327
+ icon?: ViewTabIcon;
10298
10328
  /**
10299
10329
  * {@inheritDoc ViewThrottling}
10300
10330
  *
@@ -11038,6 +11068,7 @@ declare namespace OpenFin {
11038
11068
  ViewInfo,
11039
11069
  WindowThrottling,
11040
11070
  ViewThrottling,
11071
+ ViewTabIcon,
11041
11072
  UpdatableViewOptions,
11042
11073
  ViewCreationOptions,
11043
11074
  MutableViewOptions,
@@ -19152,6 +19183,13 @@ declare type ViewTabAccessibilityOptions = {
19152
19183
  */
19153
19184
  declare type ViewTabElements = 'active-tab' | 'inactive-tab' | 'active-tab-close-button' | 'inactive-tab-close-button' | 'add-tab-button' | 'active-tab-custom-control' | 'inactive-tab-custom-control';
19154
19185
 
19186
+ /**
19187
+ * Per-view tab icon. A URL, or the reserved sentinels `'hide'` / `'unset'`.
19188
+ *
19189
+ * `'hide'` and `'unset'` are not URLs. `''` is also unset (inherit) and is the default.
19190
+ */
19191
+ declare type ViewTabIcon = string | 'hide' | 'unset';
19192
+
19155
19193
  /**
19156
19194
  * View throttling state.
19157
19195
  *
package/out/fdc3-api.d.ts CHANGED
@@ -9992,8 +9992,26 @@ declare type LayoutOptions = {
9992
9992
  content?: LayoutContent;
9993
9993
  dimensions?: {
9994
9994
  borderWidth?: number;
9995
+ /**
9996
+ * Minimum height a layout item can be resized to, in pixels.
9997
+ * On web layouts this is mapped to Golden Layout 2 `defaultMinItemHeight`.
9998
+ */
9995
9999
  minItemHeight?: number;
10000
+ /**
10001
+ * Minimum width a layout item can be resized to, in pixels.
10002
+ * On web layouts this is mapped to Golden Layout 2 `defaultMinItemWidth`.
10003
+ */
9996
10004
  minItemWidth?: number;
10005
+ /**
10006
+ * Minimum height a layout item can be resized to (CSS size, e.g. `'500px'`).
10007
+ * Web layouts only. Takes precedence over {@link LayoutOptions.dimensions.minItemHeight} when both are set.
10008
+ */
10009
+ defaultMinItemHeight?: string;
10010
+ /**
10011
+ * Minimum width a layout item can be resized to (CSS size, e.g. `'500px'`).
10012
+ * Web layouts only. Takes precedence over {@link LayoutOptions.dimensions.minItemWidth} when both are set.
10013
+ */
10014
+ defaultMinItemWidth?: string;
9997
10015
  headerHeight?: number;
9998
10016
  };
9999
10017
  };
@@ -10666,6 +10684,18 @@ declare type MutableViewOptions = {
10666
10684
  * Persisted on create, {@link View.View#updateOptions updateOptions}, snapshot, and {@link View.View#getOptions getOptions} — the same way windows persist `workspacePlatform`.
10667
10685
  */
10668
10686
  workspacePlatform?: WorkspacePlatformOptions;
10687
+ /**
10688
+ * Per-view tab icon. Exception to `showFavicons` / `defaultFaviconUrl`.
10689
+ *
10690
+ * Distinct from Window `icon` (taskbar).
10691
+ *
10692
+ * - Omitted / `''` / `'unset'`: inherit — if `showFavicons`, page favicon then `defaultFaviconUrl`, else hide
10693
+ * - URL string: always show that URL, even when `showFavicons` is false. Load failure uses `defaultFaviconUrl`
10694
+ * - `'hide'`: always hide, even when `showFavicons` is true
10695
+ *
10696
+ * On `updateOptions`, omitted keys are a no-op; set `'unset'` to return to inherit.
10697
+ */
10698
+ icon?: ViewTabIcon;
10669
10699
  /**
10670
10700
  * {@inheritDoc ViewThrottling}
10671
10701
  *
@@ -11430,6 +11460,7 @@ declare namespace OpenFin {
11430
11460
  ViewInfo,
11431
11461
  WindowThrottling,
11432
11462
  ViewThrottling,
11463
+ ViewTabIcon,
11433
11464
  UpdatableViewOptions,
11434
11465
  ViewCreationOptions,
11435
11466
  MutableViewOptions,
@@ -19677,6 +19708,13 @@ declare type ViewTabAccessibilityOptions = {
19677
19708
  */
19678
19709
  declare type ViewTabElements = 'active-tab' | 'inactive-tab' | 'active-tab-close-button' | 'inactive-tab-close-button' | 'add-tab-button' | 'active-tab-custom-control' | 'inactive-tab-custom-control';
19679
19710
 
19711
+ /**
19712
+ * Per-view tab icon. A URL, or the reserved sentinels `'hide'` / `'unset'`.
19713
+ *
19714
+ * `'hide'` and `'unset'` are not URLs. `''` is also unset (inherit) and is the default.
19715
+ */
19716
+ declare type ViewTabIcon = string | 'hide' | 'unset';
19717
+
19680
19718
  /**
19681
19719
  * View throttling state.
19682
19720
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/fdc3-api",
3
- "version": "46.100.71",
3
+ "version": "46.100.73",
4
4
  "description": "OpenFin fdc3 module utilities and types.",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "private": false,