@openfin/core-web 0.45.69 → 0.45.70
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.
- package/out/api-client.cjs.js +1 -1
- package/out/api-client.d.ts +45 -2
- package/out/api-client.esm.js +1 -1
- package/out/docs/assets/navigation.js +1 -1
- package/out/docs/assets/search.js +1 -1
- package/out/docs/modules/_openfin_core_web.html +1 -0
- package/out/docs/types/_openfin_core_web.WebLayoutComponent.html +3 -1
- package/out/docs/types/_openfin_core_web.WebLayoutOptions.html +4 -1
- package/out/docs/types/_openfin_core_web.WebLayoutSettings.html +18 -0
- package/out/main-70314dee.js +3 -0
- package/out/main-841a9c82.js +3 -0
- package/out/main-8e5ba594.js +1 -0
- package/out/main-8f7b6de8.js +1 -0
- package/out/styles.css +8 -1
- package/package.json +2 -2
- package/out/main-64607de3.js +0 -1
- package/out/main-7a785515.js +0 -3
- package/out/main-8dcf9a45.js +0 -3
- package/out/main-d41c92b3.js +0 -1
package/out/api-client.cjs.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
"use strict";var e=require("./main-
|
|
1
|
+
"use strict";var e=require("./main-8f7b6de8.js");require("uuid"),require("events"),require("es-toolkit"),exports.connect=e.connect;
|
package/out/api-client.d.ts
CHANGED
|
@@ -120,11 +120,20 @@ declare type WebLayoutColumn = WebLayoutItemConfig & {
|
|
|
120
120
|
};
|
|
121
121
|
|
|
122
122
|
/**
|
|
123
|
-
* Web-only component supplied to IframeViewComponent as
|
|
123
|
+
* Web-only component supplied to IframeViewComponent as its config.
|
|
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.
|
|
124
126
|
*/
|
|
125
127
|
export declare type WebLayoutComponent = Omit<OpenFin.LayoutComponent, 'componentState'> & {
|
|
126
128
|
componentState?: OpenFin.LayoutComponent['componentState'] & {
|
|
127
129
|
web?: WebState;
|
|
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.
|
|
135
|
+
*/
|
|
136
|
+
icon?: string;
|
|
128
137
|
};
|
|
129
138
|
};
|
|
130
139
|
|
|
@@ -151,8 +160,14 @@ declare type WebLayoutItemConfig = Omit<OpenFin.LayoutItemConfig, 'content' | 't
|
|
|
151
160
|
|
|
152
161
|
export declare type WebLayoutManager = OpenFin.LayoutManager<WebLayoutSnapshot>;
|
|
153
162
|
|
|
154
|
-
|
|
163
|
+
/**
|
|
164
|
+
* Web-specific extension of {@link OpenFin.LayoutOptions}.
|
|
165
|
+
* Narrows `content` to use {@link GL2Types} for stricter item-type checking on the web path,
|
|
166
|
+
* and extends `settings` with web-only favicon options via {@link WebLayoutSettings}.
|
|
167
|
+
*/
|
|
168
|
+
export declare type WebLayoutOptions = Omit<OpenFin.LayoutOptions, 'content' | 'settings'> & {
|
|
155
169
|
content?: WebLayoutContent;
|
|
170
|
+
settings?: WebLayoutSettings;
|
|
156
171
|
};
|
|
157
172
|
|
|
158
173
|
export declare type WebLayoutPlatformOptions = {
|
|
@@ -164,6 +179,34 @@ declare type WebLayoutRow = WebLayoutItemConfig & {
|
|
|
164
179
|
type: 'row';
|
|
165
180
|
};
|
|
166
181
|
|
|
182
|
+
/**
|
|
183
|
+
* Web-only layout settings for favicon behaviour.
|
|
184
|
+
* These fields are not available on desktop layouts and live here rather than in
|
|
185
|
+
* {@link OpenFin.LayoutOptions} because favicon detection relies on iframe DOM events
|
|
186
|
+
* which only exist in the Core-Web path.
|
|
187
|
+
*/
|
|
188
|
+
export declare type WebLayoutSettings = OpenFin.LayoutOptions['settings'] & {
|
|
189
|
+
/**
|
|
190
|
+
* URL of the default icon shown in every view tab hat.
|
|
191
|
+
* A broken URL produces a transparent placeholder with no layout shift.
|
|
192
|
+
*/
|
|
193
|
+
defaultFaviconUrl?: string;
|
|
194
|
+
/**
|
|
195
|
+
* Controls whether the tab hat icon updates dynamically from the loaded page's
|
|
196
|
+
* `<link rel="icon">` element.
|
|
197
|
+
*
|
|
198
|
+
* - Omitted or `true`: favicon is read from iframe content when available,
|
|
199
|
+
* 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.
|
|
202
|
+
*
|
|
203
|
+
* @remarks Cross-origin pages without the OpenFin connect script cannot be
|
|
204
|
+
* detected and will always fall back to `defaultFaviconUrl` (or no icon if unset).
|
|
205
|
+
* @defaultValue `true`
|
|
206
|
+
*/
|
|
207
|
+
showFavicons?: boolean;
|
|
208
|
+
};
|
|
209
|
+
|
|
167
210
|
export declare type WebLayoutSnapshot = {
|
|
168
211
|
layouts: Record<string, WebLayoutOptions>;
|
|
169
212
|
};
|
package/out/api-client.esm.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export{
|
|
1
|
+
export{j as connect}from"./main-8e5ba594.js";import"uuid";import"events";import"es-toolkit";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA52VXU/bMBSG/0rl65ayMrquV4OiISQQk5DWC4QsJz5pDMk5luPQoYn/
|
|
1
|
+
window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA52VXU/bMBSG/0rl65ayMrquV4OiISQQk5DWC4QsJz5pDMk5luPQoYn/PoWkzUfTxUaVcnWe9/Gx3ePHv8zCH8uW7F4D/lQ4WkMwutA6UaGwinB0Ba+QkAYzus6VBDZmWtiYLZmkME8BbTatUL6GgDdQvkf5B3oS2zRhY/aiULLl4myxmJ8u3sf7FfxKhI3IpC7KXa2v4wdpwEjhNCQDky0EdXhKMk8gm/KqhBclfAtBO3M2ZmGsEmkA2fJxH7zKM0vpLW02YOpMhRZMJMLe2CbScZzPG2u+FBmsCCO1qYPtm+7NrGs7iaffv305nx2mIoTFWd3r4ps5C9rYkKsCXJtolQ9l32AMRtk7kuCpOUYOGR+sQHmREPoKj4BDvt8KtitKNSGgs6sHGvKsIVgZEBZuxRvl1vlK9HMOtrJ+v0onU4dxttyg8urogHI23QkUrSEwaKkIZ4N/H7497Marv6lDOhsfwFqFGx/VDnF3oNBZTD4XbYcMOcLyD10nRzl+TMi+9Kq4nTn/2ohTkREpTAJDL82bdPSJ4iXAS8DtwfKe/R2J9yugULltUEdUcP/ZKwPP5SitVpN9xnEQciB8aiizWBiQky0Zx+MpAV4CTscjIRJ50tivV2GUCFziK7StOZu9PxW/f+rAh/rxCQAA"
|
|
@@ -1 +1 @@
|
|
|
1
|
-
window.searchData = "data:application/octet-stream;base64,
|
|
1
|
+
window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA82bbW/bNhDHv0rBvlUV80Gy7FfbOmwo0GEDtrUvjMCQZTrVZkuGJCcrgnz3gRIl3YlUQjn21jd14PL+vDv+jg8S/UiK/KEky9Uj+TvNtmQZ8SgKZ5FHsvggyZL8to+rXV4c3vwo7+U+P8rizc+ndCuJR07FnizJNk9OB5lV5U3bdN01XddN/S/VYU88kuzjspQlWRLy5I319+tRZj+l2ZvPcvPm++NxnyZxleaZQ/facv1ZbtbAcpI3rPPju/wos12a3SR5Id89yE3X4yHfnvayvFnrFmvVYv0gN88rzxZzGvT6P8SlfJ9nu/SuE66+Hq2yfVNLDx45xoXMKqvLffdhEPCw63y9Vn1N7fhtZ+bYPxAArtAZE50nR83Mmb74wH66U74OaMS3fX73UbFzrm/A/hq+3cniFZ411pfwa4TsTCaq/H49qn9LV0+x1f/Du8WHs9EfZGFkNDdF/rcs/iycURt30Ydar3L2BQKr9CDzU3UBj3ula/qbZpUs8uO0OfcZr4d6F/Z9WFW/V3G2/X6fZ62xYyAjdudX1tCxD9kXWaTVL/l2omdjhpdzbZo/F3Ii7JFLGsWu590pqwfd1rtu+4rgx7cuN+muiA/yXTM1vLyRWTft1037Z7c1INpC/tWkT6NdusQ96MrQmJiPQaQvouG+QA0cfe1SNeroOQuXk2+TlzDsoqk6NtGWX+JCbj/nhduSNsV539S+UDAX2gpOCmb6/vD1UThsGqfGMGkn+coI5D9HWaTqvBdfdiwGwleL5trljQLR3b+jF48I52tksJIiL8s/4s314/NBV1cM1DKccH+ZOq30g2iV2cUWuWe2AM3M+e6hnjodtgBN+3XT/tktAO+73cpdfNr3abiPizTeuHSgLadmAkcFMhH0Rfb+VFb54SOe++rd+y5O7DtBYHH+hgzVwlZuTndn9v62NXY9YqCIHeeec1zyJ5+KkVAT1uhxbZef65y2/YbSpTxqZytxbr7qsEbS9RAX2bnOadtvKF3KozZd4bnpqsMa20cURX7uZPC2Nf6GEla71GaMnZuxJrDxQ9NnufkYf81P1fv8cMwzpfnSodo0udzx/lMqHzpZx0O+xeZyDnXB/i6rKs3uXn7qaVhcwRnXJ7BDg2vkJYuP5Zd8AjatxX/8JNje//SnwGbkY0ezutUUYCyO+b3K2Q6+/CSyM/mQpdPhAkYXBex9IeNKTibeYnYF7ts3o5OzNTD8v6rA5sYrimGYjmdrYvqc8Yy3vqH5WudfeGARJ4ksy3ST7tPq60WGv41kRPny8YxS/UucxS4vIYcGkym+9UiabeU/ZPlI7mVRpnlGloT53F8Qj+xSud+qKwyNgx5J8sOh2Zu0lwPIrW72SSZVXqjGTeubGfFWM48ufEojj7Z/MP3H7a23auXqpvUXrWr/TS1FibeiHuW+ELVC8wf3aOCHkfBE+02gv0Hi1BCnSJwRbyU8JnzGhBd6jPrBnCIFZigwpMCJt5p7PPIDESBDbhhyZCiIt4o8OvdDig2FYSiQYVDnlnN/FmBXA8MwQIYh8VYLm2FoGIbIcK6GwNrl3LCcI8tIWVJbeiLDMkKWi7H0LAzDBeZF4UOZrU9qskYHsNW0cauxhSUME1VkUGE1NjGimCOq6KCB1dhEiWKWqCKEhlZjEyeKeaKKEmplmJpIUcwUVaTQyGpsYkUxV1TBEqpBVnM7XXiM+WwRemym/8J6JmwU00YVQsyKGzV5oxg4qjBidm5M5iiGjs3GcGUmcwwzxxRFzMocM5ljgwmMjRU1s8xcGDnGR+uamcgxjBxTEDEr7MxEjmHkWDCaLpM4holjiiFmLRRmEscwcUwBw6yFwky8GMaLRRBXNu9wjWy4MpM4holjNXELqzMmcQwTxxVEfGZdeUzkOEaOK4i4tVC4iRzHyHE2NnjcRI4PVksFEbcWGbcsmBg5PrpkcpM4jonjCiJuLTJuIscxcjwc7dgkjmPiuGKIW+uEm8RxTByPRjs26eKYLq544dY64SZdHNMlarqsdSJMugSmS9R0WRcUYdIlMF1CAcOtC4ow8RIYL1HjZa0oYeIlBhuy8R2ZZUuG8RIKGGGtRmHiJTBeQhEjrNUoTL4E5ksoYoS1ooTJl8B8CYWMsFaFMAETGDAxukUTJl8C8xUoYoS1KgKTrwDzFShihJXswOQrwHwF9ZbfSnZg8qW/qk9K97Ko5PZDc2JarbrT/iNZ62NUd936kQiyfHzyyKL5YDP9GTSfnOlP3YyH+jNqPoX+XtT2T/3Zq/62O36p/1PuojNr3p5Ze79E0DsWUDfJ/qY3VAJCbjqbuJSJfobcy8x7GT5FRr9LtoRIaS8ZuUnqW1u9BpuB6OYTRNQ5HfrCgM7MSae70gZUAE00nKJi5puChNNgipY92wxG6MZofZWgUlcJgAzAiTmGWL9Yaa/H9FIcjB13y7l+/Qs0AEPcDe/uzTwIagGCcsvNtv0pBRqzXkbPHm4u6ddoICwBwnLDGl/bAbEBKSacpO6an5UAjTPjat4+g7CAEHebRdLmauwh38rxUgkB2m4hNldUQIRAgrklXN96trgDMk6Zk1b3tgIsAKA6hFv9a5XuiS4QAy4FbqVm1isFHs314ug2iPv8bt9c7+vVQMnplZS55Uo/FEVcTV3i4INVKAQp0KC3kbqtUP2PcHrRmVE9bsPZ3ABO4C1iACyYa6ibb80NoeaC0GD5YyCDzC2FpbpNH6vb9ON1CbcebqR0P4AAKnB03Xy7T+VD0r7aNv3iYJiFWzU0F0OABHCKuw1n/cM5UJIDZj3ihn9/6w0laTF5H9RfGkMkgG2HI/MPcpPU7w6b+ce2mQXzvnD2rpFL+gsWIP2ALO62YHeCauq3+QgKSrhtbDrJQ/v6B8gBxgLnkR3NIIfnlIly7ZxkCxpgLJxHW68z3c0O4CagR7jVaq9nWbc4wFq4zSDttU6AdDQN6VuPHNOj3KeZJMvV7dPTvxID+VIaPAAA";
|
|
@@ -16,6 +16,7 @@
|
|
|
16
16
|
<a href="../types/_openfin_core_web.WebLayoutManager.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Web<wbr/>Layout<wbr/>Manager</span></a>
|
|
17
17
|
<a href="../types/_openfin_core_web.WebLayoutOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Web<wbr/>Layout<wbr/>Options</span></a>
|
|
18
18
|
<a href="../types/_openfin_core_web.WebLayoutPlatformOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Web<wbr/>Layout<wbr/>Platform<wbr/>Options</span></a>
|
|
19
|
+
<a href="../types/_openfin_core_web.WebLayoutSettings.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Web<wbr/>Layout<wbr/>Settings</span></a>
|
|
19
20
|
<a href="../types/_openfin_core_web.WebLayoutSnapshot.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Web<wbr/>Layout<wbr/>Snapshot</span></a>
|
|
20
21
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Functions</h3><div class="tsd-index-list"><a href="../functions/_openfin_core_web.connect.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>connect</span></a>
|
|
21
22
|
</div></section></section></section></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,2 +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"><</span><span class="tsd-signature-type">OpenFin.LayoutComponent</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"componentState"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </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">"componentState"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> & </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
|
|
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"><</span><span class="tsd-signature-type">OpenFin.LayoutComponent</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"componentState"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </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">"componentState"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> & </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.
|
|
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>
|
|
2
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 +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>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"><</span><span class="tsd-signature-type">OpenFin.LayoutOptions</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"content"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </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
|
|
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"><</span><span class="tsd-signature-type">OpenFin.LayoutOptions</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"content"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"settings"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </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,
|
|
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
|
+
</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>
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WebLayoutSettings | @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.WebLayoutSettings.html">WebLayoutSettings</a></li></ul><h1>Type Alias WebLayoutSettings</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Web<wbr/>Layout<wbr/>Settings</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">OpenFin.LayoutOptions</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"settings"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">defaultFaviconUrl</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">showFavicons</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Web-only layout settings for favicon behaviour.
|
|
2
|
+
These fields are not available on desktop layouts and live here rather than in
|
|
3
|
+
OpenFin.LayoutOptions because favicon detection relies on iframe DOM events
|
|
4
|
+
which only exist in the Core-Web path.</p>
|
|
5
|
+
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">default<wbr/>Favicon<wbr/>Url</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>URL of the default icon shown in every view tab hat.
|
|
6
|
+
A broken URL produces a transparent placeholder with no layout shift.</p>
|
|
7
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">show<wbr/>Favicons</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Controls whether the tab hat icon updates dynamically from the loaded page's
|
|
8
|
+
<code><link rel="icon"></code> element.</p>
|
|
9
|
+
<ul>
|
|
10
|
+
<li>Omitted or <code>true</code>: favicon is read from iframe content when available,
|
|
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>
|
|
14
|
+
</ul>
|
|
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
|
+
detected and will always fall back to <code>defaultFaviconUrl</code> (or no icon if unset).</p>
|
|
17
|
+
</div><div class="tsd-tag-Default Value"><h4 class="tsd-anchor-link"><a id="Default Value" class="tsd-anchor"></a>Default Value<a href="#Default Value" 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><code>true</code></p>
|
|
18
|
+
</div></div></li></ul></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>
|