@openfin/workspace 20.2.4 → 20.3.0

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.
Files changed (100) hide show
  1. package/client-api-platform/src/init/override-callback/browser-defaults.d.ts +0 -1
  2. package/client-api-platform/src/shapes.d.ts +5 -6
  3. package/common/src/api/pages/shapes.d.ts +21 -0
  4. package/common/src/utils/browser-base-url.d.ts +21 -2
  5. package/common/src/utils/context-menu.d.ts +2 -0
  6. package/common/src/utils/layout.d.ts +5 -1
  7. package/common/src/utils/popup-window.d.ts +5 -1
  8. package/common/src/utils/route.d.ts +44 -16
  9. package/common/src/utils/router/base.d.ts +2 -1
  10. package/home.js +1 -1
  11. package/home.js.map +1 -1
  12. package/index.js +3 -3
  13. package/index.js.map +1 -1
  14. package/notifications.js +2 -2
  15. package/notifications.js.map +1 -1
  16. package/package.json +2 -2
  17. package/search-api/src/client/index.d.ts +1 -1
  18. package/search-api/src/client/remote/channel-client-factory.d.ts +1 -1
  19. package/search-api/src/client/remote/disconnect.d.ts +1 -1
  20. package/search-api/src/common.d.ts +0 -5
  21. package/search-api/src/provider/index.d.ts +1 -1
  22. package/search-api/src/provider/remote/channel-factory.d.ts +1 -1
  23. package/store.js +1 -1
  24. package/store.js.map +1 -1
  25. package/browser/src/api/color-linking.d.ts +0 -23
  26. package/browser/src/api/controls.d.ts +0 -23
  27. package/browser/src/api/pages/attached.d.ts +0 -23
  28. package/browser/src/api/pages/state.d.ts +0 -10
  29. package/browser/src/api/panels.d.ts +0 -106
  30. package/browser/src/api/view.d.ts +0 -22
  31. package/browser/src/components/ControlBar/LeftControlsContainer/EnterpriseNavigationContainer/AddressBar/AddressBar.d.ts +0 -15
  32. package/browser/src/components/ControlBar/LeftControlsContainer/EnterpriseNavigationContainer/AddressBar/AddressBarInput.d.ts +0 -18
  33. package/browser/src/components/ControlBar/RightControlsContainer/ToolbarContainer/menus/menuConfig.d.ts +0 -17
  34. package/browser/src/components/ControlBar/SearchMenu/BookmarkButton.d.ts +0 -9
  35. package/browser/src/components/ControlBar/SearchMenu/CommandBar.d.ts +0 -9
  36. package/browser/src/components/ControlBar/SearchMenu/Icons.d.ts +0 -23
  37. package/browser/src/components/ControlBar/SearchMenu/ResultIcon.d.ts +0 -11
  38. package/browser/src/components/ControlBar/SearchMenu/SecureIcon.d.ts +0 -5
  39. package/browser/src/components/ControlBar/SearchMenu/UrlInput.d.ts +0 -3
  40. package/browser/src/components/ControlBar/SearchMenu/useBookmarkButtonHover.d.ts +0 -2
  41. package/browser/src/components/ControlBar/SearchMenu/useEnterpriseBookmarkDialogWindow.d.ts +0 -2
  42. package/browser/src/components/ControlBar/SearchMenu/useIsBookmarked.d.ts +0 -1
  43. package/browser/src/components/ControlBar/SearchMenu/useIsPageOpen.d.ts +0 -3
  44. package/browser/src/components/ControlBar/SearchMenu/useIsSelectedViewNavigated.d.ts +0 -5
  45. package/browser/src/components/ControlBar/SearchMenu/useSelectedAndOpenViewsBroadcastChannel.d.ts +0 -8
  46. package/browser/src/components/ControlBar/SearchMenu/utils.d.ts +0 -11
  47. package/browser/src/components/ControlBar/Tablist/utils.d.ts +0 -8
  48. package/browser/src/components/ControlBar/utils.d.ts +0 -1
  49. package/browser/src/components/LandingPage/BrandIcon.d.ts +0 -6
  50. package/browser/src/components/LayoutContainer/utils.d.ts +0 -10
  51. package/browser/src/components/PanelContainer/BookmarksPanel/BookmarkItem.d.ts +0 -17
  52. package/browser/src/components/PanelContainer/BookmarksPanel/BookmarksFolderHeader.d.ts +0 -8
  53. package/browser/src/components/PanelContainer/BookmarksPanel/BookmarksPanel.d.ts +0 -9
  54. package/browser/src/components/PanelContainer/BookmarksPanel/BookmarksPanelHeader.d.ts +0 -3
  55. package/browser/src/components/PanelContainer/BookmarksPanel/BookmarksResults.d.ts +0 -15
  56. package/browser/src/components/PanelContainer/BookmarksPanel/BookmarksSearchInput.d.ts +0 -7
  57. package/browser/src/components/PanelContainer/BookmarksPanel/useBookmarksSearch.d.ts +0 -16
  58. package/browser/src/components/PanelContainer/BookmarksPanel/useUpdateBookmarkResultsActions.d.ts +0 -15
  59. package/browser/src/components/PanelContainer/PanelContainer.d.ts +0 -8
  60. package/browser/src/hooks/EnterpriseSearchMenu/AdjustSearchMenuDimensions/getDimensions.d.ts +0 -14
  61. package/browser/src/hooks/EnterpriseSearchMenu/AdjustSearchMenuDimensions/useAdjustSearchMenuViewDimensions.d.ts +0 -25
  62. package/browser/src/hooks/EnterpriseSearchMenu/useInitChannelToSearchMenuView.d.ts +0 -18
  63. package/browser/src/hooks/EnterpriseSearchMenu/usePostMessageToSearchMenuView.d.ts +0 -18
  64. package/browser/src/hooks/EnterpriseSearchMenu/useProcessChildContentBlockEvent.d.ts +0 -3
  65. package/browser/src/hooks/EnterpriseSearchMenu/useSearchMenuViewLifecycleManager.d.ts +0 -16
  66. package/browser/src/hooks/EnterpriseSearchMenu/useUpdateInputExpansionState.d.ts +0 -15
  67. package/browser/src/hooks/EnterpriseSearchMenu/useUpdateViewExpansionState.d.ts +0 -32
  68. package/browser/src/hooks/useEnterpriseHotkeys.d.ts +0 -4
  69. package/browser/src/hooks/usePanelBounds.d.ts +0 -4
  70. package/browser/src/hooks/useSingleViewPage.d.ts +0 -2
  71. package/browser/src/hooks/useWindowFocusState.d.ts +0 -17
  72. package/browser/src/slices/menu.d.ts +0 -28
  73. package/browser/src/slices/modal/close.d.ts +0 -10
  74. package/browser/src/slices/modal/index.d.ts +0 -8
  75. package/browser/src/slices/pages/attached.d.ts +0 -83
  76. package/browser/src/slices/tab-focus.d.ts +0 -85
  77. package/browser/src/store/index.d.ts +0 -90
  78. package/client-api-platform/src/init/override-callback/enterprise-page-required-layout-settings.d.ts +0 -5
  79. package/common/src/api/pages/internal.d.ts +0 -8
  80. package/common/src/api/workspace-events.d.ts +0 -49
  81. package/common/src/components/BaseButton/BaseButton.d.ts +0 -53
  82. package/common/src/components/CloseButton/CloseButtonLarge.d.ts +0 -4
  83. package/common/src/components/Icon/CustomIcon.d.ts +0 -15
  84. package/common/src/hooks/context.d.ts +0 -58
  85. package/common/src/hooks/useAddEditBookmarkDialog.d.ts +0 -7
  86. package/common/src/hooks/usePlatformTheme.d.ts +0 -6
  87. package/common/src/hooks/usePreloadedWindow.d.ts +0 -13
  88. package/common/src/hooks/useSystemSchemeCheck.d.ts +0 -13
  89. package/common/src/slices/environment.d.ts +0 -22
  90. package/common/src/slices/target-theming.d.ts +0 -56
  91. package/common/src/styles/svg-icons.d.ts +0 -7
  92. package/common/src/utils/a11y/index.d.ts +0 -3
  93. package/common/src/utils/bookmark-item-context-menu.d.ts +0 -8
  94. package/common/src/utils/bookmarks.d.ts +0 -16
  95. package/common/src/utils/custom-logo.d.ts +0 -16
  96. package/common/src/utils/get-browser-window.d.ts +0 -3
  97. package/common/src/utils/interop.d.ts +0 -30
  98. package/common/src/utils/navigate.d.ts +0 -8
  99. package/common/src/utils/test-ids.d.ts +0 -70
  100. package/common/src/utils/url.d.ts +0 -1
@@ -1,16 +0,0 @@
1
- import type OpenFin from '@openfin/core';
2
- import { SecureIconState } from '../../../../browser/src/components/ControlBar/LeftControlsContainer/EnterpriseNavigationContainer/AddressBar/AddressBar';
3
- /**
4
- * Custom hook that manages the contents of the address input as users interact with the browser and navigate views.
5
- * This hook handles the auto-focusing the address input on the landing page, registers handlers for view URL changes,
6
- * and manages the state of the secure icon displayed next to valid addresses.
7
- *
8
- * @param {string} searchText - String representing the current text in the address input.
9
- * @param {OpenFin.Identity[]} selectedViews - Array of currently selected views in the browser window.
10
- * @param {React.MutableRefObject<HTMLInputElement>} addressBarInputRef - Ref object associated with the address input DOM element.
11
- * @param {SecureIconState} isSecure - Object describing whether the currently focused view's site is secure and whether to show an icon in the address bar.
12
- * @param {Dispatch<SetStateAction<SearchViewExpansionState>>} setShouldExpandMenu - Function that updates whether the menu should expand and the method of expansion.
13
- * @param {React.Dispatch<React.SetStateAction<SecureIconState>>} setIsSecure - Function that updates whether the currently focused view's site is secure and whether to show an icon in the address bar.
14
- */
15
- declare const useSearchMenuViewLifecycleManager: (searchText: string, selectedViews: OpenFin.Identity[], addressBarInputRef: React.MutableRefObject<HTMLInputElement>, isSecure: SecureIconState, setSearchText: React.Dispatch<React.SetStateAction<string>>, setIsSecure: React.Dispatch<React.SetStateAction<SecureIconState>>) => void;
16
- export default useSearchMenuViewLifecycleManager;
@@ -1,15 +0,0 @@
1
- import { FocusEventHandler, MutableRefObject } from 'react';
2
- import { SearchViewExpansionState } from '../../../../browser/src/components/ControlBar/LeftControlsContainer/EnterpriseNavigationContainer/AddressBar/AddressBar';
3
- /**
4
- * Custom hook that returns action handlers for the address input DOM element that update the search view expansion state.
5
- *
6
- * @param {MutableRefObject<HTMLInputElement>} addressBarInputRef - Ref object pointing to the address input element.
7
- * @param {boolean} shouldExpand - Boolean indicating if the search results view should expand.
8
- * @param {React.Dispatch<React.SetStateAction<string>>} setSearchText - Function that updates the search text.
9
- * @param {Dispatch<SetStateAction<SearchViewExpansionState>>} setShouldExpandMenu - Function that updates whether the menu should expand and the method of expansion.
10
- */
11
- export declare const useUpdateInputExpansionState: (addressBarInputRef: MutableRefObject<HTMLInputElement>, shouldExpand: boolean, setSearchText: React.Dispatch<React.SetStateAction<string>>, setShouldExpandMenu: React.Dispatch<React.SetStateAction<SearchViewExpansionState>>) => {
12
- onChange: import("react").ChangeEventHandler<HTMLInputElement>;
13
- onClick: import("react").MouseEventHandler<HTMLInputElement>;
14
- onBlur: FocusEventHandler<HTMLInputElement>;
15
- };
@@ -1,32 +0,0 @@
1
- /// <reference types="lodash" />
2
- import { Dispatch, SetStateAction } from 'react';
3
- import { OpenFin } from '@openfin/core';
4
- import { SearchViewExpansionState } from '../../../../browser/src/components/ControlBar/LeftControlsContainer/EnterpriseNavigationContainer/AddressBar/AddressBar';
5
- export declare let lastViewEvent: {
6
- viewIdentity: OpenFin.Identity;
7
- type: 'view-focused' | 'tab-created';
8
- };
9
- /**
10
- * This function enables the following behaviors:
11
- * - When a new view tab is created via the new tab button that is on the landing page, the adress input will focus.
12
- * - When a user clicks on an inactive view tab that is on the landing page, the address input will focus.
13
- * - When a user clicks on an active view tab is on the landing page while the address input bar is focused, the view will focus.
14
- */
15
- export declare const debouncedHandleAddressFocusOnLandingPage: import("lodash").DebouncedFunc<({ viewIdentity, type }: typeof lastViewEvent) => Promise<boolean>>;
16
- /**
17
- * This function enables the following behaviors:
18
- * - When a user re-organizes a view tab on the landing page in a layout, the address input will focus.
19
- * - When a user drags a page tab that is on the landing page into a layout, the address input will focus.
20
- * - When a user drags out a view or page tab on the landing page to create a new window, the address input will focus (from 'tab-created' event).
21
- */
22
- export declare const resetLastFocusedViewAndHandleViewFocused: (event: typeof lastViewEvent) => Promise<boolean>;
23
- /**
24
- * Custom hook that responds to updates to view expansion state updates, handles view focus events, and controls
25
- * focus on the address input.
26
- *
27
- * @param {SearchViewExpansionState} shouldExpandMenu - Object with boolean indicating if the search results view should expand and the method of expansion.
28
- * @param {OpenFin.View} addressSearchResultsView - View object corresponding to the search results view.
29
- * @param {Dispatch<SetStateAction<number>>} setAddressBarWidth - Function that updates the width in pixels of the address input bar in its expanded state.
30
- * @param {Dispatch<SetStateAction<SearchViewExpansionState>>} setShouldExpandMenu - Function that updates whether the menu should expand and the method of expansion.
31
- */
32
- export declare const useUpdateViewExpansionState: (shouldExpandMenu: SearchViewExpansionState, addressSearchResultsView: OpenFin.View, setAddressBarWidth: Dispatch<SetStateAction<number>>, setShouldExpandMenu: Dispatch<SetStateAction<SearchViewExpansionState>>) => void;
@@ -1,4 +0,0 @@
1
- import type OpenFin from '@openfin/core';
2
- export declare const processHotKeys: (e: OpenFin.Events.ViewEvents.HotkeyEvent, isOsWindows: boolean, viewId?: OpenFin.Identity) => void;
3
- declare const useEnterpriseHotkeys: (viewId?: OpenFin.Identity) => void;
4
- export default useEnterpriseHotkeys;
@@ -1,4 +0,0 @@
1
- import { PanelConfigVertical, PanelPosition } from '../../../common/src/api/pages/shapes';
2
- export type CSSBounds = Partial<Record<'top' | 'right' | 'bottom' | 'left' | 'height' | 'width', string>>;
3
- export declare const BookmarksPanelConfig: PanelConfigVertical;
4
- export declare const usePanelBounds: (panelPosition: PanelPosition | 'Center') => Partial<Record<"top" | "left" | "height" | "width" | "bottom" | "right", string>>;
@@ -1,2 +0,0 @@
1
- export declare const useIsPageSingleView: (pageId: string) => boolean;
2
- export declare const useIsActivePageSingleView: () => boolean;
@@ -1,17 +0,0 @@
1
- /// <reference types="react" />
2
- type WindowState = 'focused' | 'view-focused' | 'blurred';
3
- /**
4
- * Creates a context which exposes information about the specified window's state
5
- */
6
- export declare const WindowStateProvider: (props: {
7
- children: React.ReactNode;
8
- }) => JSX.Element;
9
- /**
10
- * Tracks the window's current state.
11
- */
12
- export declare const useWindowState: () => WindowState;
13
- /**
14
- * Tracks whether the window or any view within it is focused.
15
- */
16
- declare const useWindowFocusState: () => boolean;
17
- export default useWindowFocusState;
@@ -1,28 +0,0 @@
1
- import { PayloadAction } from '@reduxjs/toolkit';
2
- import { Menu, UserMenuParams } from '../../../common/src/utils/menu';
3
- export interface SystemMenuParams {
4
- parentName: string;
5
- }
6
- export type CompleteMenuParams<M extends Menu> = UserMenuParams[M] & SystemMenuParams;
7
- interface ActiveState<M extends Menu = Menu> {
8
- type: M | null;
9
- params: UserMenuParams[M] | null;
10
- }
11
- export interface InitialState {
12
- active: ActiveState;
13
- }
14
- export interface MenusRootState {
15
- menu: InitialState;
16
- }
17
- export declare const menuSlice: import("@reduxjs/toolkit").Slice<InitialState, {
18
- openMenu: (state: import("immer/dist/internal").WritableDraft<InitialState>, action: PayloadAction<ActiveState>) => void;
19
- closeActiveMenu: (state: import("immer/dist/internal").WritableDraft<InitialState>) => void;
20
- }, "menu">;
21
- export declare const openMenu: <M extends Menu = Menu>(menu: M, params: UserMenuParams[M]) => {
22
- payload: ActiveState<Menu>;
23
- type: string;
24
- };
25
- export declare const closeActiveMenu: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<string>;
26
- export declare const selectActiveMenu: (state: MenusRootState) => ActiveState;
27
- declare const _default: import("redux").Reducer<InitialState>;
28
- export default _default;
@@ -1,10 +0,0 @@
1
- export interface ClosePageRequestPayload {
2
- pageId: string;
3
- closeType?: 'page' | 'view';
4
- }
5
- export declare const handleClosePageRequest: import("@reduxjs/toolkit").AsyncThunk<void, ClosePageRequestPayload, {}>;
6
- export declare const closeBrowserWindow: () => Promise<void>;
7
- /**
8
- * Show the close window modal
9
- */
10
- export declare const handleCloseWindowRequest: import("@reduxjs/toolkit").AsyncThunk<void, void, {}>;
@@ -1,8 +0,0 @@
1
- export interface PagesModalRootState {
2
- modal: {
3
- isModalOpen: boolean;
4
- };
5
- }
6
- export declare const modalSlice: import("@reduxjs/toolkit").Slice<{}, {}, "modal">;
7
- declare const _default: import("redux").Reducer<{}>;
8
- export default _default;
@@ -1,83 +0,0 @@
1
- import type { AttachedPageInternal } from '../../../../common/src/api/pages/shapes';
2
- export interface AttachedPagesRootState {
3
- attachedPages: {
4
- activePageIndex: number;
5
- attachedPages: AttachedPageInternal[];
6
- isDetachingPages: boolean;
7
- isActivePageChanging: boolean;
8
- isInitialized: boolean;
9
- };
10
- }
11
- interface Action<P> {
12
- type: string;
13
- payload: P;
14
- }
15
- interface UpdatePageAtIndexPayload {
16
- index: number;
17
- page: Partial<AttachedPageInternal>;
18
- }
19
- /**
20
- * The source of truth for the current Browser window's attached page state.
21
- */
22
- export declare const attachedPagesSlice: import("@reduxjs/toolkit").Slice<{
23
- activePageIndex: number;
24
- attachedPages: AttachedPageInternal[];
25
- isDetachingPages: boolean;
26
- isActivePageChanging: boolean;
27
- isInitialized: boolean;
28
- }, {
29
- setPages: (state: import("immer/dist/internal").WritableDraft<{
30
- activePageIndex: number;
31
- attachedPages: AttachedPageInternal[];
32
- isDetachingPages: boolean;
33
- isActivePageChanging: boolean;
34
- isInitialized: boolean;
35
- }>, action: Action<AttachedPageInternal[]>) => void;
36
- updatePageAtIndex: (state: import("immer/dist/internal").WritableDraft<{
37
- activePageIndex: number;
38
- attachedPages: AttachedPageInternal[];
39
- isDetachingPages: boolean;
40
- isActivePageChanging: boolean;
41
- isInitialized: boolean;
42
- }>, action: Action<UpdatePageAtIndexPayload>) => void;
43
- setIsDetachingPages: (state: import("immer/dist/internal").WritableDraft<{
44
- activePageIndex: number;
45
- attachedPages: AttachedPageInternal[];
46
- isDetachingPages: boolean;
47
- isActivePageChanging: boolean;
48
- isInitialized: boolean;
49
- }>, action: Action<boolean>) => void;
50
- setIsActivePageChanging: (state: import("immer/dist/internal").WritableDraft<{
51
- activePageIndex: number;
52
- attachedPages: AttachedPageInternal[];
53
- isDetachingPages: boolean;
54
- isActivePageChanging: boolean;
55
- isInitialized: boolean;
56
- }>, action: Action<boolean>) => void;
57
- setIsInitialized: (state: import("immer/dist/internal").WritableDraft<{
58
- activePageIndex: number;
59
- attachedPages: AttachedPageInternal[];
60
- isDetachingPages: boolean;
61
- isActivePageChanging: boolean;
62
- isInitialized: boolean;
63
- }>, action: Action<boolean>) => void;
64
- }, "attached-pages">;
65
- export declare const setPages: import("@reduxjs/toolkit").ActionCreatorWithOptionalPayload<AttachedPageInternal[], string>, updatePageAtIndex: import("@reduxjs/toolkit").ActionCreatorWithOptionalPayload<UpdatePageAtIndexPayload, string>, setIsActivePageChanging: import("@reduxjs/toolkit").ActionCreatorWithOptionalPayload<boolean, string>, setIsDetachingPages: import("@reduxjs/toolkit").ActionCreatorWithOptionalPayload<boolean, string>, setIsInitialized: import("@reduxjs/toolkit").ActionCreatorWithOptionalPayload<boolean, string>;
66
- export declare const selectActivePage: (state: AttachedPagesRootState) => AttachedPageInternal;
67
- export declare const selectActivePageWithIndex: (state: AttachedPagesRootState) => [AttachedPageInternal, number];
68
- export declare const selectPage: (state: AttachedPagesRootState, pageId: string) => AttachedPageInternal;
69
- export declare const selectPageByLayoutContainerKey: (state: AttachedPagesRootState, layoutContainerKey: string) => AttachedPageInternal;
70
- export declare const selectPageAtIndex: (state: AttachedPagesRootState, index: number) => AttachedPageInternal;
71
- export declare const selectPageWithIndex: (state: AttachedPagesRootState, pageId: string) => [AttachedPageInternal, number];
72
- export declare const selectPages: (state: AttachedPagesRootState) => AttachedPageInternal[];
73
- export declare const selectIsDetachingPages: (state: AttachedPagesRootState) => boolean;
74
- export declare const selectIsActivePageChanging: (state: AttachedPagesRootState) => boolean;
75
- export declare const selectIsInitialized: (state: AttachedPagesRootState) => boolean;
76
- declare const _default: import("redux").Reducer<{
77
- activePageIndex: number;
78
- attachedPages: AttachedPageInternal[];
79
- isDetachingPages: boolean;
80
- isActivePageChanging: boolean;
81
- isInitialized: boolean;
82
- }>;
83
- export default _default;
@@ -1,85 +0,0 @@
1
- import { PayloadAction } from '@reduxjs/toolkit';
2
- import type OpenFin from '@openfin/core';
3
- import { BrowserRootState } from '../../../browser/src/store';
4
- export interface TabFocusRootState {
5
- tabFocus: {
6
- showAllContextGroups: boolean;
7
- layoutsWithSelectedViews: Record<string, OpenFin.Identity[]>;
8
- };
9
- }
10
- export declare const tabFocusSlice: import("@reduxjs/toolkit").Slice<{
11
- showAllContextGroups: boolean;
12
- layoutsWithSelectedViews: Record<string, OpenFin.Identity[]>;
13
- }, {
14
- /**
15
- * Select a single view
16
- */
17
- selectViewReducer: (state: import("immer/dist/internal").WritableDraft<{
18
- showAllContextGroups: boolean;
19
- layoutsWithSelectedViews: Record<string, OpenFin.Identity[]>;
20
- }>, action: PayloadAction<{
21
- viewId: OpenFin.Identity;
22
- layoutContainerKey: string;
23
- }>) => void;
24
- /**
25
- * Add a view to the list of currently selected views (multi-select);
26
- */
27
- addSelectedViewReducer: (state: import("immer/dist/internal").WritableDraft<{
28
- showAllContextGroups: boolean;
29
- layoutsWithSelectedViews: Record<string, OpenFin.Identity[]>;
30
- }>, action: PayloadAction<{
31
- viewId: OpenFin.Identity;
32
- layoutContainerKey: string;
33
- }>) => void;
34
- /**
35
- * Clears selected view from a specified page
36
- */
37
- clearSelectedViewsReducer: (state: import("immer/dist/internal").WritableDraft<{
38
- showAllContextGroups: boolean;
39
- layoutsWithSelectedViews: Record<string, OpenFin.Identity[]>;
40
- }>, action: PayloadAction<{
41
- layoutContainerKey: string;
42
- }>) => void;
43
- /**
44
- * Delete entry for pageId from pagesWithSelectedViews
45
- */
46
- deletePageWithSelectedViewsReducer: (state: import("immer/dist/internal").WritableDraft<{
47
- showAllContextGroups: boolean;
48
- layoutsWithSelectedViews: Record<string, OpenFin.Identity[]>;
49
- }>, action: PayloadAction<string>) => void;
50
- toggleContextGroupOutlines: (state: import("immer/dist/internal").WritableDraft<{
51
- showAllContextGroups: boolean;
52
- layoutsWithSelectedViews: Record<string, OpenFin.Identity[]>;
53
- }>) => void;
54
- }, "tab-focus">;
55
- export declare const selectView: import("@reduxjs/toolkit").AsyncThunk<void, {
56
- viewId: OpenFin.Identity;
57
- pageId: string;
58
- }, {}>;
59
- export declare const selectViewForLayoutContainerKey: import("@reduxjs/toolkit").AsyncThunk<void, {
60
- viewId: OpenFin.Identity;
61
- layoutContainerKey: string;
62
- }, {}>;
63
- export declare const addSelectedView: import("@reduxjs/toolkit").AsyncThunk<void, {
64
- viewId: OpenFin.Identity;
65
- pageId: string;
66
- }, {}>;
67
- export declare const clearSelectedViews: import("@reduxjs/toolkit").AsyncThunk<void, {
68
- pageId: string;
69
- }, {}>;
70
- export declare const deletePageWithSelectedViews: import("@reduxjs/toolkit").AsyncThunk<void, string, {}>;
71
- export declare const toggleContextGroupOutlines: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<string>, selectViewReducer: import("@reduxjs/toolkit").ActionCreatorWithOptionalPayload<{
72
- viewId: OpenFin.Identity;
73
- layoutContainerKey: string;
74
- }, string>;
75
- export declare const selectShowAllContextGroups: (state: TabFocusRootState) => boolean;
76
- export declare const selectSelectedViewsForPage: (state: BrowserRootState, pageId: string) => OpenFin.Identity[];
77
- export declare const selectSelectedViewsForLayoutContainerKey: (layoutContainerKey: string) => (state: BrowserRootState) => OpenFin.Identity[];
78
- export declare const selectLayoutsWithSelectedViews: (state: TabFocusRootState) => Record<string, OpenFin.Identity[]>;
79
- export declare const selectFirstViewNameForLayoutContainerKey: (layoutContainerKey: string) => (state: BrowserRootState) => string;
80
- export declare const selectFirstViewIdForLayoutContainerKey: (layoutContainerKey: string) => (state: BrowserRootState) => string;
81
- declare const _default: import("redux").Reducer<{
82
- showAllContextGroups: boolean;
83
- layoutsWithSelectedViews: Record<string, OpenFin.Identity[]>;
84
- }>;
85
- export default _default;
@@ -1,90 +0,0 @@
1
- /**
2
- * Redux store for a Browser Window.
3
- */
4
- declare const store: import("@reduxjs/toolkit").EnhancedStore<{
5
- environment: {
6
- isWindows: boolean;
7
- };
8
- modal: {};
9
- attachedPages: {
10
- activePageIndex: number;
11
- attachedPages: import("../../../common/src/api/pages/shapes").AttachedPageInternal[];
12
- isDetachingPages: boolean;
13
- isActivePageChanging: boolean;
14
- isInitialized: boolean;
15
- };
16
- tabFocus: {
17
- showAllContextGroups: boolean;
18
- layoutsWithSelectedViews: Record<string, {
19
- uuid: string;
20
- name: string;
21
- }[]>;
22
- };
23
- menu: import("@browser/slices/menu").InitialState;
24
- targetTheming: {
25
- isFetchingTheme: boolean;
26
- currentTheme: import("../../../common/src/api/theming").ComputedTheme;
27
- hasTriedFetch: boolean;
28
- currentScheme: import("@client-platform/shapes").ColorSchemeOptionType; /**
29
- * Redux store for a Browser Window.
30
- */
31
- };
32
- }, import("redux").AnyAction, [import("redux-thunk").ThunkMiddleware<{
33
- environment: {
34
- isWindows: boolean;
35
- };
36
- modal: {};
37
- attachedPages: {
38
- activePageIndex: number;
39
- attachedPages: import("../../../common/src/api/pages/shapes").AttachedPageInternal[];
40
- isDetachingPages: boolean;
41
- isActivePageChanging: boolean;
42
- isInitialized: boolean;
43
- };
44
- tabFocus: {
45
- showAllContextGroups: boolean;
46
- layoutsWithSelectedViews: Record<string, {
47
- uuid: string;
48
- name: string;
49
- }[]>;
50
- };
51
- menu: import("@browser/slices/menu").InitialState;
52
- targetTheming: {
53
- isFetchingTheme: boolean;
54
- currentTheme: import("../../../common/src/api/theming").ComputedTheme;
55
- hasTriedFetch: boolean;
56
- currentScheme: import("@client-platform/shapes").ColorSchemeOptionType; /**
57
- * Redux store for a Browser Window.
58
- */
59
- };
60
- }, import("redux").AnyAction, null> | import("redux-thunk").ThunkMiddleware<{
61
- environment: {
62
- isWindows: boolean;
63
- };
64
- modal: {};
65
- attachedPages: {
66
- activePageIndex: number;
67
- attachedPages: import("../../../common/src/api/pages/shapes").AttachedPageInternal[];
68
- isDetachingPages: boolean;
69
- isActivePageChanging: boolean;
70
- isInitialized: boolean;
71
- };
72
- tabFocus: {
73
- showAllContextGroups: boolean;
74
- layoutsWithSelectedViews: Record<string, {
75
- uuid: string;
76
- name: string;
77
- }[]>;
78
- };
79
- menu: import("@browser/slices/menu").InitialState;
80
- targetTheming: {
81
- isFetchingTheme: boolean;
82
- currentTheme: import("../../../common/src/api/theming").ComputedTheme;
83
- hasTriedFetch: boolean;
84
- currentScheme: import("@client-platform/shapes").ColorSchemeOptionType; /**
85
- * Redux store for a Browser Window.
86
- */
87
- };
88
- }, import("redux").AnyAction>]>;
89
- export default store;
90
- export type BrowserRootState = ReturnType<typeof store.getState>;
@@ -1,5 +0,0 @@
1
- import { PageLayout } from '../../../../common/src/api/pages/shapes';
2
- export type EnterprisePageRequiredLayoutSettings = {
3
- newTabButtonUrl: string;
4
- };
5
- export declare const applyEnterprisePageRequiredLayoutSettings: (requiredSettings: EnterprisePageRequiredLayoutSettings, layout: PageLayout) => void;
@@ -1,8 +0,0 @@
1
- import { CopyPagePayload, HandleSaveModalOnPageClosePayload, Page, SaveModalOnPageCloseResult, ShouldPageClosePayload, ShouldPageCloseResult } from '../../../../common/src/api/pages/shapes';
2
- import { shouldWindowClose } from '../../../../client-api-platform/src/api/pages';
3
- import { HandlePageChangesPayload, ModifiedPageState } from '../../../../client-api-platform/src/shapes';
4
- export declare const requestPageSaveModalDecision: (req: HandleSaveModalOnPageClosePayload) => Promise<SaveModalOnPageCloseResult>;
5
- export declare const requestShouldPageClose: (req: ShouldPageClosePayload) => Promise<ShouldPageCloseResult>;
6
- export declare const requestShouldWindowClose: (payload: Parameters<typeof shouldWindowClose>[0]) => ReturnType<typeof shouldWindowClose>;
7
- export declare const copyPage: (req: CopyPagePayload) => Promise<Page>;
8
- export declare const requestPageChangesDecision: (req: HandlePageChangesPayload) => Promise<ModifiedPageState>;
@@ -1,49 +0,0 @@
1
- import { NavigatePayload } from '../../../common/src/utils/navigate';
2
- import { ProviderConnectionPayload, ProviderDisconnectionPayload, ProviderUpdatePayload } from './provider';
3
- /**
4
- * All Workspace related events that can be emitted or listened to
5
- * by the Workspace Provider or any of the workspace components
6
- */
7
- type EventTypeTypes = {
8
- /**
9
- * Emitted when a search is invoked.
10
- */
11
- 'search-invoked': [string];
12
- /**
13
- * Emitted when a new provider is connected.
14
- *
15
- * For example, when a Dock Provider is successfully registered by the platform provider
16
- */
17
- 'provider-connected': [ProviderConnectionPayload];
18
- /**
19
- * Emitted when a provider is disconnected.
20
- *
21
- * For example, when a Dock Provider is deregistered by the platform provider
22
- */
23
- 'provider-disconnected': [ProviderDisconnectionPayload];
24
- /**
25
- * Emitted when a provider is updated.
26
- *
27
- * For example, when a Dock Provider is updated by the platform provider
28
- */
29
- 'provider-updated': [ProviderUpdatePayload];
30
- /**
31
- * Emmitted when notifications is created or destroyed.
32
- */
33
- 'update-notification-running-status': [];
34
- /**
35
- * Emitted when the list of search providers has been updated.
36
- */
37
- 'search-provider-list-updated': [];
38
- /**
39
- * Emmitted when a component is created or destroyed.
40
- */
41
- 'component-lifecycle-update': [];
42
- /**
43
- * Emitted when component should be navigated to.
44
- * Contains the target provider ID and the component name.
45
- */
46
- 'component-navigation': [NavigatePayload];
47
- };
48
- export declare const addListener: <EventKey extends keyof EventTypeTypes>(event: EventKey, listener: (...payload: EventTypeTypes[EventKey]) => void) => void, removeListener: <EventKey extends keyof EventTypeTypes>(event: EventKey, listener: (...payload: EventTypeTypes[EventKey]) => void) => void, addListenerWithUUID: (uuid: string) => <EventKey extends keyof EventTypeTypes>(event: EventKey, listener: (...payload: EventTypeTypes[EventKey]) => void) => void, emit: <EventKey extends keyof EventTypeTypes>(event: EventKey, ...payload: EventTypeTypes[EventKey]) => Promise<void>;
49
- export {};
@@ -1,53 +0,0 @@
1
- import React from 'react';
2
- import { SizeType } from '@openfin/ui-library';
3
- export interface BaseButtonProps extends React.HTMLAttributes<HTMLButtonElement> {
4
- /**
5
- * Icon to be shown for the control.
6
- *
7
- * Accepts base64, url, or variables in CSS format.
8
- */
9
- icon?: string;
10
- /**
11
- * Title to be applied as a `title` attribute on the button.
12
- */
13
- title?: string;
14
- /**
15
- * whether the button title property should be in title case
16
- * @default true
17
- */
18
- withTitleCase?: boolean;
19
- /**
20
- * Additional CSS classes to be applied to the button.
21
- *
22
- * This can be useful when a unique style needs to be applied, for example, in a close button.
23
- */
24
- className?: string;
25
- /** When the button is disabled, it cannot be clicked and mouseover does not have an effect */
26
- disabled?: boolean;
27
- /** Button selected state. Can be used to implement sticky buttons. */
28
- selected?: boolean;
29
- /** Disable hover/active background-color change */
30
- hoverless?: boolean;
31
- /** If not set, svgs in the button will be forced to 13px */
32
- customContentSize?: boolean;
33
- /** Border radius of the button. If not set defaults to 0px */
34
- borderRadius?: SizeType;
35
- /**
36
- * The `onClick` handler for when the button is closed.
37
- *
38
- * It is up to the implementor to properly handle the event as they see fit.
39
- */
40
- onClick?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void;
41
- children: React.ReactNode | React.ReactNode[];
42
- width?: number;
43
- height?: number;
44
- isEnterprise?: boolean;
45
- }
46
- /**
47
- * Provides a basic browser title bar navigation button look and feel.
48
- * Ensure the title is printed in “Title Case”.
49
- *
50
- * Note: This relies on global CSS and is written to run within the context of the Browser window which contains these globals.
51
- */
52
- declare const BaseButton: React.ForwardRefExoticComponent<BaseButtonProps & React.RefAttributes<HTMLButtonElement>>;
53
- export default BaseButton;
@@ -1,4 +0,0 @@
1
- /// <reference types="react" />
2
- import { BaseButtonProps } from '../BaseButton/BaseButton';
3
- declare const CloseButtonLarge: (props: Omit<BaseButtonProps, 'children'>) => JSX.Element;
4
- export default CloseButtonLarge;
@@ -1,15 +0,0 @@
1
- import React from 'react';
2
- import { IconSizeType } from '@openfin/ui-library';
3
- /**
4
- * Simple and reusable icon component. The required prop is an iconURL.
5
- */
6
- interface CustomIconProps {
7
- iconURL?: string;
8
- testId?: string;
9
- size?: IconSizeType;
10
- description?: string;
11
- backgroundColor?: string;
12
- applyThemeColor?: boolean;
13
- }
14
- export declare const CustomIcon: React.FC<CustomIconProps>;
15
- export {};
@@ -1,58 +0,0 @@
1
- import { Dispatch, SetStateAction } from 'react';
2
- import { ProviderInfoInternal, ProviderType } from '../../../common/src/api/provider';
3
- export type ProviderContext<T extends ProviderType = any> = {
4
- /**
5
- * The currently active provider.
6
- */
7
- activeProvider: ProviderInfoInternal<T> | undefined;
8
- /**
9
- * Sets the active provider.
10
- * @param provider The provider to set as active.
11
- */
12
- setActiveProvider: (provider: ProviderInfoInternal<T>) => void;
13
- /**
14
- * All providers currently available.
15
- */
16
- providers: ProviderInfoInternal<T>[];
17
- /**
18
- * Updates a provider.
19
- * Dispatches a channel action back to the Workspace Provider.
20
- *
21
- * @param updatedProvider The updated provider.
22
- * @returns A promise that resolves when the provider has been updated.
23
- */
24
- updateProvider: (updatedProvider: ProviderInfoInternal<T>) => Promise<void>;
25
- };
26
- /**
27
- * A hook that returns data related to the active provider, and all providers
28
- *
29
- * A generic **must** be provided to specify the type of provider to return
30
- *
31
- * @example
32
- * ```ts
33
- * const { activeProvider, setActiveProvider, providers } = usePlatformProviders<'dock'>();
34
- * ```
35
- */
36
- export declare const usePlatformProviders: <T extends ProviderType = never>() => T extends never ? never : ProviderContext<T>;
37
- export declare const ProviderContext: <T extends ProviderType>({ children, providerType }: {
38
- children?: React.ReactNode;
39
- providerType: T;
40
- }) => JSX.Element;
41
- export declare const BrowserTypeContext: import("react").Context<{
42
- isEnterprise?: boolean | null;
43
- }>;
44
- export declare const BrowserLayoutDragContext: import("react").Context<{
45
- isAcceptingLayoutDrag: boolean;
46
- setIsAcceptingLayoutDrag: (value: boolean) => void;
47
- }>;
48
- export declare const BrowserContext: ({ children }: {
49
- children?: React.ReactNode;
50
- }) => JSX.Element;
51
- export declare const BookmarksContext: import("react").Context<{
52
- mostRecentlyUpdated: number;
53
- isBookmarksPanelOpen: boolean;
54
- setIsBookmarksPanelOpen: Dispatch<SetStateAction<boolean>>;
55
- }>;
56
- export declare const BookmarksContextProvider: ({ children }: {
57
- children?: React.ReactNode;
58
- }) => JSX.Element;
@@ -1,7 +0,0 @@
1
- import { MutableRefObject } from 'react';
2
- import OpenFin from '@openfin/core';
3
- export declare const useAddEditBookmarkDialog: (bookmarkIconRef: MutableRefObject<HTMLElement | null>, selectedView?: OpenFin.View) => {
4
- showDialog: () => Promise<void>;
5
- isDialogShown: boolean;
6
- isBookmarkUpdatedOrCreated: boolean;
7
- };
@@ -1,6 +0,0 @@
1
- import type OpenFin from '@openfin/core';
2
- /**
3
- * Set the current theme based on the platform identity provided.
4
- * @param identity the platform identity.
5
- */
6
- export declare const usePlatformTheme: (identity?: OpenFin.Identity) => void;
@@ -1,13 +0,0 @@
1
- import type OpenFin from '@openfin/core';
2
- interface PreloadedWindowOptions {
3
- windowName: string;
4
- route: string;
5
- width?: number;
6
- height?: number;
7
- windowType?: string;
8
- shouldPreload: boolean;
9
- }
10
- export default function usePreloadedWindow({ windowName, route, width, height, windowType, shouldPreload }: PreloadedWindowOptions & {
11
- shouldPreload?: boolean;
12
- }): OpenFin.Window;
13
- export {};