@aptre/flex-layout 0.1.9 → 0.2.0

package/declarations/model/IJsonModel.d.ts

@@ -1,145 +0,0 @@
-import { ICloseType } from "./ICloseType";
-export type IBorderLocation = "top" | "bottom" | "left" | "right";
-export type ITabLocation = "top" | "bottom";
-export type IInsets = {
-    top: number;
-    right: number;
-    bottom: number;
-    left: number;
-};
-export interface IJsonModel {
-    global?: IGlobalAttributes;
-    borders?: IJsonBorderNode[];
-    layout: IJsonRowNode;
-}
-export interface IJsonBorderNode extends IBorderAttributes {
-    location: IBorderLocation;
-    children: IJsonTabNode[];
-}
-export interface IJsonRowNode extends IRowAttributes {
-    children: (IJsonRowNode | IJsonTabSetNode)[];
-}
-export interface IJsonTabSetNode extends ITabSetAttributes {
-    active?: boolean;
-    maximized?: boolean;
-    children: IJsonTabNode[];
-}
-export interface IJsonTabNode extends ITabAttributes {}
-export interface IGlobalAttributes {
-    borderAutoSelectTabWhenClosed?: boolean;
-    borderAutoSelectTabWhenOpen?: boolean;
-    borderBarSize?: number;
-    borderClassName?: string;
-    borderEnableAutoHide?: boolean;
-    borderEnableDrop?: boolean;
-    borderMinSize?: number;
-    borderSize?: number;
-    enableEdgeDock?: boolean;
-    enableRotateBorderIcons?: boolean;
-    enableUseVisibility?: boolean;
-    legacyOverflowMenu?: boolean;
-    marginInsets?: IInsets;
-    rootOrientationVertical?: boolean;
-    splitterExtra?: number;
-    splitterSize?: number;
-    tabBorderHeight?: number;
-    tabBorderWidth?: number;
-    tabClassName?: string;
-    tabCloseType?: ICloseType;
-    tabContentClassName?: string;
-    tabDragSpeed?: number;
-    tabEnableClose?: boolean;
-    tabEnableDrag?: boolean;
-    tabEnableFloat?: boolean;
-    tabEnableRename?: boolean;
-    tabEnableRenderOnDemand?: boolean;
-    tabIcon?: string;
-    tabSetAutoSelectTab?: boolean;
-    tabSetBorderInsets?: IInsets;
-    tabSetClassNameHeader?: string;
-    tabSetClassNameTabStrip?: string;
-    tabSetEnableClose?: boolean;
-    tabSetEnableDeleteWhenEmpty?: boolean;
-    tabSetEnableDivide?: boolean;
-    tabSetEnableDrag?: boolean;
-    tabSetEnableDrop?: boolean;
-    tabSetEnableMaximize?: boolean;
-    tabSetEnableTabStrip?: boolean;
-    tabSetHeaderHeight?: number;
-    tabSetMarginInsets?: IInsets;
-    tabSetMinHeight?: number;
-    tabSetMinWidth?: number;
-    tabSetTabLocation?: ITabLocation;
-    tabSetTabStripHeight?: number;
-}
-export interface IRowAttributes {
-    height?: number;
-    id?: string;
-    type: "row";
-    weight?: number;
-    width?: number;
-}
-export interface ITabSetAttributes {
-    autoSelectTab?: boolean;
-    borderInsets?: IInsets;
-    classNameHeader?: string;
-    classNameTabStrip?: string;
-    config?: any;
-    enableClose?: boolean;
-    enableDeleteWhenEmpty?: boolean;
-    enableDivide?: boolean;
-    enableDrag?: boolean;
-    enableDrop?: boolean;
-    enableMaximize?: boolean;
-    enableTabStrip?: boolean;
-    headerHeight?: number;
-    height?: number;
-    id?: string;
-    marginInsets?: IInsets;
-    minHeight?: number;
-    minWidth?: number;
-    name?: string;
-    selected?: number;
-    tabLocation?: ITabLocation;
-    tabStripHeight?: number;
-    type: "tabset";
-    weight?: number;
-    width?: number;
-    maximized?: boolean;
-    active?: boolean;
-}
-export interface ITabAttributes {
-    altName?: string;
-    borderHeight?: number;
-    borderWidth?: number;
-    className?: string;
-    closeType?: ICloseType;
-    component?: string;
-    config?: any;
-    contentClassName?: string;
-    enableClose?: boolean;
-    enableDrag?: boolean;
-    enableFloat?: boolean;
-    enableRename?: boolean;
-    enableRenderOnDemand?: boolean;
-    floating?: boolean;
-    helpText?: string;
-    icon?: string;
-    id?: string;
-    name?: string;
-    type?: string;
-}
-export interface IBorderAttributes {
-    autoSelectTabWhenClosed?: boolean;
-    autoSelectTabWhenOpen?: boolean;
-    barSize?: number;
-    className?: string;
-    config?: any;
-    enableAutoHide?: boolean;
-    enableDrop?: boolean;
-    minSize?: number;
-    selected?: number;
-    show?: boolean;
-    size?: number;
-    type: "border";
-}

package/declarations/model/Model.d.ts

@@ -1,90 +0,0 @@
-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;
-}

package/declarations/model/Node.d.ts

@@ -1,27 +0,0 @@
-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;
-}

package/declarations/model/RowNode.d.ts

@@ -1,11 +0,0 @@
-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;
-}

package/declarations/model/SplitterNode.d.ts

@@ -1,5 +0,0 @@
-import { Node } from "./Node";
-export declare class SplitterNode extends Node {
-    static readonly TYPE: string;
-    toJson(): undefined;
-}

package/declarations/model/TabNode.d.ts

@@ -1,36 +0,0 @@
-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;
-    isEnableRenderOnDemand(): boolean;
-    toJson(): IJsonTabNode;
-}

package/declarations/model/TabSetNode.d.ts

@@ -1,43 +0,0 @@
-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;
-    canMaximize(): boolean;
-    isEnableTabStrip(): boolean;
-    isAutoSelectTab(): boolean;
-    getClassNameTabStrip(): string | undefined;
-    getClassNameHeader(): string | undefined;
-    getHeaderHeight(): number;
-    getTabStripHeight(): number;
-    getTabLocation(): string;
-    toJson(): IJsonTabSetNode;
-}

package/declarations/model/Utils.d.ts

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

package/declarations/view/BorderButton.d.ts

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

package/declarations/view/BorderTabSet.d.ts

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

package/declarations/view/ErrorBoundary.d.ts

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

package/declarations/view/FloatingWindow.d.ts

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

package/declarations/view/FloatingWindowTab.d.ts

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

package/declarations/view/Icons.d.ts

@@ -1,6 +0,0 @@
-/// <reference types="react" />
-export declare const CloseIcon: () => JSX.Element;
-export declare const MaximizeIcon: () => JSX.Element;
-export declare const OverflowIcon: () => JSX.Element;
-export declare const PopoutIcon: () => JSX.Element;
-export declare const RestoreIcon: () => JSX.Element;

package/declarations/view/Layout.d.ts

@@ -1,208 +0,0 @@
-import * as React from "react";
-import { DockLocation } from "../DockLocation";
-import { I18nLabel } from "../I18nLabel";
-import { Action } from "../model/Action";
-import { BorderNode } from "../model/BorderNode";
-import { Model } from "../model/Model";
-import { Node } from "../model/Node";
-import { TabNode } from "../model/TabNode";
-import { TabSetNode } from "../model/TabSetNode";
-import { Rect } from "../Rect";
-import { IJsonTabNode } from "../model/IJsonModel";
-export type CustomDragCallback = (
-    dragging: TabNode | IJsonTabNode,
-    over: TabNode,
-    x: number,
-    y: number,
-    location: DockLocation
-) => void;
-export type DragRectRenderCallback = (
-    content: React.ReactElement | undefined,
-    node?: Node,
-    json?: IJsonTabNode
-) => React.ReactElement | undefined;
-export type FloatingTabPlaceholderRenderCallback = (
-    dockPopout: () => void,
-    showPopout: () => void
-) => React.ReactElement | undefined;
-export type NodeMouseEvent = (
-    node: TabNode | TabSetNode | BorderNode,
-    event: React.MouseEvent<HTMLElement, MouseEvent>
-) => void;
-export type ShowOverflowMenuCallback = (
-    node: TabSetNode | BorderNode,
-    mouseEvent: React.MouseEvent<HTMLElement, MouseEvent>,
-    items: {
-        index: number;
-        node: TabNode;
-    }[],
-    onSelect: (item: { index: number; node: TabNode }) => void
-) => void;
-export type TabSetPlaceHolderCallback = (node: TabSetNode) => React.ReactNode;
-export type IconFactory = (node: TabNode) => React.ReactNode;
-export type TitleFactory = (node: TabNode) => ITitleObject | React.ReactNode;
-export interface ILayoutProps {
-    model: Model;
-    factory: (node: TabNode) => React.ReactNode;
-    font?: IFontValues;
-    fontFamily?: string;
-    iconFactory?: IconFactory;
-    titleFactory?: TitleFactory;
-    icons?: IIcons;
-    onAction?: (action: Action) => Action | undefined;
-    onRenderTab?: (node: TabNode, renderValues: ITabRenderValues) => void;
-    onRenderTabSet?: (
-        tabSetNode: TabSetNode | BorderNode,
-        renderValues: ITabSetRenderValues
-    ) => void;
-    onModelChange?: (model: Model, action: Action) => void;
-    onExternalDrag?: (event: React.DragEvent<HTMLDivElement>) =>
-        | undefined
-        | {
-              dragText: string;
-              json: any;
-              onDrop?: (node?: Node, event?: Event) => void;
-          };
-    classNameMapper?: (defaultClassName: string) => string;
-    i18nMapper?: (id: I18nLabel, param?: string) => string | undefined;
-    supportsPopout?: boolean | undefined;
-    popoutURL?: string | undefined;
-    realtimeResize?: boolean | undefined;
-    onTabDrag?: (
-        dragging: TabNode | IJsonTabNode,
-        over: TabNode,
-        x: number,
-        y: number,
-        location: DockLocation,
-        refresh: () => void
-    ) =>
-        | undefined
-        | {
-              x: number;
-              y: number;
-              width: number;
-              height: number;
-              callback: CustomDragCallback;
-              invalidated?: () => void;
-              cursor?: string | undefined;
-          };
-    onRenderDragRect?: DragRectRenderCallback;
-    onRenderFloatingTabPlaceholder?: FloatingTabPlaceholderRenderCallback;
-    onContextMenu?: NodeMouseEvent;
-    onAuxMouseClick?: NodeMouseEvent;
-    onShowOverflowMenu?: ShowOverflowMenuCallback;
-    onTabSetPlaceHolder?: TabSetPlaceHolderCallback;
-}
-export interface IFontValues {
-    size?: string;
-    family?: string;
-    style?: string;
-    weight?: string;
-}
-export interface ITabSetRenderValues {
-    headerContent?: React.ReactNode;
-    centerContent?: React.ReactNode;
-    stickyButtons: React.ReactNode[];
-    buttons: React.ReactNode[];
-    headerButtons: React.ReactNode[];
-    overflowPosition: number | undefined;
-}
-export interface ITabRenderValues {
-    leading: React.ReactNode;
-    content: React.ReactNode;
-    name: string;
-    buttons: React.ReactNode[];
-}
-export interface ITitleObject {
-    titleContent: React.ReactNode;
-    name: string;
-}
-export interface ILayoutState {
-    rect: Rect;
-    calculatedHeaderBarSize: number;
-    calculatedTabBarSize: number;
-    calculatedBorderBarSize: number;
-    editingTab?: TabNode;
-    showHiddenBorder: DockLocation;
-    portal?: React.ReactPortal;
-    showEdges?: boolean;
-}
-export interface IIcons {
-    close?: React.ReactNode | ((tabNode: TabNode) => React.ReactNode);
-    closeTabset?:
-        | React.ReactNode
-        | ((tabSetNode: TabSetNode) => React.ReactNode);
-    popout?: React.ReactNode | ((tabNode: TabNode) => React.ReactNode);
-    maximize?: React.ReactNode | ((tabSetNode: TabSetNode) => React.ReactNode);
-    restore?: React.ReactNode | ((tabSetNode: TabSetNode) => React.ReactNode);
-    more?:
-        | React.ReactNode
-        | ((
-              tabSetNode: TabSetNode | BorderNode,
-              hiddenTabs: {
-                  node: TabNode;
-                  index: number;
-              }[]
-          ) => React.ReactNode);
-}
-export interface ICustomDropDestination {
-    rect: Rect;
-    callback: CustomDragCallback;
-    invalidated: (() => void) | undefined;
-    dragging: TabNode | IJsonTabNode;
-    over: TabNode;
-    x: number;
-    y: number;
-    location: DockLocation;
-    cursor: string | undefined;
-}
-/**
- * A React component that hosts a multi-tabbed layout
- */
-export declare class Layout extends React.Component<
-    ILayoutProps,
-    ILayoutState
-> {
-    constructor(props: ILayoutProps);
-    /**
-     * Adds a new tab to the given tabset
-     * @param tabsetId the id of the tabset where the new tab will be added
-     * @param json the json for the new tab node
-     */
-    addTabToTabSet(tabsetId: string, json: IJsonTabNode): void;
-    /**
-     * Adds a new tab to the active tabset (if there is one)
-     * @param json the json for the new tab node
-     */
-    addTabToActiveTabSet(json: IJsonTabNode): void;
-    /**
-     * Adds a new tab by dragging a labeled panel to the drop location, dragging starts immediatelly
-     * @param dragText the text to show on the drag panel
-     * @param json the json for the new tab node
-     * @param onDrop a callback to call when the drag is complete (node and event will be undefined if the drag was cancelled)
-     */
-    addTabWithDragAndDrop(
-        dragText: string | undefined,
-        json: IJsonTabNode,
-        onDrop?: (node?: Node, event?: Event) => void
-    ): void;
-    /**
-     * Move a tab/tabset using drag and drop
-     * @param node the tab or tabset to drag
-     * @param dragText the text to show on the drag panel
-     */
-    moveTabWithDragAndDrop(node: TabNode | TabSetNode, dragText?: string): void;
-    /**
-     * Adds a new tab by dragging a labeled panel to the drop location, dragging starts when you
-     * mouse down on the panel
-     *
-     * @param dragText the text to show on the drag panel
-     * @param json the json for the new tab node
-     * @param onDrop a callback to call when the drag is complete (node and event will be undefined if the drag was cancelled)
-     */
-    addTabWithDragAndDropIndirect(
-        dragText: string | undefined,
-        json: IJsonTabNode,
-        onDrop?: (node?: Node, event?: Event) => void
-    ): void;
-}

package/declarations/view/Splitter.d.ts

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

package/declarations/view/Tab.d.ts

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

package/declarations/view/TabButton.d.ts

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

package/declarations/view/TabButtonStamp.d.ts

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

package/declarations/view/TabFloating.d.ts

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

package/declarations/view/TabOverflowHook.d.ts

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

package/declarations/view/TabSet.d.ts

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

package/declarations/view/Utils.d.ts

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