@openfin/workspace-platform 10.1.0 → 10.2.1
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/README.md +1 -1
- package/client-api/src/shapes/store.d.ts +2 -2
- package/client-api-platform/src/shapes.d.ts +11 -8
- package/common/src/utils/application.d.ts +1 -1
- package/common/src/utils/{response-modal-bounds.d.ts → modal-bounds.d.ts} +1 -0
- package/index.js +10 -10
- package/index.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -11,7 +11,7 @@ Run `npm i -E @openfin/workspace-platform`.
|
|
|
11
11
|
## Workspace Platform API documentation
|
|
12
12
|
|
|
13
13
|
- [Overview](https://developers.openfin.co/of-docs/docs/workspace-sdk)
|
|
14
|
-
- [API Reference](https://
|
|
14
|
+
- [API Reference](https://workspace.openfin.co/workspace/docs/platform/latest/index.html)
|
|
15
15
|
- [Example projects using Workspace Platform](https://github.com/built-on-openfin/workspace-starter)
|
|
16
16
|
|
|
17
17
|
## Code examples
|
|
@@ -380,7 +380,7 @@ export interface StorefrontAPI {
|
|
|
380
380
|
* const myStorefrontProvider: StorefrontProvider = {
|
|
381
381
|
* id: "my-storefront-id"
|
|
382
382
|
* title: "My StorefrontProvider"
|
|
383
|
-
* icon: "https://
|
|
383
|
+
* icon: "https://workspace.openfin.co/demos/notifications/generator/images/icon-blue.png",
|
|
384
384
|
* getApps: () => {...},
|
|
385
385
|
* getNavigation: () => {...},
|
|
386
386
|
* getLandingPage: () => {...},
|
|
@@ -406,7 +406,7 @@ export interface StorefrontAPI {
|
|
|
406
406
|
* const myStorefrontProvider: StorefrontProvider = {
|
|
407
407
|
* id: "my-storefront-id"
|
|
408
408
|
* title: "My StoreFrontProvider"
|
|
409
|
-
* icon: "https://
|
|
409
|
+
* icon: "https://workspace.openfin.co/demos/notifications/generator/images/icon-blue.png",
|
|
410
410
|
* getApps: () => {...},
|
|
411
411
|
* getNavigation: () => {...},
|
|
412
412
|
* getLandingPage: () => {...},
|
|
@@ -85,7 +85,7 @@ export interface WorkspaceContextMenuItemData extends GlobalContextMenuItemData
|
|
|
85
85
|
}
|
|
86
86
|
/**Configuration of an option in the global context menu */
|
|
87
87
|
export interface GlobalContextMenuItemTemplate extends Exclude<OpenFin.MenuItemTemplate, 'data'> {
|
|
88
|
-
data
|
|
88
|
+
data?: GlobalContextMenuItemData;
|
|
89
89
|
}
|
|
90
90
|
/**Shape of the data property of a page tab context menu template item */
|
|
91
91
|
export interface PageTabContextMenuItemData extends ContextMenuItemData {
|
|
@@ -93,7 +93,7 @@ export interface PageTabContextMenuItemData extends ContextMenuItemData {
|
|
|
93
93
|
}
|
|
94
94
|
/**Configuration of an option in the page tab context menu */
|
|
95
95
|
export interface PageTabContextMenuItemTemplate extends OpenFin.MenuItemTemplate {
|
|
96
|
-
data
|
|
96
|
+
data?: PageTabContextMenuItemData;
|
|
97
97
|
}
|
|
98
98
|
/**Payload received by a Custom Action that is invoked by a custom global context menu option */
|
|
99
99
|
export interface GlobalContextMenuOptionActionPayload {
|
|
@@ -125,7 +125,7 @@ export declare type OpenGlobalContextMenuPayload = OpenGlobalContextMenuRequest
|
|
|
125
125
|
callback: (data: GlobalContextMenuItemData, payload: OpenGlobalContextMenuPayload) => any;
|
|
126
126
|
};
|
|
127
127
|
export interface ViewTabContextMenuTemplate extends OpenFin.MenuItemTemplate {
|
|
128
|
-
data
|
|
128
|
+
data?: ViewTabMenuData;
|
|
129
129
|
}
|
|
130
130
|
/**
|
|
131
131
|
* Request for opening a view tab context menu in Browser.
|
|
@@ -162,6 +162,9 @@ export declare enum ViewTabMenuOptionType {
|
|
|
162
162
|
CloseViews = "CloseTab",
|
|
163
163
|
AddToChannel = "AddToChannel",
|
|
164
164
|
RemoveFromChannel = "RemoveFromChannel",
|
|
165
|
+
Back = "Back",
|
|
166
|
+
Forward = "Forward",
|
|
167
|
+
Print = "Print",
|
|
165
168
|
Custom = "Custom"
|
|
166
169
|
}
|
|
167
170
|
export interface ViewTabMenuData {
|
|
@@ -304,7 +307,7 @@ export interface SaveButtonContextMenuItemData extends ContextMenuItemData {
|
|
|
304
307
|
}
|
|
305
308
|
/**Configuration of an option in the save button context menu */
|
|
306
309
|
export interface SaveButtonContextMenuItemTemplate extends OpenFin.MenuItemTemplate {
|
|
307
|
-
data
|
|
310
|
+
data?: SaveButtonContextMenuItemData;
|
|
308
311
|
}
|
|
309
312
|
/**
|
|
310
313
|
* Request for opening a context menu from save button in Browser.
|
|
@@ -1035,8 +1038,8 @@ export interface WorkspacePlatformModule extends OpenFin.Platform {
|
|
|
1035
1038
|
* manifestType: AppManifestType.Manifest,
|
|
1036
1039
|
* icons:[
|
|
1037
1040
|
* {
|
|
1038
|
-
* icon: "https://
|
|
1039
|
-
* src: "https://
|
|
1041
|
+
* icon: "https://workspace.openfin.co/demos/notifications/generator/images/icon-blue.png",
|
|
1042
|
+
* src: "https://workspace.openfin.co/demos/notifications/generator/images/icon-blue.png",
|
|
1040
1043
|
* type: "ico",
|
|
1041
1044
|
* },
|
|
1042
1045
|
* ]
|
|
@@ -1239,7 +1242,7 @@ export interface WorkspacePlatformInitConfig {
|
|
|
1239
1242
|
overrideCallback?: WorkspacePlatformOverrideCallback;
|
|
1240
1243
|
/**
|
|
1241
1244
|
* Override workspace platform interop behavior
|
|
1242
|
-
* https://
|
|
1245
|
+
* https://workspace.openfin.co/docs/javascript/stable/InteropBroker.html
|
|
1243
1246
|
*/
|
|
1244
1247
|
interopOverride?: OpenFin.OverrideCallback<OpenFin.InteropBroker, OpenFin.InteropBroker>;
|
|
1245
1248
|
}
|
|
@@ -1383,7 +1386,7 @@ export interface BrowserInitConfig {
|
|
|
1383
1386
|
/**
|
|
1384
1387
|
* @deprecated
|
|
1385
1388
|
* Override workspace platform interop behavior
|
|
1386
|
-
* https://
|
|
1389
|
+
* https://workspace.openfin.co/docs/javascript/stable/OpenFin.InteropBroker.html
|
|
1387
1390
|
*/
|
|
1388
1391
|
interopOverride?: OpenFin.OverrideCallback<OpenFin.InteropBroker, OpenFin.InteropBroker>;
|
|
1389
1392
|
}
|
|
@@ -18,3 +18,4 @@ export declare const getResponseModalBounds: (modalOptions: ResponseModalConfig[
|
|
|
18
18
|
* @param monitor the monitor to check against
|
|
19
19
|
*/
|
|
20
20
|
export declare function getPercentageOfBoundsInMonitor(bounds: OpenFin.Bounds, monitor: OpenFin.MonitorDetails): number;
|
|
21
|
+
export declare function getMonitorWindowMaximizedOn(parentWindowBounds: OpenFin.WindowBounds): Promise<OpenFin.MonitorDetails>;
|