@openfin/core 28.72.11 → 28.72.13
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/OpenFin.d.ts
CHANGED
|
@@ -154,6 +154,7 @@ declare namespace OpenFin {
|
|
|
154
154
|
| 'resizable'
|
|
155
155
|
| 'resizeRegion'
|
|
156
156
|
| 'saveWindowState'
|
|
157
|
+
| 'ignoreSavedWindowState'
|
|
157
158
|
| 'shadow'
|
|
158
159
|
| 'showTaskbarIcon'
|
|
159
160
|
| 'smallWindow'
|
|
@@ -254,13 +255,13 @@ declare namespace OpenFin {
|
|
|
254
255
|
|
|
255
256
|
export type WindowOptions = MutableWindowOptions & ConstWindowOptions;
|
|
256
257
|
|
|
257
|
-
export type ViewVisibilityOption = {
|
|
258
|
+
export type ViewVisibilityOption = {
|
|
258
259
|
enabled?: boolean;
|
|
259
|
-
}
|
|
260
|
+
};
|
|
260
261
|
|
|
261
|
-
export type ShowViewOnWindowResizeOptions =
|
|
262
|
+
export type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
|
|
262
263
|
paintIntervalMs?: number;
|
|
263
|
-
}
|
|
264
|
+
};
|
|
264
265
|
|
|
265
266
|
export type ViewVisibilityOptions = {
|
|
266
267
|
showViewsOnWindowResize?: ShowViewOnWindowResizeOptions;
|
|
@@ -289,12 +290,13 @@ declare namespace OpenFin {
|
|
|
289
290
|
height: number;
|
|
290
291
|
hideOnClose: boolean;
|
|
291
292
|
includeInSnapshots: boolean;
|
|
292
|
-
layout:
|
|
293
|
+
layout: LayoutOptions;
|
|
293
294
|
modalParentIdentity: Identity;
|
|
294
295
|
name: string;
|
|
295
296
|
preloadScripts: PreloadScript[];
|
|
296
297
|
processAffinity: string;
|
|
297
298
|
saveWindowState: boolean;
|
|
299
|
+
ignoreSavedWindowState: boolean;
|
|
298
300
|
shadow: boolean;
|
|
299
301
|
smallWindow: boolean;
|
|
300
302
|
state: WindowState;
|
|
@@ -729,35 +731,50 @@ declare namespace OpenFin {
|
|
|
729
731
|
};
|
|
730
732
|
};
|
|
731
733
|
|
|
734
|
+
export type LayoutContent = (LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent)[];
|
|
735
|
+
|
|
736
|
+
export type LayoutItemConfig = {
|
|
737
|
+
type: string;
|
|
738
|
+
content?: LayoutContent;
|
|
739
|
+
width?: number;
|
|
740
|
+
height?: number;
|
|
741
|
+
id?: string | string[];
|
|
742
|
+
isClosable?: boolean;
|
|
743
|
+
title?: string;
|
|
744
|
+
};
|
|
745
|
+
|
|
746
|
+
export interface LayoutRow extends LayoutItemConfig {
|
|
747
|
+
type: 'row';
|
|
748
|
+
}
|
|
749
|
+
|
|
750
|
+
export interface LayoutColumn extends LayoutItemConfig {
|
|
751
|
+
type: 'column';
|
|
752
|
+
}
|
|
753
|
+
|
|
754
|
+
export interface LayoutComponent extends LayoutItemConfig {
|
|
755
|
+
componentName: 'view';
|
|
756
|
+
componentState?: Partial<ViewCreationOptions>;
|
|
757
|
+
}
|
|
758
|
+
|
|
732
759
|
export type LayoutOptions = {
|
|
733
|
-
settings
|
|
760
|
+
settings?: {
|
|
734
761
|
popoutWholeStack?: boolean;
|
|
735
762
|
constrainDragToContainer?: boolean;
|
|
736
763
|
showPopoutIcon?: boolean;
|
|
737
764
|
showMaximiseIcon?: boolean;
|
|
738
765
|
showCloseIcon?: boolean;
|
|
739
766
|
constrainDragToHeaders?: boolean;
|
|
767
|
+
hasHeaders?: boolean;
|
|
768
|
+
reorderEnabled?: boolean;
|
|
769
|
+
preventDragOut?: boolean;
|
|
770
|
+
preventDragIn?: boolean;
|
|
740
771
|
};
|
|
741
|
-
content
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
type: 'row';
|
|
748
|
-
content: LayoutContent;
|
|
749
|
-
};
|
|
750
|
-
export type LayoutColumn = {
|
|
751
|
-
type: 'column';
|
|
752
|
-
content: LayoutContent;
|
|
753
|
-
};
|
|
754
|
-
export type LayoutComponent = {
|
|
755
|
-
type: 'component';
|
|
756
|
-
componentName: 'view';
|
|
757
|
-
componentState: {
|
|
758
|
-
name: string;
|
|
759
|
-
url: string;
|
|
760
|
-
title?: string;
|
|
772
|
+
content?: LayoutContent;
|
|
773
|
+
dimensions?: {
|
|
774
|
+
borderWidth?: number;
|
|
775
|
+
minItemHeight?: number;
|
|
776
|
+
minItemWidth?: number;
|
|
777
|
+
headerHeight?: number;
|
|
761
778
|
};
|
|
762
779
|
};
|
|
763
780
|
|
|
@@ -1548,7 +1565,7 @@ declare namespace OpenFin {
|
|
|
1548
1565
|
topic: string,
|
|
1549
1566
|
payload: unknown,
|
|
1550
1567
|
senderIdentity: ProviderIdentity | OpenFin.ClientIdentity
|
|
1551
|
-
) => Promise<unknown> |unknown;
|
|
1568
|
+
) => Promise<unknown> | unknown;
|
|
1552
1569
|
|
|
1553
1570
|
export type ErrorMiddleware = (
|
|
1554
1571
|
topic: string,
|
package/package.json
CHANGED
|
@@ -26,7 +26,7 @@ export declare class Layout extends Base {
|
|
|
26
26
|
* @return { Promise<void> }
|
|
27
27
|
* @tutorial Layout.replace
|
|
28
28
|
*/
|
|
29
|
-
replace: (layout:
|
|
29
|
+
replace: (layout: OpenFin.LayoutOptions) => Promise<void>;
|
|
30
30
|
/**
|
|
31
31
|
* Replaces the specified view with a view with the provided configuration.
|
|
32
32
|
* The old view is stripped of its listeners and either closed or attached to the provider window
|
|
@@ -307,6 +307,9 @@ import WindowEvents = OpenFin.WindowEvents;
|
|
|
307
307
|
* A flag to cache the location of the window.
|
|
308
308
|
* ** note ** - This option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
|
|
309
309
|
*
|
|
310
|
+
* @property {boolean} [ignoreSavedWindowState]
|
|
311
|
+
* A flag to ignore previously cached state of the window. It defaults the opposite value of `saveWindowState` to maintain backwards compatibility.
|
|
312
|
+
*
|
|
310
313
|
* @property {boolean} [shadow=false]
|
|
311
314
|
* A flag to display a shadow on frameless windows.
|
|
312
315
|
* `shadow` and `cornerRounding` are mutually exclusive.
|
|
@@ -314,6 +314,9 @@ const view_1 = require("../view");
|
|
|
314
314
|
* A flag to cache the location of the window.
|
|
315
315
|
* ** note ** - This option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
|
|
316
316
|
*
|
|
317
|
+
* @property {boolean} [ignoreSavedWindowState]
|
|
318
|
+
* A flag to ignore previously cached state of the window. It defaults the opposite value of `saveWindowState` to maintain backwards compatibility.
|
|
319
|
+
*
|
|
317
320
|
* @property {boolean} [shadow=false]
|
|
318
321
|
* A flag to display a shadow on frameless windows.
|
|
319
322
|
* `shadow` and `cornerRounding` are mutually exclusive.
|