@finsemble/finsemble-ui 1.0.0-beta-5 → 1.0.0-beta-9

package/react/components/userPreferences/stores/UserPreferencesStore.d.ts

@@ -0,0 +1,40 @@
+import { ScheduledDayTimeObjectType } from "../UserPreferenceTypes";
+import { StandardCallback } from "../../../../types";
+import { StoreModel } from "../../../../clients/StoreModel";
+declare let UserPreferencesStore: StoreModel;
+declare let WorkspaceManagementMenuStore: StoreModel;
+declare const Actions: {
+    initialize: () => void;
+    getWorkspaces(cb?: Function): void;
+    /**
+     * By making the value of `finsemble.scheduledRestart` falsy, the application will remove any existing restart timers.
+     * @deprecated use `setScheduledRestart(false)` instead.
+     */
+    disableScheduledRestart: () => void;
+    /**
+     *  Finsemble listens for this piece of config. When it changes, it will schedule a daily restart at that time.
+     *  By making the value of `finsemble.scheduledRestart` falsy, the application will remove any existing restart timers.
+     *  @deprecated use setScheduledClose
+     */
+    setScheduledRestart: (val: ScheduledDayTimeObjectType | false) => void;
+    /**
+     *  Finsemble listens the config set by this function. When it changes, it will schedule a daily restart/shutdown at
+     *  that time. By making the value falsy, the application will remove any existing restart/shutdown timers.
+     *
+     */
+    setScheduledClose: (key: "finsemble.scheduledRestart" | "finsemble.scheduledShutdown", value: ScheduledDayTimeObjectType | false) => void;
+    /**
+     * Allows download settings to persist after restart.
+     * Saves an object containing the choosen location and a list of the last
+     * three (or less) choosen locations to show in the dropdown
+     */
+    setDownloads: (key: "finsemble.downloads", value: string) => void;
+    setDiscardUnsavedChangesPreference: (value: boolean) => void;
+    getPreferences: (callback: StandardCallback) => void;
+};
+/**
+ * Initializes the store for the User Preferences Menu.
+ */
+declare function initialize(WorkspaceMngMenuStore: StoreModel, cb: (store: StoreModel) => void): void;
+export { WorkspaceManagementMenuStore, initialize, UserPreferencesStore, Actions };
+//# sourceMappingURL=UserPreferencesStore.d.ts.map

package/react/components/userPreferences/stores/UserPreferencesStore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UserPreferencesStore.d.ts","sourceRoot":"","sources":["../../../../../../src/ui/components/userPreferences/stores/UserPreferencesStore.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,wBAAwB,CAAC;AACpE,OAAO,EAAiB,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAGpE,OAAO,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAY5D,QAAA,IAAI,oBAAoB,EAAE,UAAU,CAAC;AACrC,QAAA,IAAI,4BAA4B,EAAE,UAAU,CAAC;AAI7C,QAAA,MAAM,OAAO;;;IA8DZ;;;OAGG;;IAYH;;;;OAIG;+BACwB,0BAA0B,GAAG,KAAK;IAO7D;;;;OAIG;6BAEG,4BAA4B,GAAG,6BAA6B,SAC1D,0BAA0B,GAAG,KAAK;IAQ1C;;;;OAIG;wBACiB,qBAAqB,SAAS,MAAM;gDAOZ,OAAO;+BAOxB,gBAAgB;CAG3C,CAAC;AAoBF;;GAEG;AACH,iBAAS,UAAU,CAAC,qBAAqB,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,QAMrF;AAED,OAAO,EAAE,4BAA4B,EAAE,UAAU,EAAE,oBAAoB,EAAE,OAAO,EAAE,CAAC"}

package/react/components/userPreferences/stores/UserPreferencesStore.js

@@ -0,0 +1,141 @@
+import { FEAGlobals } from "../../../../common/Globals";
+let UserPreferencesStore;
+let WorkspaceManagementMenuStore;
+let updateConstants;
+const Actions = {
+    initialize: function () {
+        FEAGlobals.FSBL.Clients.WorkspaceClient.getWorkspaceActions((err, constants) => {
+            if (constants)
+                updateConstants = constants;
+        });
+        // Gets the workspace list and sets the value in the store.
+        FEAGlobals.FSBL.Clients.WorkspaceClient.getWorkspaces(async (err, workspaces) => {
+            if (workspaces) {
+                await UserPreferencesStore.set(["WorkspaceList"], workspaces);
+            }
+        });
+        // Get the activeWorkspace and set the value.
+        FEAGlobals.FSBL.Clients.WorkspaceClient.getActiveWorkspace(async (err, activeWorkspace) => {
+            if (activeWorkspace) {
+                await UserPreferencesStore.set(["activeWorkspace"], activeWorkspace);
+            }
+        });
+        /**
+         * We listen here for any workspace updates, and pass them to the store.
+         * **NOTE**: You may notice that the signature of this callback is different from the previous ones. In this case we receive a `response`, instead of `workspaces` or `activeWorkspace`. This is because this callback is for a `RouterClient` message. The functions above are callbacks to `WorkspaceClient` API calls.
+         */
+        FEAGlobals.FSBL.Clients.RouterClient.subscribe("Finsemble.WorkspaceService.update", async (err, response) => {
+            if (response.data && response.data.activeWorkspace) {
+                await UserPreferencesStore.set(["activeWorkspace"], response.data.activeWorkspace);
+                if (updateConstants) {
+                    switch (response.data.reason) {
+                        case updateConstants.GET_ACTIVE_WORKSPACE:
+                        case updateConstants.NEW_WORKSPACE:
+                        case updateConstants.IMPORT:
+                        case updateConstants.SAVE:
+                        case updateConstants.SAVE_AS:
+                        case updateConstants.REMOVE:
+                        case updateConstants.SWITCH_TO:
+                        case updateConstants.SET_WORKSPACE_ORDER:
+                        case updateConstants.ADD_WINDOW:
+                        case updateConstants.REMOVE_WINDOW:
+                        case updateConstants.RENAME:
+                            Actions.getWorkspaces();
+                            break;
+                        default:
+                            break;
+                    }
+                }
+            }
+        });
+    },
+    getWorkspaces(cb = Function.prototype) {
+        // Gets the workspace list and sets the value in the store.
+        FEAGlobals.FSBL.Clients.WorkspaceClient.getWorkspaces(async (err, workspaces) => {
+            await UserPreferencesStore.set(["WorkspaceList"], workspaces);
+            cb();
+        });
+    },
+    /**
+     * By making the value of `finsemble.scheduledRestart` falsy, the application will remove any existing restart timers.
+     * @deprecated use `setScheduledRestart(false)` instead.
+     */
+    disableScheduledRestart: () => {
+        FEAGlobals.FSBL.Clients.ConfigClient.setPreference({
+            field: "finsemble.scheduledRestart",
+            value: false,
+        });
+        FEAGlobals.FSBL.Clients.ConfigClient.setPreference({
+            field: "finsemble.scheduledCloseDiscardUnsavedChanges",
+            value: false,
+        });
+    },
+    /**
+     *  Finsemble listens for this piece of config. When it changes, it will schedule a daily restart at that time.
+     *  By making the value of `finsemble.scheduledRestart` falsy, the application will remove any existing restart timers.
+     *  @deprecated use setScheduledClose
+     */
+    setScheduledRestart: (val) => {
+        FEAGlobals.FSBL.Clients.ConfigClient.setPreference({
+            field: "finsemble.scheduledRestart",
+            value: val,
+        });
+    },
+    /**
+     *  Finsemble listens the config set by this function. When it changes, it will schedule a daily restart/shutdown at
+     *  that time. By making the value falsy, the application will remove any existing restart/shutdown timers.
+     *
+     */
+    setScheduledClose: (key, value) => {
+        FEAGlobals.FSBL.Clients.ConfigClient.setPreference({
+            field: key,
+            value: value,
+        });
+    },
+    /**
+     * Allows download settings to persist after restart.
+     * Saves an object containing the choosen location and a list of the last
+     * three (or less) choosen locations to show in the dropdown
+     */
+    setDownloads: (key, value) => {
+        FEAGlobals.FSBL.Clients.ConfigClient.setPreference({
+            field: key,
+            value: value,
+        });
+    },
+    setDiscardUnsavedChangesPreference: (value) => {
+        FEAGlobals.FSBL.Clients.ConfigClient.setPreference({
+            field: "finsemble.scheduledCloseDiscardUnsavedChanges",
+            value: value,
+        });
+    },
+    getPreferences: (callback) => {
+        FEAGlobals.FSBL.Clients.ConfigClient.getPreferences(callback);
+    },
+};
+async function createLocalStore(done) {
+    // While the order of these two functions is unimportant, they cannot be done in series as we don't want
+    // to call the callback until both stores have been initiated. This keeps the initialization function
+    // executing until both stores either have values, or fail to initialize.
+    FEAGlobals.FSBL.Clients.DistributedStoreClient.createStore({ store: "Finsemble-UserPreferences-Local-Store" }, (preferencesErr, preferencesStore) => {
+        if (preferencesErr) {
+            FEAGlobals.FSBL.Clients.Logger.system.error("Error fetching user preferences data: ", preferencesErr);
+        }
+        if (preferencesStore) {
+            UserPreferencesStore = preferencesStore;
+        }
+        done();
+    });
+}
+/**
+ * Initializes the store for the User Preferences Menu.
+ */
+function initialize(WorkspaceMngMenuStore, cb) {
+    WorkspaceManagementMenuStore = WorkspaceMngMenuStore;
+    createLocalStore(() => {
+        Actions.initialize();
+        cb(UserPreferencesStore);
+    });
+}
+export { WorkspaceManagementMenuStore, initialize, UserPreferencesStore, Actions };
+//# sourceMappingURL=UserPreferencesStore.js.map

package/react/components/userPreferences/stores/UserPreferencesStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UserPreferencesStore.js","sourceRoot":"","sources":["../../../../../../src/ui/components/userPreferences/stores/UserPreferencesStore.tsx"],"names":[],"mappings":"AAKA,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAWxD,IAAI,oBAAgC,CAAC;AACrC,IAAI,4BAAwC,CAAC;AAE7C,IAAI,eAA8B,CAAC;AAEnC,MAAM,OAAO,GAAG;IACf,UAAU,EAAE;QACX,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,mBAAmB,CAAC,CAAC,GAAG,EAAE,SAAS,EAAE,EAAE;YAC9E,IAAI,SAAS;gBAAE,eAAe,GAAG,SAA0B,CAAC;QAC7D,CAAC,CAAC,CAAC;QAEH,2DAA2D;QAC3D,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,aAAa,CAAC,KAAK,EAAE,GAAkB,EAAE,UAA4B,EAAE,EAAE;YAChH,IAAI,UAAU,EAAE;gBACf,MAAM,oBAAoB,CAAC,GAAG,CAAC,CAAC,eAAe,CAAC,EAAE,UAAU,CAAC,CAAC;aAC9D;QACF,CAAC,CAAC,CAAC;QAEH,6CAA6C;QAC7C,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,kBAAkB,CACzD,KAAK,EAAE,GAAkB,EAAE,eAAyC,EAAE,EAAE;YACvE,IAAI,eAAe,EAAE;gBACpB,MAAM,oBAAoB,CAAC,GAAG,CAAC,CAAC,iBAAiB,CAAC,EAAE,eAAe,CAAC,CAAC;aACrE;QACF,CAAC,CACD,CAAC;QAEF;;;WAGG;QACH,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAC7C,mCAAmC,EACnC,KAAK,EAAE,GAAkB,EAAE,QAA4B,EAAE,EAAE;YAC1D,IAAI,QAAQ,CAAC,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAC,eAAe,EAAE;gBACnD,MAAM,oBAAoB,CAAC,GAAG,CAAC,CAAC,iBAAiB,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;gBAEnF,IAAI,eAAe,EAAE;oBACpB,QAAQ,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE;wBAC7B,KAAK,eAAe,CAAC,oBAAoB,CAAC;wBAC1C,KAAK,eAAe,CAAC,aAAa,CAAC;wBACnC,KAAK,eAAe,CAAC,MAAM,CAAC;wBAC5B,KAAK,eAAe,CAAC,IAAI,CAAC;wBAC1B,KAAK,eAAe,CAAC,OAAO,CAAC;wBAC7B,KAAK,eAAe,CAAC,MAAM,CAAC;wBAC5B,KAAK,eAAe,CAAC,SAAS,CAAC;wBAC/B,KAAK,eAAe,CAAC,mBAAmB,CAAC;wBACzC,KAAK,eAAe,CAAC,UAAU,CAAC;wBAChC,KAAK,eAAe,CAAC,aAAa,CAAC;wBACnC,KAAK,eAAe,CAAC,MAAM;4BAC1B,OAAO,CAAC,aAAa,EAAE,CAAC;4BACxB,MAAM;wBACP;4BACC,MAAM;qBACP;iBACD;aACD;QACF,CAAC,CACD,CAAC;IACH,CAAC;IACD,aAAa,CAAC,EAAE,GAAG,QAAQ,CAAC,SAAS;QACpC,2DAA2D;QAC3D,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,aAAa,CAAC,KAAK,EAAE,GAAkB,EAAE,UAA2B,EAAE,EAAE;YAC/G,MAAM,oBAAoB,CAAC,GAAG,CAAC,CAAC,eAAe,CAAC,EAAE,UAAU,CAAC,CAAC;YAC9D,EAAE,EAAE,CAAC;QACN,CAAC,CAAC,CAAC;IACJ,CAAC;IACD;;;OAGG;IACH,uBAAuB,EAAE,GAAG,EAAE;QAC7B,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,aAAa,CAAC;YAClD,KAAK,EAAE,4BAA4B;YACnC,KAAK,EAAE,KAAK;SACZ,CAAC,CAAC;QAEH,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,aAAa,CAAC;YAClD,KAAK,EAAE,+CAA+C;YACtD,KAAK,EAAE,KAAK;SACZ,CAAC,CAAC;IACJ,CAAC;IACD;;;;OAIG;IACH,mBAAmB,EAAE,CAAC,GAAuC,EAAE,EAAE;QAChE,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,aAAa,CAAC;YAClD,KAAK,EAAE,4BAA4B;YACnC,KAAK,EAAE,GAAG;SACV,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,iBAAiB,EAAE,CAClB,GAAiE,EACjE,KAAyC,EACxC,EAAE;QACH,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,aAAa,CAAC;YAClD,KAAK,EAAE,GAAG;YACV,KAAK,EAAE,KAAK;SACZ,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,YAAY,EAAE,CAAC,GAA0B,EAAE,KAAa,EAAE,EAAE;QAC3D,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,aAAa,CAAC;YAClD,KAAK,EAAE,GAAG;YACV,KAAK,EAAE,KAAK;SACZ,CAAC,CAAC;IACJ,CAAC;IAED,kCAAkC,EAAE,CAAC,KAAc,EAAE,EAAE;QACtD,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,aAAa,CAAC;YAClD,KAAK,EAAE,+CAA+C;YACtD,KAAK,EAAE,KAAK;SACZ,CAAC,CAAC;IACJ,CAAC;IAED,cAAc,EAAE,CAAC,QAA0B,EAAE,EAAE;QAC9C,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IAC/D,CAAC;CACD,CAAC;AAEF,KAAK,UAAU,gBAAgB,CAAC,IAAgB;IAC/C,wGAAwG;IACxG,qGAAqG;IACrG,yEAAyE;IACzE,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,WAAW,CACzD,EAAE,KAAK,EAAE,uCAAuC,EAAE,EAClD,CAAC,cAA6B,EAAE,gBAAwC,EAAE,EAAE;QAC3E,IAAI,cAAc,EAAE;YACnB,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,wCAAwC,EAAE,cAAc,CAAC,CAAC;SACtG;QACD,IAAI,gBAAgB,EAAE;YACrB,oBAAoB,GAAG,gBAAgB,CAAC;SACxC;QACD,IAAI,EAAE,CAAC;IACR,CAAC,CACD,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAS,UAAU,CAAC,qBAAiC,EAAE,EAA+B;IACrF,4BAA4B,GAAG,qBAAqB,CAAC;IACrD,gBAAgB,CAAC,GAAG,EAAE;QACrB,OAAO,CAAC,UAAU,EAAE,CAAC;QACrB,EAAE,CAAC,oBAAoB,CAAC,CAAC;IAC1B,CAAC,CAAC,CAAC;AACJ,CAAC;AAED,OAAO,EAAE,4BAA4B,EAAE,UAAU,EAAE,oBAAoB,EAAE,OAAO,EAAE,CAAC"}

package/react/components/windowTitleBar/WindowTitleBarShell.d.ts

@@ -0,0 +1,275 @@
+/*!
+ * Copyright 2017 by ChartIQ, Inc.
+ * All rights reserved.
+ */
+import * as React from "react";
+import { StandardError, StoreModel } from "../../../types";
+import { TabProperties } from "../../types/windowTitleBar";
+declare type BumpElements = {
+    bumpBy: string;
+    fixed: string;
+    absolute: string;
+    monitorFixedAdditions: boolean;
+};
+interface WindowTitleBarShellProps {
+}
+interface WindowTitleBarShellState {
+    tabs: TabProperties[];
+    activeTab: TabProperties;
+    windowTitle: string;
+    initialized: boolean;
+    alwaysOnTop: boolean;
+    showTabs: boolean;
+    minButton: boolean;
+    maxButton: boolean;
+    closeButton: boolean;
+    showShareButton: boolean;
+    showLinkerButton: boolean;
+    isTopRight: boolean;
+    dockingEnabled: boolean;
+    alwaysOnTopButton: boolean;
+    allowDragOnCenterRegion: boolean;
+    dockingIcon: string;
+    hackScrollbar: boolean;
+    showDockingTooltip: boolean;
+    showTabRegion: boolean;
+    tabBarBoundingBox: any;
+    useDOMBasedMovement: boolean;
+    dragHandleName: string;
+    bumpElements: BumpElements;
+    adjustContentHeights: boolean;
+}
+export declare class WindowTitleBarShell extends React.Component<WindowTitleBarShellProps, WindowTitleBarShellState> {
+    store?: StoreModel;
+    isMousePressed: boolean;
+    dragMutationObserver?: MutationObserver;
+    dragResizeObserver?: ResizeObserver;
+    constructor(props: WindowTitleBarShellProps);
+    alwaysOnTopListener({ data: { alwaysOnTop } }: any): void;
+    /**
+     * This is necessary to make sure that the `this` inside of the callback is correct.
+     *
+     * @memberof WindowTitleBar
+     */
+    bindCorrectContext(): void;
+    onInitialized(): void;
+    onStoreChange(): Promise<void>;
+    componentDidMount(): void;
+    componentDidUpdate(): void;
+    componentWillUnmount(): void;
+    setDOMBasedMovement(err: StandardError, response: any): void;
+    /**
+     * When we are not tiling/tabbing, we want to allow the user to drag the window around via any available space in the tab-region. This function allows that.
+     */
+    allowDragOnCenterRegion(): void;
+    /**
+     * When we are tiling/tabbing, we do not want to allow any window to be dragged around and moved.
+     */
+    disallowDragOnCenterRegion(): void;
+    /**
+     * When tiling start, we want to find the dragHandler and hide it
+     */
+    onTilingStart(): void;
+    /**
+     * When tiling stops, we want to find the dragHandler and re-show it
+     */
+    onTilingStop(): void;
+    /**
+     * Called whenever a tab is dropped on a non tab area.
+     * It won't be called when dropped on a tab that handles handle the event.
+     */
+    onDropHandler(): void;
+    /**
+     * Called when user double clicks on drag handle
+     */
+    onDoubleClick(): void;
+    _setOnMouseUpAndDownHandlers(element: HTMLDivElement): void;
+    makeDragHandle(fsblHeader: Element, dragHandleCssClass: string): HTMLElement;
+    dragHandleBoundsForShowTabs(startingBounds: DOMRect): DOMRect;
+    /**
+     * The dragger is an absolutely positioned element that is superimposed on the actual area that we'd like to drag.
+     * This is necessary due to a bug in Chromium. Effectively, we need the dragger to change its left position and width
+     * to match the intended drag area. These dimensions can change whenever the header is re-rendered (for instance when
+     * changing mode from tabbing to non-tabbing). Dimensions can also change when the window itself is resized (due to natural
+     * css).
+     *
+     * Can remove all of the cq-drag and cq-no-drag because Chromium bug is fixed
+     * Remove fsbl-drag-region, it is no longer needed
+     * Hide the dragHandle during drop operations, so that it doesn't interfere
+     */
+    resizeDragHandle(): void;
+    /**
+     * Whether the component's config allows for the linker.
+     * @param {} err
+     * @param {*} response
+     */
+    showLinkerButton(err: StandardError, response: any): void;
+    /**
+     * Whether the window is the top-right-most window in a group of windows. If so, it renders a minimize icon for the whole group.
+     * @param {} err
+     * @param {*} response
+     */
+    isTopRight(err: StandardError, response: any): void;
+    /**
+     * @param {*} err
+     * @param {*} response
+     */
+    onTitleChange(err: StandardError, response: any): void;
+    /**
+     * The next few methods are store change handlers that sync local state with the store's state.
+     */
+    onShowDockingToolTip(err: StandardError, response: any): void;
+    onToggleDockingIcon(err: StandardError, response: any): void;
+    onDockingEnabledChanged(err: StandardError, response: any): void;
+    onAlwaysOnTopChanged(err: StandardError, response: any): void;
+    onStoreChanged(newState: WindowTitleBarShellState): void;
+    onShareEmitterChanged(err: StandardError, response: any): void;
+    onTabsChanged(err: StandardError, response: any): void;
+    onShowTabsChanged(err: StandardError, response: any): void;
+    hackScrollbar(): void;
+    /**
+     * Once document is ready and header is injected into DOM, begin adjusting the height of elements and bump fixed/absolute elements
+     */
+    maybeAdjustWindow(): Promise<void>;
+    /**
+     * Begin adjusting the body and top level elements and their direct descendants by the header height.
+     */
+    beginAdjustment(): void;
+    /**
+     * Togglable setting found in `foreign.components.["Window Manager"].FSBLHeader.adjustContentHeights`
+     * Called from beginAdjustment()
+     *
+     * Adjusts the top level content max-height to be 100% subtracted by the total height of the previous elements.
+     * The height of the previous elements are added to this calculation if they are not fixed or absolute.
+     * These top level elements will be passed into adjustContentHeight where their descendants
+     * will also have their heights adjusted.
+     *
+     * Absolute and Fixed positions elements, however, will just have their max-heights set to 100% subtracted by the header height
+     * since they are not part of the document flow.
+     * Example:
+     * In this below situation, the B element extends passed the view because the header is injected. B doesn't have a
+     * set height so it'll extend as far as it needs.
+     * --------------------
+     * |******************|
+     * |*     Titlebar   *|
+     * |******************|
+     * |******************|
+     * |*       A        *|
+     * |*                *|
+     * |******************|
+     * |******************|
+     * |*                *|
+     * |*                *|
+     * |*       B        *|
+     * |*                *|
+     * |*                *|
+     * |*                *|
+     * --------------------
+     * The chain of adjust functions will set the maxHeight of A and B to ensure they both occupy space that the above element doesn't
+     * and keep it within the bounds of the view.
+     * --------------------
+     * |******************|
+     * |*     Titlebar   *|
+     * |******************|
+     * |******************|
+     * |*       A        *|
+     * |*                *|
+     * |******************|
+     * |******************|
+     * |*                *|
+     * |*                *|
+     * |*       B        *|
+     * |*                *|
+     * |*                *|
+     * |******************|
+     * --------------------
+     * @param {number} headerHeight the height of the header
+     */
+    private adjustTopLevelHeight;
+    /**
+     * Adjusts the content view height to be maximum of the parent container (passed in by adjustTopLevelHeight()) height
+     * subtracted by the total height of elements above it. The height of the previous elements are added to this calculation
+     * if they are not fixed or absolute.
+     * @param {object} parentElem parent element
+     * @param {number} headerHeight the height of the header
+     */
+    private adjustContentHeight;
+    /**
+     * This is used in adjustTopLevelHeight() and adjustContentHeight()
+     *
+     * Set the max height of each element to be the height of the parent container
+     * subtracted by the height of the previous element. This forces the element to either obey its
+     * predefined height or stay within the bounds of the max height.
+     *
+     * @param {object} elem HTML element
+     * @param {number} prevHeight height of previous sibling
+     * @param {string} maxElemHeight maximum height of the element
+     * @param {number} headerHeight the height of the header
+     */
+    private adjust;
+    /**
+     * Togglable setting found in `foreign.components.["Window Manager"].FSBLHeader.bumpElements.[bumpBy|fixed|absolute]`
+     * Called from beginAdjustment()
+     *
+     * Calls bumpFixedElements and bumpAbsoluteElements to bump fixed and/or absolute elements by the value of bumpBy if configured to do so.
+     * Since absolute and fixed positioned elements are removed from the document flow their positions will not be adjusted when the titlebar
+     * is injected and they have a set top style. However, if the element is an absolute positioned element and it's
+     * parent container has a position that is not set to static, then it'll adjust relative to the parent. Fixed positioned elements, on the otherhand,
+     * won't adjust unless their top stlyes are changed.
+     * @param {object} config bumpElements object
+     */
+    bumpElements(config: BumpElements): void;
+    /**
+     * Called from bumpElements
+     *
+     * Bumps all elements with fixed positioning, that are not in the header, down by the configured amount.
+     * @private
+     * @param {object} params bumpElements object
+     */
+    private bumpFixedElements;
+    /**
+     * Called from bumpElements
+     *
+     * Bumps all absolute positioned elements with static parents, that are not in the header, down by the configured amount.
+     * @private
+     * @param {object} params bumpElements object
+     */
+    private bumpAbsoluteElements;
+    /**
+     * Used in bumpFixedElements and bumpAbsoluteElements
+     * Calculates value to bump element by. If 'all' return top style plus the header height, if '0Positioned' return just header height
+     * @param type Whether all elements are being bumped by the header height and their top style or just header height
+     * @param topStyle Element top value
+     * @param bumpBy Value to bump element by
+     * @returns Top style for element
+     */
+    private calculateBumpValue;
+    /**
+     * Used in bumpAbsoluteElements
+     *
+     * Recursively traverse through the HTML document and return an array of the top level elements
+     * and elements with static parents
+     * @param {object} element The HTML element
+     * @param {array} acc accumulator
+     * @returns {array} array top level elements and elements with static parents
+     *
+     */
+    private traverseHtml;
+    /**
+     * Togglable setting found in `foreign.components.["Window Manager"].FSBLHeader.bumpElements.[monitorFixedAdditions]`
+     * Called from beginAdjustment()
+     *
+     * Monitors the DOM for mutations, if the added node has a fixed position with a top style of 0px, it will be bumped by the title bar height.
+     * This ensures that if a fixed positioned element is dynamically added to the DOM, for example a pop-up modal, it'll have it's height adjusted
+     * by the header height since the initial bumping of elements can happen before this element exists.
+     *
+     * Element heights are not monitored and adjusted since this would require that all pre-existing elements have ther height recalculated each time
+     * a new element is dynamically added onto the page. Absolute postioned elements, however, could be monitored and adjusted since all we would
+     * need to check for is that it's parent has a static position or not, if it does then it can be adjusted.
+     * @param headerHeight the height of the header
+     */
+    monitorFixedPositionedElements(headerHeight: string): void;
+    render(): JSX.Element;
+}
+export {};
+//# sourceMappingURL=WindowTitleBarShell.d.ts.map

package/react/components/windowTitleBar/WindowTitleBarShell.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WindowTitleBarShell.d.ts","sourceRoot":"","sources":["../../../../../src/ui/components/windowTitleBar/WindowTitleBarShell.tsx"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAI/B,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAsB3D,aAAK,YAAY,GAAG;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,qBAAqB,EAAE,OAAO,CAAC;CAC/B,CAAC;AAEF,UAAU,wBAAwB;CAAG;AAErC,UAAU,wBAAwB;IACjC,IAAI,EAAE,aAAa,EAAE,CAAC;IACtB,SAAS,EAAE,aAAa,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,OAAO,CAAC;IACrB,WAAW,EAAE,OAAO,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,EAAE,OAAO,CAAC;IACrB,eAAe,EAAE,OAAO,CAAC;IACzB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,UAAU,EAAE,OAAO,CAAC;IACpB,cAAc,EAAE,OAAO,CAAC;IACxB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,uBAAuB,EAAE,OAAO,CAAC;IACjC,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,OAAO,CAAC;IACvB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,aAAa,EAAE,OAAO,CAAC;IACvB,iBAAiB,EAAE,GAAG,CAAC;IACvB,mBAAmB,EAAE,OAAO,CAAC;IAC7B,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE,YAAY,CAAC;IAC3B,oBAAoB,EAAE,OAAO,CAAC;CAC9B;AAED,qBAAa,mBAAoB,SAAQ,KAAK,CAAC,SAAS,CAAC,wBAAwB,EAAE,wBAAwB,CAAC;IAC3G,KAAK,CAAC,EAAE,UAAU,CAAC;IAGnB,cAAc,UAAS;IAGvB,oBAAoB,CAAC,EAAE,gBAAgB,CAAC;IAExC,kBAAkB,CAAC,EAAE,cAAc,CAAC;gBAExB,KAAK,EAAE,wBAAwB;IA4C3C,mBAAmB,CAAC,EAAE,IAAI,EAAE,EAAE,WAAW,EAAE,EAAE,EAAE,GAAG;IAIlD;;;;OAIG;IACH,kBAAkB;IAuBlB,aAAa;IA4CP,aAAa;IAoCnB,iBAAiB;IAuBjB,kBAAkB;IA0BlB,oBAAoB;IAoDpB,mBAAmB,CAAC,GAAG,EAAE,aAAa,EAAE,QAAQ,EAAE,GAAG;IASrD;;OAEG;IACH,uBAAuB;IAMvB;;OAEG;IACH,0BAA0B;IAM1B;;OAEG;IACH,aAAa;IAIb;;OAEG;IACH,YAAY;IAIZ;;;OAGG;IACH,aAAa;IAIb;;OAEG;IACH,aAAa;IAMb,4BAA4B,CAAC,OAAO,EAAE,cAAc;IAsDpD,cAAc,CAAC,UAAU,EAAE,OAAO,EAAE,kBAAkB,EAAE,MAAM,GAAG,WAAW;IAa5E,2BAA2B,CAAC,cAAc,EAAE,OAAO,GAAG,OAAO;IA2E7D;;;;;;;;;;OAUG;IACH,gBAAgB;IAiEhB;;;;OAIG;IACH,gBAAgB,CAAC,GAAG,EAAE,aAAa,EAAE,QAAQ,EAAE,GAAG;IAIlD;;;;OAIG;IACH,UAAU,CAAC,GAAG,EAAE,aAAa,EAAE,QAAQ,EAAE,GAAG;IAI5C;;;OAGG;IACH,aAAa,CAAC,GAAG,EAAE,aAAa,EAAE,QAAQ,EAAE,GAAG;IAuB/C;;OAEG;IACH,oBAAoB,CAAC,GAAG,EAAE,aAAa,EAAE,QAAQ,EAAE,GAAG;IAItD,mBAAmB,CAAC,GAAG,EAAE,aAAa,EAAE,QAAQ,EAAE,GAAG;IAIrD,uBAAuB,CAAC,GAAG,EAAE,aAAa,EAAE,QAAQ,EAAE,GAAG;IAIzD,oBAAoB,CAAC,GAAG,EAAE,aAAa,EAAE,QAAQ,EAAE,GAAG;IAItD,cAAc,CAAC,QAAQ,EAAE,wBAAwB;IAIjD,qBAAqB,CAAC,GAAG,EAAE,aAAa,EAAE,QAAQ,EAAE,GAAG;IAIvD,aAAa,CAAC,GAAG,EAAE,aAAa,EAAE,QAAQ,EAAE,GAAG;IAM/C,iBAAiB,CAAC,GAAG,EAAE,aAAa,EAAE,QAAQ,EAAE,GAAG;IAuBnD,aAAa;IASb;;OAEG;IACG,iBAAiB;IAWvB;;OAEG;IACH,eAAe;IAmBf;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiDG;IACH,OAAO,CAAC,oBAAoB;IAmB5B;;;;;;OAMG;IACH,OAAO,CAAC,mBAAmB;IAa3B;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,MAAM;IAiBd;;;;;;;;;;OAUG;IACH,YAAY,CAAC,MAAM,EAAE,YAAY;IAOjC;;;;;;OAMG;IACH,OAAO,CAAC,iBAAiB;IA6BzB;;;;;;OAMG;IACH,OAAO,CAAC,oBAAoB;IAqB5B;;;;;;;OAOG;IACH,OAAO,CAAC,kBAAkB;IAU1B;;;;;;;;;OASG;IACH,OAAO,CAAC,YAAY;IAkBpB;;;;;;;;;;;;OAYG;IACH,8BAA8B,CAAC,YAAY,EAAE,MAAM;IAmCnD,MAAM;CA2CN"}