@openfin/workspace-platform 22.2.7 → 22.2.8

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.
@@ -59,34 +59,34 @@ export declare const register: (provider: DockProvider) => Promise<DockProviderR
59
59
  */
60
60
  export declare const deregister: () => Promise<void>;
61
61
  /**
62
- * API function to show the Dock UI.
62
+ * API function to minimize the Dock UI.
63
63
  *
64
64
  * @remarks A Workspace Platform must be initialized, and at least one Dock provider must be registered for this function to take effect.
65
65
  *
66
- * @returns a promise that resolves once the Dock UI is hidden
66
+ * @returns a promise that resolves once the Dock UI is minimized
67
67
  *
68
- * @example Show a Dock provider.
68
+ * @example Minimize a Dock provider.
69
69
  *
70
70
  * ```ts
71
71
  * import { Dock } from '@openfin/workspace';
72
72
  *
73
- * await Dock.show();
73
+ * await Dock.minimize();
74
74
  * ```
75
75
  */
76
76
  export declare const minimize: () => Promise<void>;
77
77
  /**
78
- * API function to hide the Dock UI.
78
+ * API function to show the Dock UI.
79
79
  *
80
80
  * @remarks A Workspace Platform must be initialized, and at least one Dock provider must be registered for this function to take effect.
81
81
  *
82
- * @returns a promise that resolves once the Dock UI is hidden
82
+ * @returns a promise that resolves once the Dock UI is shown
83
83
  *
84
- * @example Hide a Dock provider.
84
+ * @example Show a Dock provider.
85
85
  *
86
86
  * ```ts
87
87
  * import { Dock } from '@openfin/workspace';
88
88
  *
89
- * await Dock.hide();
89
+ * await Dock.show();
90
90
  * ```
91
91
  */
92
92
  export declare const show: () => Promise<void>;
@@ -44,6 +44,8 @@ type AttachedPageMetadata = {
44
44
  hasUnsavedChanges?: boolean;
45
45
  /** Panel config with all view identities in place */
46
46
  panels?: ExtendedPanelConfig[];
47
+ /** The name of the layout this page contains, useful for interacting with OpenFin Core APIs. */
48
+ layoutName?: string;
47
49
  };
48
50
  export type AttachedPage = Page & AttachedPageMetadata;
49
51
  export type AttachedPageInternal = {
@@ -51,5 +53,6 @@ export type AttachedPageInternal = {
51
53
  singleViewName?: string;
52
54
  attachedPageType?: 'singleView' | 'multiView' | undefined;
53
55
  isLayoutCreated?: boolean;
56
+ isLayoutReady?: boolean;
54
57
  } & AttachedPage;
55
58
  export {};
@@ -1,6 +1,7 @@
1
1
  import type OpenFin from '@openfin/core';
2
+ import { IconType } from '@openfin/ui-library';
2
3
  import { IndicatorType } from '../../../../common/src/components/Indicator/Indicator.constants';
3
- export type BrowserIndicatorIcon = 'LockClosedIcon' | 'LockOpen1Icon' | 'PageIcon' | 'BlockedIcon';
4
+ export type BrowserIndicatorIcon = Extract<IconType, 'LockClosedIcon' | 'LockOpen1Icon' | 'PageIcon' | 'BlockedIcon' | 'SupertabIcon'>;
4
5
  export interface ShowBrowserIndicatorPayload {
5
6
  type: IndicatorType;
6
7
  message: string;