@openfin/core-web 0.45.109 → 0.45.111

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.
@@ -1 +1 @@
1
- "use strict";var e=require("./main-eaeb5d4c.js");require("uuid"),require("events"),require("es-toolkit"),exports.connect=e.connect;
1
+ "use strict";var e=require("./main-76fc6c63.js");require("uuid"),require("events"),require("es-toolkit"),exports.connect=e.connect;
@@ -64,7 +64,7 @@ export declare interface CustomLogger {
64
64
  error: (message: string) => void;
65
65
  }
66
66
 
67
- declare type GL2Types = OpenFin.LayoutEntityTypes | 'component' | 'root' | 'ground';
67
+ declare type GLWebTypes = OpenFin.LayoutEntityTypes | 'component' | 'root' | 'ground';
68
68
 
69
69
  export declare type InheritModeConnectConfig = BaseConfig & {
70
70
  /**
@@ -122,18 +122,16 @@ declare type WebLayoutColumn = WebLayoutItemConfig & {
122
122
  /**
123
123
  * Web-only component supplied to IframeViewComponent as its config.
124
124
  * Extends {@link OpenFin.LayoutComponent} with a `web` field carrying the iframe frame name
125
- * and a per-view `icon` for tab hat favicon overrides.
125
+ * and a per-view `icon` (same contract as {@link OpenFin.ViewOptions.icon} once `@openfin/core` types include it).
126
126
  */
127
127
  export declare type WebLayoutComponent = Omit<OpenFin.LayoutComponent, 'componentState'> & {
128
128
  componentState?: OpenFin.LayoutComponent['componentState'] & {
129
129
  web?: WebState;
130
130
  /**
131
- * Optional URL of an icon to display in this component's tab hat.
132
- * Overrides the layout-level {@link WebLayoutSettings.defaultFaviconUrl} for this view only.
133
- * When {@link WebLayoutSettings.showFavicons} is enabled, this URL is used as the
134
- * fallback when no page favicon has been detected yet.
131
+ * Per-view tab icon. URL, `'hide'`, or `'unset'`.
132
+ * Exception to layout-level {@link WebLayoutSettings.showFavicons} / {@link WebLayoutSettings.defaultFaviconUrl}.
135
133
  */
136
- icon?: string;
134
+ icon?: string | 'hide' | 'unset';
137
135
  };
138
136
  };
139
137
 
@@ -155,14 +153,14 @@ export declare type WebLayoutInitOptions = Omit<OpenFin.InitLayoutOptions, 'layo
155
153
 
156
154
  declare type WebLayoutItemConfig = Omit<OpenFin.LayoutItemConfig, 'content' | 'type'> & {
157
155
  content?: WebLayoutContent;
158
- type: GL2Types;
156
+ type: GLWebTypes;
159
157
  };
160
158
 
161
159
  export declare type WebLayoutManager = OpenFin.LayoutManager<WebLayoutSnapshot>;
162
160
 
163
161
  /**
164
162
  * Web-specific extension of {@link OpenFin.LayoutOptions}.
165
- * Narrows `content` to use {@link GL2Types} for stricter item-type checking on the web path,
163
+ * Narrows `content` to use {@link GLWebTypes} for stricter item-type checking on the web path,
166
164
  * and extends `settings` with web-only favicon options via {@link WebLayoutSettings}.
167
165
  */
168
166
  export declare type WebLayoutOptions = Omit<OpenFin.LayoutOptions, 'content' | 'settings'> & {
@@ -197,8 +195,8 @@ export declare type WebLayoutSettings = OpenFin.LayoutOptions['settings'] & {
197
195
  *
198
196
  * - Omitted or `true`: favicon is read from iframe content when available,
199
197
  * falling back to `defaultFaviconUrl` (or no icon if unset).
200
- * - `false`: content detection is disabled; only `defaultFaviconUrl` (or a
201
- * per-view `icon` override) is ever shown.
198
+ * - `false`: content detection is disabled; only a per-view `icon` URL override is shown
199
+ * (`icon: 'hide'` still hides). Layout-level `defaultFaviconUrl` is not used.
202
200
  *
203
201
  * @remarks Cross-origin pages without the OpenFin connect script cannot be
204
202
  * detected and will always fall back to `defaultFaviconUrl` (or no icon if unset).
@@ -1 +1 @@
1
- export{j as connect}from"./main-8271fc3c.js";import"uuid";import"events";import"es-toolkit";
1
+ export{j as connect}from"./main-eb197be2.js";import"uuid";import"events";import"es-toolkit";
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WebLayoutComponent | @openfin/core-web</title><meta name="description" content="Documentation for @openfin/core-web"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@openfin/core-web</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@openfin/core-web</a></li><li><a href="../modules/_openfin_core_web.html">@openfin/core-web</a></li><li><a href="_openfin_core_web.WebLayoutComponent.html">WebLayoutComponent</a></li></ul><h1>Type Alias WebLayoutComponent</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Web<wbr/>Layout<wbr/>Component</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">OpenFin.LayoutComponent</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;componentState&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">componentState</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">OpenFin.LayoutComponent</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;componentState&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span><br/><span>        </span><span class="tsd-kind-property">icon</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>        </span><span class="tsd-kind-property">web</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">WebState</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Web-only component supplied to IframeViewComponent as its config.
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WebLayoutComponent | @openfin/core-web</title><meta name="description" content="Documentation for @openfin/core-web"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@openfin/core-web</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@openfin/core-web</a></li><li><a href="../modules/_openfin_core_web.html">@openfin/core-web</a></li><li><a href="_openfin_core_web.WebLayoutComponent.html">WebLayoutComponent</a></li></ul><h1>Type Alias WebLayoutComponent</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Web<wbr/>Layout<wbr/>Component</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">OpenFin.LayoutComponent</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;componentState&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">componentState</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">OpenFin.LayoutComponent</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;componentState&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span><br/><span>        </span><span class="tsd-kind-property">icon</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;hide&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;unset&quot;</span><span class="tsd-signature-symbol">; </span><br/><span>        </span><span class="tsd-kind-property">web</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">WebState</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Web-only component supplied to IframeViewComponent as its config.
2
2
  Extends OpenFin.LayoutComponent with a <code>web</code> field carrying the iframe frame name
3
- and a per-view <code>icon</code> for tab hat favicon overrides.</p>
3
+ and a per-view <code>icon</code> (same contract as OpenFin.ViewOptions.icon once <code>@openfin/core</code> types include it).</p>
4
4
  </div><div class="tsd-comment tsd-typography"></div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@openfin/core-web</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
@@ -1,4 +1,4 @@
1
1
  <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WebLayoutOptions | @openfin/core-web</title><meta name="description" content="Documentation for @openfin/core-web"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@openfin/core-web</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@openfin/core-web</a></li><li><a href="../modules/_openfin_core_web.html">@openfin/core-web</a></li><li><a href="_openfin_core_web.WebLayoutOptions.html">WebLayoutOptions</a></li></ul><h1>Type Alias WebLayoutOptions</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Web<wbr/>Layout<wbr/>Options</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">OpenFin.LayoutOptions</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;content&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;settings&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">content</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">WebLayoutContent</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">settings</span><span class="tsd-signature-symbol">?: </span><a href="_openfin_core_web.WebLayoutSettings.html" class="tsd-signature-type tsd-kind-type-alias">WebLayoutSettings</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Web-specific extension of OpenFin.LayoutOptions.
2
- Narrows <code>content</code> to use GL2Types for stricter item-type checking on the web path,
2
+ Narrows <code>content</code> to use GLWebTypes for stricter item-type checking on the web path,
3
3
  and extends <code>settings</code> with web-only favicon options via <a href="_openfin_core_web.WebLayoutSettings.html" class="tsd-kind-type-alias">WebLayoutSettings</a>.</p>
4
4
  </div><div class="tsd-comment tsd-typography"></div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@openfin/core-web</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
@@ -9,8 +9,8 @@ A broken URL produces a transparent placeholder with no layout shift.</p>
9
9
  <ul>
10
10
  <li>Omitted or <code>true</code>: favicon is read from iframe content when available,
11
11
  falling back to <code>defaultFaviconUrl</code> (or no icon if unset).</li>
12
- <li><code>false</code>: content detection is disabled; only <code>defaultFaviconUrl</code> (or a
13
- per-view <code>icon</code> override) is ever shown.</li>
12
+ <li><code>false</code>: content detection is disabled; only a per-view <code>icon</code> URL override is shown
13
+ (<code>icon: 'hide'</code> still hides). Layout-level <code>defaultFaviconUrl</code> is not used.</li>
14
14
  </ul>
15
15
  </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-Remarks"><h4 class="tsd-anchor-link"><a id="Remarks" class="tsd-anchor"></a>Remarks<a href="#Remarks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Cross-origin pages without the OpenFin connect script cannot be
16
16
  detected and will always fall back to <code>defaultFaviconUrl</code> (or no icon if unset).</p>