@finsemble/finsemble-ui 8.3.0-beta.8 → 8.3.1

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

@@ -1,275 +1,17 @@
-/*!
- * 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;
+import React from "react";
+export declare const getStore: () => import("@reduxjs/toolkit").EnhancedStore<any, import("redux").AnyAction, [import("redux-thunk").ThunkMiddleware<any, import("redux").AnyAction, undefined>], import("redux").StoreEnhancer<{
+    dispatch: import("../../../common/redux/types").PromiseDispatch;
+}, {}>[]>;
+declare type Props = {
+    children?: React.ReactNode;
+    enableKeyboardNavigation?: 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 declare const WindowTitleBarContents: (props: Props) => JSX.Element;
+/**
+ *
+ * @param props.enableKeyboardNavigation - Set to false to disable keyboard navigation
+ * @returns
+ */
+export declare const WindowTitleBarShell: (props: Props) => JSX.Element;
 export {};
 //# sourceMappingURL=WindowTitleBarShell.d.ts.map

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

@@ -1 +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"}
+{"version":3,"file":"WindowTitleBarShell.d.ts","sourceRoot":"","sources":["../../../../../src/ui/components/windowTitleBar/WindowTitleBarShell.tsx"],"names":[],"mappings":"AAAA,OAAO,KAA8B,MAAM,OAAO,CAAC;AAYnD,eAAO,MAAM,QAAQ;;SACyF,CAAC;AAE/G,aAAK,KAAK,GAAG;IACZ,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,wBAAwB,CAAC,EAAE,OAAO,CAAC;CACnC,CAAC;AAEF,eAAO,MAAM,sBAAsB,UAAW,KAAK,gBA2BlD,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,UAAW,KAAK,gBAK/C,CAAC"}