@openfin/workspace 24.1.1 → 24.1.3
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/client-api-platform/src/init/index.d.ts +1 -1
- package/client-api-platform/src/shapes.d.ts +22 -1
- package/common/src/api/pages/enterprise-shapes.d.ts +2 -0
- package/common/src/api/pages/shapes.d.ts +8 -0
- package/common/src/utils/indicators/showIndicator.d.ts +8 -1
- package/common/src/utils/indicators/workspace-indicators.d.ts +13 -0
- package/dock3/src/api/protocol.d.ts +2 -0
- package/externals.report.json +8 -8
- package/home.js +1 -1
- package/home.js.map +1 -1
- package/index.js +1 -1
- package/index.js.map +1 -1
- package/notifications.js +1 -1
- package/notifications.js.map +1 -1
- package/package.json +1 -1
- package/store.js +1 -1
- package/store.js.map +1 -1
- package/common/src/api/tabs.d.ts +0 -16
|
@@ -35,4 +35,4 @@ import { WorkspacePlatformInitConfig } from '../../../client-api-platform/src/sh
|
|
|
35
35
|
* ```
|
|
36
36
|
* @param options options for configuring the platform.
|
|
37
37
|
*/
|
|
38
|
-
export declare const init: (
|
|
38
|
+
export declare const init: (config: WorkspacePlatformInitConfig) => Promise<OpenFin.Platform>;
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import type OpenFin from '@openfin/core';
|
|
2
2
|
import type { IconProps, IconType, Languages } from '@openfin/ui-library';
|
|
3
3
|
import type { ModalResponseEvent } from '../../common/src/utils/menu-window-provider';
|
|
4
|
+
import type { WorkspaceIndicatorConfig } from '../../common/src/utils/indicators/workspace-indicators';
|
|
4
5
|
import type { AnalyticsEvent, AnalyticsEventInternal } from '../../common/src/utils/usage-register';
|
|
5
6
|
import type { BaseCustomDropdownItem, CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/action';
|
|
6
7
|
import type { Resource } from '../../common/src/api/i18next';
|
|
@@ -160,6 +161,10 @@ export declare enum PageTabContextMenuOptionType {
|
|
|
160
161
|
Save = "Save",
|
|
161
162
|
SaveAs = "Save As",
|
|
162
163
|
NewPage = "New Page",
|
|
164
|
+
/** Enterprise Browser: toggle Golden Layout view tab headers (multi-view Supertabs).
|
|
165
|
+
* @internal
|
|
166
|
+
*/
|
|
167
|
+
ShowHideTabs = "ShowHideTabs",// Enterprise
|
|
163
168
|
DeletePage = "Delete Page",// Enterprise
|
|
164
169
|
SaveWorkspaceAs = "SaveWorkspaceAs",// Enterprise
|
|
165
170
|
Refresh = "Refresh",// Enterprise
|
|
@@ -175,7 +180,6 @@ export declare enum PageTabContextMenuOptionType {
|
|
|
175
180
|
/** @internal */
|
|
176
181
|
export declare enum EnterpriseMainContextMenuOptionType {
|
|
177
182
|
Lock = "Lock",
|
|
178
|
-
ShowHideTabs = "ShowHideTabs",
|
|
179
183
|
AddToChanel = "AddToChannel",
|
|
180
184
|
ManageDesktopSignals = "ManageDesktopSignals",// Enterprise
|
|
181
185
|
FindInPage = "FindInPage",// Enterprise
|
|
@@ -3020,6 +3024,23 @@ export interface BrowserInitConfig {
|
|
|
3020
3024
|
* Defaults to `false` (current unique-title behavior preserved).
|
|
3021
3025
|
*/
|
|
3022
3026
|
allowDuplicatePageTitles?: boolean;
|
|
3027
|
+
/**
|
|
3028
|
+
* Opt-in suppression flags for workspace success indicators.
|
|
3029
|
+
* Both flags default to `false`; existing platforms see no behaviour change.
|
|
3030
|
+
*
|
|
3031
|
+
* @example
|
|
3032
|
+
* ```ts
|
|
3033
|
+
* await WorkspacePlatform.init({
|
|
3034
|
+
* browser: {
|
|
3035
|
+
* indicators: {
|
|
3036
|
+
* suppressWorkspaceSwitched: true,
|
|
3037
|
+
* suppressWorkspaceSaved: true,
|
|
3038
|
+
* },
|
|
3039
|
+
* },
|
|
3040
|
+
* });
|
|
3041
|
+
* ```
|
|
3042
|
+
*/
|
|
3043
|
+
indicators?: WorkspaceIndicatorConfig;
|
|
3023
3044
|
}
|
|
3024
3045
|
interface WorkspaceMetadata {
|
|
3025
3046
|
APIVersion: string;
|
|
@@ -32,6 +32,8 @@ export interface Page {
|
|
|
32
32
|
panels?: PanelConfig[];
|
|
33
33
|
/** Used to define the context group for the page */
|
|
34
34
|
contextGroup?: string;
|
|
35
|
+
/** When true, view tab headers within this Supertab are hidden. */
|
|
36
|
+
viewTabsHidden?: boolean;
|
|
35
37
|
/** Optional property to attach custom metadata to the page object, such as version or timestamp. Must be serializable. */
|
|
36
38
|
customData?: any;
|
|
37
39
|
/** True when this page is an admin-published supertab. */
|
|
@@ -96,12 +96,20 @@ export type AttachedPageInternal = {
|
|
|
96
96
|
isLayoutCreated?: boolean;
|
|
97
97
|
pageIcon?: string;
|
|
98
98
|
isPublished?: boolean;
|
|
99
|
+
/** Enterprise Browser: hide Golden Layout view tab headers (multi-view Supertabs).
|
|
100
|
+
* @internal
|
|
101
|
+
*/
|
|
102
|
+
viewTabsHidden?: boolean;
|
|
99
103
|
} & AttachedPage;
|
|
100
104
|
export type ReparentAttachedPage = AttachedPage & {
|
|
101
105
|
multiInstanceViewBehavior?: 'reparent';
|
|
102
106
|
};
|
|
103
107
|
export type PageWithUpdatableRuntimeAttribs = Page & Pick<AttachedPage, 'hasUnsavedChanges'> & {
|
|
104
108
|
multiInstanceViewBehavior?: OpenFin.MultiInstanceViewBehavior;
|
|
109
|
+
/** Enterprise Browser: hide Golden Layout view tab headers (multi-view Supertabs).
|
|
110
|
+
* @internal
|
|
111
|
+
*/
|
|
112
|
+
viewTabsHidden?: boolean;
|
|
105
113
|
};
|
|
106
114
|
export interface DetachPagesFromWindowPayload {
|
|
107
115
|
/** The OF window identity to detach the pages from. */
|
|
@@ -50,6 +50,13 @@ export declare function showSuccess(payload: ShowSuccessPayload): Promise<void>;
|
|
|
50
50
|
*/
|
|
51
51
|
export declare function showInfo(payload: ShowInfoPayload): Promise<void>;
|
|
52
52
|
/**
|
|
53
|
-
* Creates a window centered on monitor containing a success indicator for switching workspaces
|
|
53
|
+
* Creates a window centered on monitor containing a success indicator for switching workspaces.
|
|
54
|
+
* No-ops when `suppressWorkspaceSwitched` has been set via `BrowserInitConfig.indicators`.
|
|
54
55
|
*/
|
|
55
56
|
export declare function showSwitchWorkspaceSuccess(): Promise<void>;
|
|
57
|
+
/**
|
|
58
|
+
* Creates a success indicator for workspace save and save-as operations.
|
|
59
|
+
* No-ops when `suppressWorkspaceSaved` has been set via `BrowserInitConfig.indicators`.
|
|
60
|
+
* Rename operations are intentionally unaffected — use `showSuccess` directly for those.
|
|
61
|
+
*/
|
|
62
|
+
export declare const showWorkspaceSavedSuccess: (payload: ShowSuccessPayload) => Promise<void>;
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Configuration for suppressing workspace success indicators.
|
|
3
|
+
*/
|
|
4
|
+
export interface WorkspaceIndicatorConfig {
|
|
5
|
+
/** Suppress the "Workspace Switched" indicator on all applyWorkspace calls. @default false */
|
|
6
|
+
suppressWorkspaceSwitched?: boolean;
|
|
7
|
+
/** Suppress the "Workspace Saved" indicator on regular workspace save only. Save-as and rename are unaffected. @default false */
|
|
8
|
+
suppressWorkspaceSaved?: boolean;
|
|
9
|
+
}
|
|
10
|
+
export declare const initWorkspaceIndicators: (config?: WorkspaceIndicatorConfig) => void;
|
|
11
|
+
export declare const getSuppressWorkspaceSwitched: () => boolean;
|
|
12
|
+
/** Returns true when the "Workspace Saved" indicator should be suppressed (save only; save-as and rename are unaffected). */
|
|
13
|
+
export declare const getSuppressWorkspaceSaved: () => boolean;
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import type { OpenFin } from '@openfin/core';
|
|
2
2
|
import { BaseCustomDropdownItem } from '../../../client-api/src/shapes';
|
|
3
3
|
import { BookmarkDockEntryPayload, DockEntry, LaunchDockEntryPayload, Collection } from '../../../client-api-platform/src/shapes';
|
|
4
|
+
import { WorkspaceIndicatorConfig } from '../../../common/src/utils/indicators/workspace-indicators';
|
|
4
5
|
import { Dock3Config, DockCompanionButton } from '../../../dock3/src/shapes';
|
|
5
6
|
/**
|
|
6
7
|
* Payload for more menu custom option actions
|
|
@@ -40,6 +41,7 @@ export type Dock3ChannelClientChannelActions = {
|
|
|
40
41
|
'navigate-content-menu': (payload: {
|
|
41
42
|
targetId: string;
|
|
42
43
|
}) => void;
|
|
44
|
+
'handle-indicator-config': (payload: WorkspaceIndicatorConfig) => void;
|
|
43
45
|
};
|
|
44
46
|
/**
|
|
45
47
|
* @internal
|
package/externals.report.json
CHANGED
|
@@ -43,14 +43,6 @@
|
|
|
43
43
|
"issuer": "common/src/utils/layout.ts"
|
|
44
44
|
}
|
|
45
45
|
],
|
|
46
|
-
"lodash.clonedeep": [
|
|
47
|
-
{
|
|
48
|
-
"type": "explicit",
|
|
49
|
-
"version": "4.5.0",
|
|
50
|
-
"packageName": "common/package.json",
|
|
51
|
-
"issuer": "common/src/utils/layout.ts"
|
|
52
|
-
}
|
|
53
|
-
],
|
|
54
46
|
"react-i18next": [
|
|
55
47
|
{
|
|
56
48
|
"type": "explicit",
|
|
@@ -67,6 +59,14 @@
|
|
|
67
59
|
"issuer": "common/src/api/i18next.ts"
|
|
68
60
|
}
|
|
69
61
|
],
|
|
62
|
+
"lodash.clonedeep": [
|
|
63
|
+
{
|
|
64
|
+
"type": "explicit",
|
|
65
|
+
"version": "4.5.0",
|
|
66
|
+
"packageName": "common/package.json",
|
|
67
|
+
"issuer": "common/src/utils/layout.ts"
|
|
68
|
+
}
|
|
69
|
+
],
|
|
70
70
|
"dexie": [
|
|
71
71
|
{
|
|
72
72
|
"type": "root-implicit",
|