flexlayout-react 0.7.14 → 0.8.0

package/declarations/model/LayoutWindow.d.ts

@@ -0,0 +1,28 @@
+import { Rect } from "../Rect";
+import { IJsonPopout } from "./IJsonModel";
+import { Model } from "./Model";
+import { RowNode } from "./RowNode";
+import { Node } from "./Node";
+import { TabSetNode } from "./TabSetNode";
+import { LayoutInternal } from "../view/Layout";
+export declare class LayoutWindow {
+    private _windowId;
+    private _layout;
+    private _rect;
+    private _window?;
+    private _root?;
+    private _maximizedTabSet?;
+    private _activeTabSet?;
+    private _toScreenRectFunction;
+    constructor(windowId: string, rect: Rect);
+    visitNodes(fn: (node: Node, level: number) => void): void;
+    get windowId(): string;
+    get rect(): Rect;
+    get layout(): LayoutInternal | undefined;
+    get window(): Window | undefined;
+    get root(): RowNode | undefined;
+    get maximizedTabSet(): TabSetNode | undefined;
+    get activeTabSet(): TabSetNode | undefined;
+    toJson(): IJsonPopout;
+    static fromJson(windowJson: IJsonPopout, model: Model, windowId: string): LayoutWindow;
+}

package/declarations/model/Model.d.ts

@@ -1,86 +1,91 @@
-import { DropInfo } from "../DropInfo";
-import { Action } from "./Action";
-import { BorderSet } from "./BorderSet";
-import { IJsonModel, ITabSetAttributes } from "./IJsonModel";
-import { Node } from "./Node";
-import { RowNode } from "./RowNode";
-import { TabNode } from "./TabNode";
-import { TabSetNode } from "./TabSetNode";
-/**
- * Class containing the Tree of Nodes used by the FlexLayout component
- */
-export declare class Model {
-    /**
-     * Loads the model from the given json object
-     * @param json the json model to load
-     * @returns {Model} a new Model object
-     */
-    static fromJson(json: IJsonModel): Model;
-    /**
-     * Get the currently active tabset node
-     */
-    getActiveTabset(): TabSetNode | undefined;
-    /**
-     * Get the currently maximized tabset node
-     */
-    getMaximizedTabset(): TabSetNode | undefined;
-    /**
-     * Gets the root RowNode of the model
-     * @returns {RowNode}
-     */
-    getRoot(): RowNode;
-    isRootOrientationVertical(): boolean;
-    isUseVisibility(): boolean;
-    isEnableRotateBorderIcons(): boolean;
-    /**
-     * Gets the
-     * @returns {BorderSet|*}
-     */
-    getBorderSet(): BorderSet;
-    /**
-     * Visits all the nodes in the model and calls the given function for each
-     * @param fn a function that takes visited node and a integer level as parameters
-     */
-    visitNodes(fn: (node: Node, level: number) => void): void;
-    /**
-     * Gets a node by its id
-     * @param id the id to find
-     */
-    getNodeById(id: string): Node | undefined;
-    /**
-     * Finds the first/top left tab set of the given node.
-     * @param node The top node you want to begin searching from, deafults to the root node
-     * @returns The first Tab Set
-     */
-    getFirstTabSet(node?: Node): Node;
-    /**
-     * Update the node tree by performing the given action,
-     * Actions should be generated via static methods on the Actions class
-     * @param action the action to perform
-     * @returns added Node for Actions.addNode; undefined otherwise
-     */
-    doAction(action: Action): Node | undefined;
-    /**
-     * Converts the model to a json object
-     * @returns {IJsonModel} json object that represents this model
-     */
-    toJson(): IJsonModel;
-    getSplitterSize(): number;
-    isLegacyOverflowMenu(): boolean;
-    getSplitterExtra(): number;
-    isEnableEdgeDock(): boolean;
-    /**
-     * Sets a function to allow/deny dropping a node
-     * @param onAllowDrop function that takes the drag node and DropInfo and returns true if the drop is allowed
-     */
-    setOnAllowDrop(onAllowDrop: (dragNode: Node, dropInfo: DropInfo) => boolean): void;
-    /**
-     * set callback called when a new TabSet is created.
-     * The tabNode can be undefined if it's the auto created first tabset in the root row (when the last
-     * tab is deleted, the root tabset can be recreated)
-     * @param onCreateTabSet
-     */
-    setOnCreateTabSet(onCreateTabSet: (tabNode?: TabNode) => ITabSetAttributes): void;
-    static toTypescriptInterfaces(): void;
-    toString(): string;
-}
+import { DropInfo } from "../DropInfo";
+import { Action } from "./Action";
+import { BorderSet } from "./BorderSet";
+import { IJsonModel, ITabSetAttributes } from "./IJsonModel";
+import { Node } from "./Node";
+import { RowNode } from "./RowNode";
+import { TabNode } from "./TabNode";
+import { TabSetNode } from "./TabSetNode";
+import { LayoutWindow } from "./LayoutWindow";
+/**
+ * Class containing the Tree of Nodes used by the FlexLayout component
+ */
+export declare class Model {
+    static MAIN_WINDOW_ID: string;
+    /**
+     * Update the node tree by performing the given action,
+     * Actions should be generated via static methods on the Actions class
+     * @param action the action to perform
+     * @returns added Node for Actions.addNode, windowId for createWindow
+     */
+    doAction(action: Action): any;
+    /**
+     * Get the currently active tabset node
+     */
+    getActiveTabset(windowId?: string): TabSetNode | undefined;
+    /**
+     * Get the currently maximized tabset node
+     */
+    getMaximizedTabset(windowId?: string): TabSetNode | undefined;
+    /**
+     * Gets the root RowNode of the model
+     * @returns {RowNode}
+     */
+    getRoot(windowId?: string): RowNode;
+    isRootOrientationVertical(): boolean;
+    isEnableRotateBorderIcons(): boolean;
+    /**
+     * Gets the
+     * @returns {BorderSet|*}
+     */
+    getBorderSet(): BorderSet;
+    getwindowsMap(): Map<string, LayoutWindow>;
+    /**
+     * Visits all the nodes in the model and calls the given function for each
+     * @param fn a function that takes visited node and a integer level as parameters
+     */
+    visitNodes(fn: (node: Node, level: number) => void): void;
+    visitWindowNodes(windowId: string, fn: (node: Node, level: number) => void): void;
+    /**
+     * Gets a node by its id
+     * @param id the id to find
+     */
+    getNodeById(id: string): Node | undefined;
+    /**
+     * Finds the first/top left tab set of the given node.
+     * @param node The top node you want to begin searching from, deafults to the root node
+     * @returns The first Tab Set
+     */
+    getFirstTabSet(node?: Node): TabSetNode;
+    /**
+ * Loads the model from the given json object
+ * @param json the json model to load
+ * @returns {Model} a new Model object
+ */
+    static fromJson(json: IJsonModel): Model;
+    /**
+     * Converts the model to a json object
+     * @returns {IJsonModel} json object that represents this model
+     */
+    toJson(): IJsonModel;
+    getSplitterSize(): number;
+    getSplitterExtra(): number;
+    isEnableEdgeDock(): boolean;
+    isSplitterEnableHandle(): boolean;
+    /**
+     * Sets a function to allow/deny dropping a node
+     * @param onAllowDrop function that takes the drag node and DropInfo and returns true if the drop is allowed
+     */
+    setOnAllowDrop(onAllowDrop: (dragNode: Node, dropInfo: DropInfo) => boolean): void;
+    /**
+     * set callback called when a new TabSet is created.
+     * The tabNode can be undefined if it's the auto created first tabset in the root row (when the last
+     * tab is deleted, the root tabset can be recreated)
+     * @param onCreateTabSet
+     */
+    setOnCreateTabSet(onCreateTabSet: (tabNode?: TabNode) => ITabSetAttributes): void;
+    addChangeListener(listener: ((action: Action) => void)): void;
+    removeChangeListener(listener: ((action: Action) => void)): void;
+    toString(): string;
+    static toTypescriptInterfaces(): void;
+}

package/declarations/model/Node.d.ts

@@ -1,17 +1,17 @@
-import { Orientation } from "../Orientation";
-import { Rect } from "../Rect";
-import { IJsonBorderNode, IJsonRowNode, IJsonTabNode, IJsonTabSetNode } from "./IJsonModel";
-import { Model } from "./Model";
-export declare abstract class Node {
-    getId(): string;
-    getModel(): Model;
-    getType(): string;
-    getParent(): Node | undefined;
-    getChildren(): Node[];
-    getRect(): Rect;
-    isVisible(): boolean;
-    getOrientation(): Orientation;
-    setEventListener(event: string, callback: (params: any) => void): void;
-    removeEventListener(event: string): void;
-    abstract toJson(): IJsonRowNode | IJsonBorderNode | IJsonTabSetNode | IJsonTabNode | undefined;
-}
+import { Orientation } from "../Orientation";
+import { Rect } from "../Rect";
+import { IJsonBorderNode, IJsonRowNode, IJsonTabNode, IJsonTabSetNode } from "./IJsonModel";
+import { Model } from "./Model";
+export declare abstract class Node {
+    getId(): string;
+    getModel(): Model;
+    getType(): string;
+    getParent(): Node | undefined;
+    getChildren(): Node[];
+    getRect(): Rect;
+    getPath(): string;
+    getOrientation(): Orientation;
+    setEventListener(event: string, callback: (params: any) => void): void;
+    removeEventListener(event: string): void;
+    abstract toJson(): IJsonRowNode | IJsonBorderNode | IJsonTabSetNode | IJsonTabNode | undefined;
+}

package/declarations/model/RowNode.d.ts

@@ -1,11 +1,10 @@
-import { IDropTarget } from "./IDropTarget";
-import { IJsonRowNode } from "./IJsonModel";
-import { Node } from "./Node";
-export declare class RowNode extends Node implements IDropTarget {
-    static readonly TYPE = "row";
-    getWeight(): number;
-    getWidth(): number | undefined;
-    getHeight(): number | undefined;
-    toJson(): IJsonRowNode;
-    isEnableDrop(): boolean;
-}
+import { IDropTarget } from "./IDropTarget";
+import { IJsonRowNode } from "./IJsonModel";
+import { Node } from "./Node";
+export declare class RowNode extends Node implements IDropTarget {
+    static readonly TYPE = "row";
+    getWeight(): number;
+    toJson(): IJsonRowNode;
+    setWindowId(windowId: string): void;
+    normalizeWeights(): void;
+}

package/declarations/model/TabNode.d.ts

@@ -1,37 +1,44 @@
-import { Rect } from "../Rect";
-import { IDraggable } from "./IDraggable";
-import { IJsonTabNode } from "./IJsonModel";
-import { Node } from "./Node";
-export declare class TabNode extends Node implements IDraggable {
-    static readonly TYPE = "tab";
-    getWindow(): Window | undefined;
-    getTabRect(): Rect | undefined;
-    getName(): string;
-    getHelpText(): string | undefined;
-    getComponent(): string | undefined;
-    /**
-     * Returns the config attribute that can be used to store node specific data that
-     * WILL be saved to the json. The config attribute should be changed via the action Actions.updateNodeAttributes rather
-     * than directly, for example:
-     * this.state.model.doAction(
-     *   FlexLayout.Actions.updateNodeAttributes(node.getId(), {config:myConfigObject}));
-     */
-    getConfig(): any;
-    /**
-     * Returns an object that can be used to store transient node specific data that will
-     * NOT be saved in the json.
-     */
-    getExtraData(): Record<string, any>;
-    isFloating(): boolean;
-    getIcon(): string | undefined;
-    isEnableClose(): boolean;
-    getCloseType(): number;
-    isEnableFloat(): boolean;
-    isEnableDrag(): boolean;
-    isEnableRename(): boolean;
-    getClassName(): string | undefined;
-    getContentClassName(): string | undefined;
-    getTabSetClassName(): string | undefined;
-    isEnableRenderOnDemand(): boolean;
-    toJson(): IJsonTabNode;
-}
+import { IDraggable } from "./IDraggable";
+import { IJsonTabNode } from "./IJsonModel";
+import { Node } from "./Node";
+export declare class TabNode extends Node implements IDraggable {
+    static readonly TYPE = "tab";
+    getName(): string;
+    getHelpText(): string | undefined;
+    getComponent(): string | undefined;
+    getWindowId(): string;
+    getWindow(): Window | undefined;
+    /**
+     * Returns the config attribute that can be used to store node specific data that
+     * WILL be saved to the json. The config attribute should be changed via the action Actions.updateNodeAttributes rather
+     * than directly, for example:
+     * this.state.model.doAction(
+     *   FlexLayout.Actions.updateNodeAttributes(node.getId(), {config:myConfigObject}));
+     */
+    getConfig(): any;
+    /**
+     * Returns an object that can be used to store transient node specific data that will
+     * NOT be saved in the json.
+     */
+    getExtraData(): Record<string, any>;
+    isPoppedOut(): boolean;
+    isSelected(): boolean;
+    getIcon(): string | undefined;
+    isEnableClose(): boolean;
+    getCloseType(): number;
+    isEnablePopout(): boolean;
+    isEnablePopoutIcon(): boolean;
+    isEnablePopoutOverlay(): boolean;
+    isEnableDrag(): boolean;
+    isEnableRename(): boolean;
+    isEnableWindowReMount(): boolean;
+    getClassName(): string | undefined;
+    getContentClassName(): string | undefined;
+    getTabSetClassName(): string | undefined;
+    isEnableRenderOnDemand(): boolean;
+    getMinWidth(): number;
+    getMinHeight(): number;
+    getMaxWidth(): number;
+    getMaxHeight(): number;
+    toJson(): IJsonTabNode;
+}

package/declarations/model/TabSetNode.d.ts

@@ -1,41 +1,44 @@
-import { IDraggable } from "./IDraggable";
-import { IDropTarget } from "./IDropTarget";
-import { IJsonTabSetNode } from "./IJsonModel";
-import { Node } from "./Node";
-export declare class TabSetNode extends Node implements IDraggable, IDropTarget {
-    static readonly TYPE = "tabset";
-    getName(): string | undefined;
-    getSelected(): number;
-    getSelectedNode(): Node | undefined;
-    getWeight(): number;
-    getWidth(): number | undefined;
-    getMinWidth(): number;
-    getHeight(): number | undefined;
-    getMinHeight(): number;
-    /**
-     * Returns the config attribute that can be used to store node specific data that
-     * WILL be saved to the json. The config attribute should be changed via the action Actions.updateNodeAttributes rather
-     * than directly, for example:
-     * this.state.model.doAction(
-     *   FlexLayout.Actions.updateNodeAttributes(node.getId(), {config:myConfigObject}));
-     */
-    getConfig(): any;
-    isMaximized(): boolean;
-    isActive(): boolean;
-    isEnableDeleteWhenEmpty(): boolean;
-    isEnableDrop(): boolean;
-    isEnableDrag(): boolean;
-    isEnableDivide(): boolean;
-    isEnableMaximize(): boolean;
-    isEnableClose(): boolean;
-    isEnableSingleTabStretch(): boolean;
-    canMaximize(): boolean;
-    isEnableTabStrip(): boolean;
-    isAutoSelectTab(): boolean;
-    getClassNameTabStrip(): string | undefined;
-    getClassNameHeader(): string | undefined;
-    getHeaderHeight(): number;
-    getTabStripHeight(): number;
-    getTabLocation(): string;
-    toJson(): IJsonTabSetNode;
-}
+import { IDraggable } from "./IDraggable";
+import { IDropTarget } from "./IDropTarget";
+import { IJsonTabSetNode } from "./IJsonModel";
+import { Node } from "./Node";
+export declare class TabSetNode extends Node implements IDraggable, IDropTarget {
+    static readonly TYPE = "tabset";
+    getName(): string | undefined;
+    isEnableActiveIcon(): boolean;
+    getSelected(): number;
+    getSelectedNode(): Node | undefined;
+    getWeight(): number;
+    getAttrMinWidth(): number;
+    getAttrMinHeight(): number;
+    getMinWidth(): number;
+    getMinHeight(): number;
+    getAttrMaxWidth(): number;
+    getAttrMaxHeight(): number;
+    getMaxWidth(): number;
+    getMaxHeight(): number;
+    /**
+     * Returns the config attribute that can be used to store node specific data that
+     * WILL be saved to the json. The config attribute should be changed via the action Actions.updateNodeAttributes rather
+     * than directly, for example:
+     * this.state.model.doAction(
+     *   FlexLayout.Actions.updateNodeAttributes(node.getId(), {config:myConfigObject}));
+     */
+    getConfig(): any;
+    isMaximized(): boolean;
+    isActive(): boolean;
+    isEnableDeleteWhenEmpty(): boolean;
+    isEnableDrop(): boolean;
+    isEnableTabWrap(): boolean;
+    isEnableDrag(): boolean;
+    isEnableDivide(): boolean;
+    isEnableMaximize(): boolean;
+    isEnableClose(): boolean;
+    isEnableSingleTabStretch(): boolean;
+    isEnableTabStrip(): boolean;
+    isAutoSelectTab(): boolean;
+    getClassNameTabStrip(): string | undefined;
+    getTabLocation(): string;
+    toJson(): IJsonTabSetNode;
+    getWindowId(): string;
+}

package/declarations/model/Utils.d.ts

@@ -1 +1 @@
-export declare function randomUUID(): any;
+export declare function randomUUID(): string;

package/declarations/model/WindowLayout.d.ts

@@ -0,0 +1,24 @@
+import { Rect } from "../Rect";
+import { IJsonPopout } from "./IJsonModel";
+import { Model } from "./Model";
+import { RowNode } from "./RowNode";
+import { Node } from "./Node";
+import { TabSetNode } from "./TabSetNode";
+export declare class WindowLayout {
+    private _windowId;
+    private _rect;
+    private _window?;
+    private _root?;
+    private _maximizedTabSet?;
+    private _activeTabSet?;
+    constructor(windowId: string, rect: Rect);
+    visitNodes(fn: (node: Node, level: number) => void): void;
+    get windowId(): string;
+    get rect(): Rect;
+    get window(): Window | undefined;
+    get root(): RowNode | undefined;
+    get maximizedTabSet(): TabSetNode | undefined;
+    get activeTabSet(): TabSetNode | undefined;
+    toJson(): IJsonPopout;
+    static fromJson(windowJson: IJsonPopout, model: Model, windowId: string): WindowLayout;
+}

package/declarations/src/Attribute.d.ts

@@ -0,0 +1 @@
+export {};

package/declarations/src/AttributeDefinitions.d.ts

@@ -0,0 +1 @@
+export {};

package/declarations/src/DockLocation.d.ts

@@ -0,0 +1,12 @@
+import { Orientation } from "./Orientation";
+export declare class DockLocation {
+    static values: Map<string, DockLocation>;
+    static TOP: DockLocation;
+    static BOTTOM: DockLocation;
+    static LEFT: DockLocation;
+    static RIGHT: DockLocation;
+    static CENTER: DockLocation;
+    getName(): string;
+    getOrientation(): Orientation;
+    toString(): string;
+}

package/declarations/src/DropInfo.d.ts

@@ -0,0 +1,12 @@
+import { DockLocation } from "./DockLocation";
+import { IDropTarget } from "./model/IDropTarget";
+import { Node } from "./model/Node";
+import { Rect } from "./Rect";
+export declare class DropInfo {
+    node: Node & IDropTarget;
+    rect: Rect;
+    location: DockLocation;
+    index: number;
+    className: string;
+    constructor(node: Node & IDropTarget, rect: Rect, location: DockLocation, index: number, className: string);
+}

package/declarations/src/I18nLabel.d.ts

@@ -0,0 +1,10 @@
+export declare enum I18nLabel {
+    Close_Tab = "Close",
+    Close_Tabset = "Close tabset",
+    Move_Tabset = "Move tabset",
+    Maximize = "Maximize tabset",
+    Restore = "Restore tabset",
+    Popout_Tab = "Show selected tab in a floating window",
+    Overflow_Menu_Tooltip = "Hidden tabs",
+    Error_rendering_component = "Error rendering component"
+}

package/declarations/src/Orientation.d.ts

@@ -0,0 +1,7 @@
+export declare class Orientation {
+    static HORZ: Orientation;
+    static VERT: Orientation;
+    static flip(from: Orientation): Orientation;
+    getName(): string;
+    toString(): string;
+}

package/declarations/src/PopupMenu.d.ts

@@ -0,0 +1 @@
+export {};

package/declarations/src/Rect.d.ts

@@ -0,0 +1,31 @@
+export declare class Rect {
+    static empty(): Rect;
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    constructor(x: number, y: number, width: number, height: number);
+    static getBoundingClientRect(element: Element): Rect;
+    static getContentRect(element: HTMLDivElement): Rect;
+    static fromDomRect(domRect: DOMRect): Rect;
+    relativeTo(r: Rect | DOMRect): Rect;
+    clone(): Rect;
+    equals(rect: Rect | null | undefined): boolean;
+    getBottom(): number;
+    getRight(): number;
+    getCenter(): {
+        x: number;
+        y: number;
+    };
+    positionElement(element: HTMLElement, position?: string): void;
+    styleWithPosition(style: Record<string, any>, position?: string): Record<string, any>;
+    contains(x: number, y: number): boolean;
+    removeInsets(insets: {
+        top: number;
+        left: number;
+        bottom: number;
+        right: number;
+    }): Rect;
+    centerInRect(outerRect: Rect): void;
+    toString(): string;
+}