dockview-core 8.3.0 → 8.4.0

package/dist/cjs/gridview/branchNode.d.ts

@@ -5,7 +5,6 @@ import { Node } from './types';
 import { CompositeDisposable } from '../lifecycle';
 export declare class BranchNode extends CompositeDisposable implements IView {
     readonly orientation: Orientation;
-    readonly proportionalLayout: boolean;
     readonly styles: ISplitviewStyles | undefined;
     readonly element: HTMLElement;
     private readonly splitview;
@@ -55,6 +54,8 @@ export declare class BranchNode extends CompositeDisposable implements IView {
     set disabled(value: boolean);
     get margin(): number;
     set margin(value: number);
+    get proportionalLayout(): boolean;
+    set proportionalLayout(value: boolean);
     constructor(orientation: Orientation, proportionalLayout: boolean, styles: ISplitviewStyles | undefined, size: number, orthogonalSize: number, disabled: boolean, margin: number | undefined, childDescriptors?: INodeDescriptor[]);
     setVisible(_visible: boolean): void;
     isChildVisible(index: number): boolean;

package/dist/cjs/gridview/gridview.d.ts

@@ -94,7 +94,6 @@ export interface MaximizedViewChanged {
     isMaximized: boolean;
 }
 export declare class Gridview implements IDisposable {
-    readonly proportionalLayout: boolean;
     readonly styles: ISplitviewStyles | undefined;
     readonly element: HTMLElement;
     private _root;
@@ -148,6 +147,8 @@ export declare class Gridview implements IDisposable {
     getView(location?: number[]): GridNode<IGridView>;
     private _getViews;
     private progmaticSelect;
+    get proportionalLayout(): boolean;
+    set proportionalLayout(value: boolean);
     constructor(proportionalLayout: boolean, styles: ISplitviewStyles | undefined, orientation: Orientation, locked?: boolean, margin?: number);
     isViewVisible(location: number[]): boolean;
     setViewVisible(location: number[], visible: boolean): void;

package/dist/cjs/index.d.ts

@@ -7,6 +7,10 @@ export { getPaneData, getPanelData, LocalSelectionTransfer, PaneTransfer, PanelT
 export { Emitter as DockviewEmitter, Event as DockviewEvent } from './events';
 export { type IDisposable as DockviewIDisposable, MutableDisposable as DockviewMutableDisposable, CompositeDisposable as DockviewCompositeDisposable, Disposable as DockviewDisposable, } from './lifecycle';
 export * from './panel/types';
+/** The popout URL guard, so an application can check a `popoutUrl` itself. */
+export { getPopoutUrlError, type PopoutWindowEvent, type PopoutWindowFailure, type PopoutWindowFailureReason, } from './popoutWindow';
+/** Readable through `api.dndCapabilities`. */
+export { type DndCapabilities } from './dockview/dndCapabilities';
 export * from './splitview/splitview';
 export { type SplitviewComponentOptions, type PanelViewInitParameters, type SplitviewOptions, type SplitviewFrameworkOptions, PROPERTY_KEYS_SPLITVIEW, } from './splitview/options';
 export * from './paneview/paneview';
@@ -53,7 +57,7 @@ export { createDockview, createGridview, createPaneview, createSplitview, } from
 export { registerModules, getRegisteredModules, clearRegisteredModules, defineModule, type DockviewModule, type ServiceCollection, } from './dockview/modules';
 export { type IKeyboardNavigationHost, type IKeyboardNavigationService, type IAdvancedDnDHost, type IAdvancedDnDService, type IAutoHideEdgeGroupHost, type IAutoHideEdgeGroupService, type IAutoEdgeGroupHost, type IAutoEdgeGroupService, type IContextMenuHost, type IContextMenuService, type IDndCompassHost, type IDndCompassService, type IKeyboardDockingService, type ILayoutHistoryHost, type ILayoutHistoryService, type LayoutHistoryChangeEvent, type LayoutHistoryKind, type IMultiRowTabsHost, type IMultiRowTabsService, type ISmartGuidesHost, type ISmartGuidesService, type SmartGuidesSnapPosition, type SmartGuidesSnapEvent, type SmartGuidesSnapTogetherEvent, type ITabGroupChipsHost, type ITabGroupChipsService, type IPinnedTabsHost, type IPinnedTabsService, type IAdvancedOverflowHost, type IAdvancedOverflowService, type IAdvancedOverflowRenderContext, type AdvancedOverflowRenderParams, type IOverflowRow, } from './dockview/moduleContracts';
 export { resolveMessages } from './dockview/accessibilityMessages';
-export { findRelativeZIndexParent, prefersReducedMotion, resolveOpaqueBackground, } from './dom';
+export { findRelativeZIndexParent, getActiveElement, prefersReducedMotion, resolveOpaqueBackground, } from './dom';
 export { createDismissableLayer, type DismissableLayerOptions, } from './dismissableLayer';
 export { type IDragGhostSpec } from './dnd/backend';
 export { LiveRegionModule } from './dockview/liveRegionService';

package/dist/cjs/popoutWindow.d.ts

@@ -1,25 +1,60 @@
 import { CspNonceProvider } from './dom';
 import { CompositeDisposable } from './lifecycle';
 import { Box } from './types';
+/**
+ * A popout window at a lifecycle boundary. `id` is the target name dockview
+ * passed to `window.open`; `window` is the live handle.
+ */
+export interface PopoutWindowEvent {
+    readonly id: string;
+    readonly window: Window;
+}
+/**
+ * Why a popout window could not be used:
+ *
+ * - `url-refused`: the URL failed {@link getPopoutUrlError}.
+ * - `blocked`: `window.open` returned nothing, the browser's popup blocker
+ *   being the usual reason.
+ * - `unscriptable`: a window opened, but the opener cannot reach its document,
+ *   so panel DOM cannot be moved into it. Hosts that answer `window.open`
+ *   themselves can do this.
+ * - `closed`: the window went away before it finished loading.
+ */
+export type PopoutWindowFailureReason = 'url-refused' | 'blocked' | 'unscriptable' | 'closed';
+export interface PopoutWindowFailure {
+    readonly reason: PopoutWindowFailureReason;
+    /** The refusal itself, where there was one. */
+    readonly error?: Error;
+}
 export type PopoutWindowOptions = {
     url: string;
-    onDidOpen?: (event: {
-        id: string;
-        window: Window;
-    }) => void;
-    onWillClose?: (event: {
-        id: string;
-        window: Window;
-    }) => void;
+    onDidOpen?: (event: PopoutWindowEvent) => void;
+    onWillClose?: (event: PopoutWindowEvent) => void;
     nonce?: CspNonceProvider;
+    /** The root node dockview is mounted in, read when the popout loads.
+     *  When it is a shadow root its stylesheets are copied too, since they are
+     *  not in `document.styleSheets`. Rules that target the shadow host
+     *  (`:host`, `::slotted`) match nothing in the popout. */
+    styleRoot?: () => Node;
 } & Box;
 /**
- * Reject popout URLs that aren't same-origin http(s). Blocks `javascript:`,
- * `data:`, `blob:`, `vbscript:`, and cross-origin URLs that would otherwise
- * execute in a context the browser still associates with the opener via
- * `window.opener`.
+ * Throwing form of {@link getPopoutUrlError}, for callers with no way to
+ * recover from a refused URL.
  */
 export declare function assertSameOriginPopoutUrl(url: string): void;
+/**
+ * The reason `url` is unusable as a popout target, or `undefined` if it is
+ * allowed. Rejects anything that isn't same-origin with the page (scheme and
+ * host, so a packaged webview's own scheme such as `tauri://` qualifies), and
+ * the `javascript:`, `data:`, `blob:`, `vbscript:` and `file:` schemes that
+ * would otherwise execute in a context the browser still associates with the
+ * opener via `window.opener`.
+ *
+ * Callers that can recover from a refusal use this rather than catching, so it
+ * can be handled without a rejected promise. `page` is what the URL resolves
+ * against, and defaults to this page.
+ */
+export declare function getPopoutUrlError(url: string, page?: Pick<Location, 'href' | 'protocol' | 'host'>): Error | undefined;
 export declare class PopoutWindow extends CompositeDisposable {
     private readonly target;
     private readonly className;
@@ -29,10 +64,20 @@ export declare class PopoutWindow extends CompositeDisposable {
     private readonly _onDidClose;
     readonly onDidClose: import("./events").Event<void>;
     private _window;
+    private _failure;
     get window(): Window | null;
+    /** Set when {@link open} resolved `null`, saying which way it failed. */
+    get failure(): PopoutWindowFailure | undefined;
     constructor(target: string, className: string, options: PopoutWindowOptions);
     dimensions(): Box | null;
     close(): void;
     open(): Promise<HTMLElement | null>;
+    /**
+     * Backstop for the `beforeunload` signal, which a window torn down without
+     * running its unload handlers never sends: a native shell destroying the
+     * webview, or a browser discarding the page. `closed` is readable on any
+     * handle, cross-origin included. Whichever signal arrives first wins.
+     */
+    private watchForClose;
     private createPopoutWindowContainer;
 }

package/dist/cjs/resizable.d.ts

@@ -8,5 +8,17 @@ export declare abstract class Resizable extends CompositeDisposable {
     get disableResizing(): boolean;
     set disableResizing(value: boolean);
     constructor(parentElement: HTMLElement, disableResizing?: boolean);
+    /**
+     * Lay out from the element's current size.
+     *
+     * The ResizeObserver above only reports asynchronously, so between
+     * construction and its first callback the component believes it has no
+     * size - and anything built in that window (panels added right after
+     * `createDockview`, say) resolves its sizes against zero and collapses to
+     * minimums. Concrete components call this once they are fully constructed
+     * so that work sees the real size. The same guards as the observer apply:
+     * a detached or hidden element has no size worth propagating.
+     */
+    protected layoutFromElement(): void;
     abstract layout(width: number, height: number): void;
 }

package/dist/cjs/splitview/splitview.d.ts

@@ -77,7 +77,7 @@ export declare class Splitview {
     private _orthogonalSize;
     private _contentSize;
     private _proportions;
-    private readonly proportionalLayout;
+    private _proportionalLayout;
     private _startSnappingEnabled;
     private _endSnappingEnabled;
     private _disabled;
@@ -95,6 +95,8 @@ export declare class Splitview {
     set orthogonalSize(value: number);
     get length(): number;
     get proportions(): (number | undefined)[] | undefined;
+    get proportionalLayout(): boolean;
+    set proportionalLayout(value: boolean);
     get orientation(): Orientation;
     set orientation(value: Orientation);
     get minimumSize(): number;