@hpcc-js/phosphor 3.7.1 → 3.8.0

package/types/BasePanel.d.ts

@@ -0,0 +1,28 @@
+import { HTMLWidget, Widget } from "@hpcc-js/common";
+import { Widget as PWidget, IMessageHandler, IMessageHook, Message } from "./phosphor-shim.ts";
+import { WidgetAdapter, WidgetAdapterArray } from "./WidgetAdapter.ts";
+export declare namespace BasePanel {
+    interface IAddWidgetOptions {
+        /** Minimum size in pixels */
+        minSize?: number;
+        /** Preferred/default size in pixels — used as initial size hint */
+        defaultSize?: number;
+        /** Inner padding in pixels (default 8) */
+        padding?: number;
+        /** Reference widget for split/tab positioning */
+        refWidget?: Widget;
+    }
+}
+export declare abstract class BasePanel extends HTMLWidget implements IMessageHandler, IMessageHook {
+    protected abstract _content: WidgetAdapterArray;
+    constructor();
+    getWidget(wa: PWidget): Widget | undefined;
+    getWidgetAdapter(widget: Widget): WidgetAdapter | null;
+    protected _prevActive: Widget;
+    active(): Widget;
+    protected _lazyLayoutChanged: (..._dummyArgs: any[]) => void;
+    processMessage(msg: Message): void;
+    messageHook(handler: IMessageHandler, msg: Message): boolean;
+    childActivation(w: Widget, wa: WidgetAdapter): void;
+    layoutChanged(): void;
+}

package/types/DockPanel.d.ts

@@ -1,12 +1,27 @@
-import { HTMLWidget, Widget } from "@hpcc-js/common";
-import { DockPanel as PhosphorDockPanel, IMessageHandler, IMessageHook, Message } from "./phosphor-shim.ts";
+import { Widget } from "@hpcc-js/common";
+import { BasePanel } from "./BasePanel.ts";
+import { DockPanel as PhosphorDockPanel } from "./phosphor-shim.ts";
 import { IClosable, WidgetAdapter } from "./WidgetAdapter.ts";
 import "../src/DockPanel.css";
-export declare class DockPanel extends HTMLWidget implements IMessageHandler, IMessageHook {
+export declare namespace DockPanel {
+    interface IAddWidgetOptions extends BasePanel.IAddWidgetOptions {
+        /** Tab title */
+        title?: string;
+        /** Insertion mode relative to refWidget */
+        location?: PhosphorDockPanel.InsertMode;
+        /** Whether the tab can be closed */
+        closable?: boolean | IClosable;
+    }
+}
+export declare class DockPanel extends BasePanel {
     private _dock;
+    protected _content: import("./WidgetAdapter.ts").WidgetAdapterArray;
     constructor();
-    protected getWidgetAdapter(widget: Widget): WidgetAdapter | null;
+    private _pendingDefaults;
+    addWidget(widget: Widget, options: DockPanel.IAddWidgetOptions): this;
+    /** @deprecated Use options object form instead */
     addWidget(widget: Widget, title: string, location?: PhosphorDockPanel.InsertMode, refWidget?: Widget, closable?: boolean | IClosable, padding?: number): this;
+    private _applyPendingDefaults;
     removeWidget(widget: Widget): this;
     isVisible(widget: Widget): boolean;
     widgetAdapters(): WidgetAdapter[];
@@ -15,18 +30,12 @@ export declare class DockPanel extends HTMLWidget implements IMessageHandler, IM
     layout(_: object): this;
     private _layoutObj;
     layoutObj(_: object | null): this;
-    private _pPlaceholder;
     enter(domNode: any, element: any): void;
     _prevHideSingleTabs: any;
     update(domNode: any, element: any): void;
     exit(domNode: any, element: any): void;
     render(callback?: (w: Widget) => void): this;
     refit(): void;
-    messageHook(handler: IMessageHandler, msg: Message): boolean;
-    private _lazyLayoutChanged;
-    _prevActive: Widget;
-    processMessage(msg: Message): void;
-    active(): Widget;
     childActivation(w: Widget, wa: WidgetAdapter): void;
     layoutChanged(): void;
 }

package/types/SplitPanel.d.ts

@@ -1,20 +1,27 @@
 import { HTMLWidget, SVGWidget, Widget } from "@hpcc-js/common";
-import { Message } from "./phosphor-shim.ts";
-import { WidgetAdapter } from "./WidgetAdapter.ts";
+import { BasePanel } from "./BasePanel.ts";
+import { WidgetAdapter, WidgetAdapterArray } from "./WidgetAdapter.ts";
 import "../src/DockPanel.css";
-export declare class SplitPanel extends HTMLWidget {
+export declare namespace SplitPanel {
+    interface IAddWidgetOptions extends BasePanel.IAddWidgetOptions {
+        /** Maximum size in pixels */
+        maxSize?: number;
+    }
+}
+export declare class SplitPanel extends BasePanel {
+    readonly _orientation: "horizontal" | "vertical";
     private _split;
-    private content;
-    constructor(orientation?: "horizontal" | "vertical");
-    protected getWidgetAdapter(widget: Widget): WidgetAdapter | null;
-    addWidget(widget: SVGWidget | HTMLWidget): this;
+    protected _content: WidgetAdapterArray;
+    constructor(_orientation?: "horizontal" | "vertical");
+    private _pendingDefaults;
+    addWidget(widget: SVGWidget | HTMLWidget, options?: SplitPanel.IAddWidgetOptions): this;
     relativeSizes(): number[];
     relativeSizes(_: number[]): this;
     enter(domNode: any, element: any): void;
     update(domNode: any, element: any): void;
     exit(domNode: any, element: any): void;
     render(callback?: (w: Widget) => void): this;
-    private _prevActive;
-    processMessage(msg: Message): void;
-    childActivation(w: Widget): void;
+    private _applyPendingDefaults;
+    childActivation(w: Widget, wa: WidgetAdapter): void;
+    layoutChanged(): void;
 }

package/types/TabPanel.d.ts

@@ -1,23 +1,31 @@
 import { HTMLWidget, SVGWidget, Widget } from "@hpcc-js/common";
-import { IMessageHandler, Message, Widget as PWidget } from "./phosphor-shim.ts";
+import { BasePanel } from "./BasePanel.ts";
 import { WidgetAdapter, WidgetAdapterArray, WidgetAdapterExt } from "./WidgetAdapter.ts";
 import "../src/DockPanel.css";
-export declare class TabPanel extends HTMLWidget {
+export declare namespace TabPanel {
+    interface IAddWidgetOptions {
+        /** Inner padding in pixels (default 8) */
+        padding?: number;
+        /** Tab title */
+        title?: string;
+        /** Widget adapter extensions (overflow settings) */
+        ext?: WidgetAdapterExt;
+    }
+}
+export declare class TabPanel extends BasePanel {
     private _tab;
-    protected content: WidgetAdapterArray;
+    protected _content: WidgetAdapterArray;
     constructor();
-    protected getWidget(wa: PWidget): Widget | undefined;
-    protected getWidgetAdapter(widget: Widget): WidgetAdapter | null;
+    addWidget(widget: SVGWidget | HTMLWidget, options: TabPanel.IAddWidgetOptions): this;
+    /** @deprecated Use options object form instead */
     addWidget(widget: SVGWidget | HTMLWidget, title: string, ext?: WidgetAdapterExt): this;
     removeWidget(widget: SVGWidget | HTMLWidget): this;
     enter(domNode: any, element: any): void;
     update(domNode: any, element: any): void;
     exit(domNode: any, element: any): void;
     render(callback?: (w: Widget) => void): this;
-    messageHook(handler: IMessageHandler, msg: Message): boolean;
-    private _prevActive;
-    processMessage(msg: Message): void;
-    childActivation(w: Widget): void;
     active(): Widget;
     active(_: Widget): any;
+    childActivation(w: Widget, wa: WidgetAdapter): void;
+    layoutChanged(): void;
 }