dockview-core 1.16.0 → 1.17.0

package/dist/esm/dockview/options.d.ts

@@ -12,6 +12,7 @@ import { IDockviewPanel } from './dockviewPanel';
 import { DockviewPanelRenderer } from '../overlay/overlayRenderContainer';
 import { IGroupHeaderProps } from './framework';
 import { FloatingGroupOptions } from './dockviewComponent';
+import { Contraints } from '../gridview/gridviewPanel';
 export interface IHeaderActionsRenderer extends IDisposable {
     readonly element: HTMLElement;
     init(params: IGroupHeaderProps): void;
@@ -71,19 +72,23 @@ export declare class DockviewUnhandledDragOverEvent implements DockviewDndOverla
     accept(): void;
 }
 export declare const PROPERTY_KEYS: (keyof DockviewOptions)[];
+export interface CreateComponentOptions {
+    /**
+     * The unqiue identifer of the component
+     */
+    id: string;
+    /**
+     * The component name, this should determine what is rendered.
+     */
+    name: string;
+}
 export interface DockviewFrameworkOptions {
     defaultTabComponent?: string;
     createRightHeaderActionComponent?: (group: DockviewGroupPanel) => IHeaderActionsRenderer;
     createLeftHeaderActionComponent?: (group: DockviewGroupPanel) => IHeaderActionsRenderer;
     createPrefixHeaderActionComponent?: (group: DockviewGroupPanel) => IHeaderActionsRenderer;
-    createTabComponent?: (options: {
-        id: string;
-        name: string;
-    }) => ITabRenderer | undefined;
-    createComponent: (options: {
-        id: string;
-        name: string;
-    }) => IContentRenderer;
+    createTabComponent?: (options: CreateComponentOptions) => ITabRenderer | undefined;
+    createComponent: (options: CreateComponentOptions) => IContentRenderer;
     createWatermarkComponent?: () => IWatermarkRenderer;
 }
 export type DockviewComponentOptions = DockviewOptions & DockviewFrameworkOptions;
@@ -149,7 +154,9 @@ export type AddPanelOptions<P extends object = Parameters> = {
      * Defaults to `false` which forces newly added panels to become active.
      */
     inactive?: boolean;
-} & Partial<AddPanelOptionsUnion>;
+    initialWidth?: number;
+    initialHeight?: number;
+} & Partial<AddPanelOptionsUnion> & Partial<Contraints>;
 type AddGroupOptionsWithPanel = {
     referencePanel: string | IDockviewPanel;
     direction?: Omit<Direction, 'within'>;

package/dist/esm/dockview/types.d.ts

@@ -2,7 +2,7 @@ import { DockviewPanelApi } from '../api/dockviewPanelApi';
 import { PanelInitParameters, IPanel } from '../panel/types';
 import { DockviewApi } from '../api/component.api';
 import { Optional } from '../types';
-import { DockviewGroupPanel, IDockviewGroupPanel } from './dockviewGroupPanel';
+import { IDockviewGroupPanel } from './dockviewGroupPanel';
 import { DockviewPanelRenderer } from '../overlay/overlayRenderContainer';
 export interface HeaderPartInitParameters {
     title: string;
@@ -19,7 +19,6 @@ type RendererMethodOptionalList = 'dispose' | 'update' | 'layout' | 'toJSON' | '
 export interface IWatermarkRenderer extends Optional<Omit<IPanel, 'id' | 'init'>, RendererMethodOptionalList> {
     readonly element: HTMLElement;
     init: (params: WatermarkRendererInitParameters) => void;
-    updateParentGroup(group: DockviewGroupPanel, visible: boolean): void;
 }
 export interface ITabRenderer extends Optional<Omit<IPanel, 'id'>, RendererMethodOptionalList> {
     readonly element: HTMLElement;
@@ -40,5 +39,9 @@ export interface GroupviewPanelState {
     params?: {
         [key: string]: any;
     };
+    minimumWidth?: number;
+    minimumHeight?: number;
+    maximumWidth?: number;
+    maximumHeight?: number;
 }
 export {};

package/dist/esm/dom.d.ts

@@ -30,3 +30,10 @@ export declare function addTestId(element: HTMLElement, id: string): void;
 export declare function disableIframePointEvents(): {
     release: () => void;
 };
+export declare function getDockviewTheme(element: HTMLElement): string | undefined;
+export declare class Classnames {
+    private readonly element;
+    private _classNames;
+    constructor(element: HTMLElement);
+    setClassNames(classNames: string): void;
+}

package/dist/esm/dom.js

@@ -202,3 +202,39 @@ export function disableIframePointEvents() {
         },
     };
 }
+export function getDockviewTheme(element) {
+    function toClassList(element) {
+        const list = [];
+        for (let i = 0; i < element.classList.length; i++) {
+            list.push(element.classList.item(i));
+        }
+        return list;
+    }
+    let theme = undefined;
+    let parent = element;
+    while (parent !== null) {
+        theme = toClassList(parent).find((cls) => cls.startsWith('dockview-theme-'));
+        if (typeof theme === 'string') {
+            break;
+        }
+        parent = parent.parentElement;
+    }
+    return theme;
+}
+export class Classnames {
+    constructor(element) {
+        this.element = element;
+        this._classNames = [];
+    }
+    setClassNames(classNames) {
+        for (const className of this._classNames) {
+            toggleClass(this.element, className, false);
+        }
+        this._classNames = classNames
+            .split(' ')
+            .filter((v) => v.trim().length > 0);
+        for (const className of this._classNames) {
+            toggleClass(this.element, className, true);
+        }
+    }
+}

package/dist/esm/gridview/baseComponentGridview.d.ts

@@ -12,7 +12,6 @@ export interface BaseGridOptions {
     readonly proportionalLayout: boolean;
     readonly orientation: Orientation;
     readonly styles?: ISplitviewStyles;
-    readonly parentElement: HTMLElement;
     readonly disableAutoResizing?: boolean;
     readonly locked?: boolean;
     readonly margin?: number;
@@ -63,6 +62,7 @@ export declare abstract class BaseGrid<T extends IGridPanelView> extends Resizab
     readonly onDidLayoutChange: Event<void>;
     private readonly _onDidViewVisibilityChangeMicroTaskQueue;
     readonly onDidViewVisibilityChangeMicroTaskQueue: Event<void>;
+    private readonly _classNames;
     get id(): string;
     get size(): number;
     get groups(): T[];
@@ -75,12 +75,13 @@ export declare abstract class BaseGrid<T extends IGridPanelView> extends Resizab
     get activeGroup(): T | undefined;
     get locked(): boolean;
     set locked(value: boolean);
-    constructor(options: BaseGridOptions);
+    constructor(parentElement: HTMLElement, options: BaseGridOptions);
     abstract toJSON(): object;
     abstract fromJSON(data: any): void;
     abstract clear(): void;
     setVisible(panel: T, visible: boolean): void;
     isVisible(panel: T): boolean;
+    updateOptions(options: Partial<BaseGridOptions>): void;
     maximizeGroup(panel: T): void;
     isMaximizedGroup(panel: T): boolean;
     exitMaximizedGroup(): void;

package/dist/esm/gridview/baseComponentGridview.js

@@ -4,6 +4,7 @@ import { Disposable } from '../lifecycle';
 import { sequentialNumberGenerator } from '../math';
 import { Sizing } from '../splitview/splitview';
 import { Resizable } from '../resizable';
+import { Classnames } from '../dom';
 const nextLayoutId = sequentialNumberGenerator();
 export function toTarget(direction) {
     switch (direction) {
@@ -57,7 +58,8 @@ export class BaseGrid extends Resizable {
     set locked(value) {
         this.gridview.locked = value;
     }
-    constructor(options) {
+    constructor(parentElement, options) {
+        var _a;
         super(document.createElement('div'), options.disableAutoResizing);
         this._id = nextLayoutId.next();
         this._groups = new Map();
@@ -73,10 +75,9 @@ export class BaseGrid extends Resizable {
         this.onDidViewVisibilityChangeMicroTaskQueue = this._onDidViewVisibilityChangeMicroTaskQueue.onEvent;
         this.element.style.height = '100%';
         this.element.style.width = '100%';
-        if (typeof options.className === 'string') {
-            this.element.classList.add(options.className);
-        }
-        options.parentElement.appendChild(this.element);
+        this._classNames = new Classnames(this.element);
+        this._classNames.setClassNames((_a = options.className) !== null && _a !== void 0 ? _a : '');
+        parentElement.appendChild(this.element);
         this.gridview = new Gridview(!!options.proportionalLayout, options.styles, options.orientation, options.locked, options.margin);
         this.gridview.locked = !!options.locked;
         this.element.appendChild(this.gridview.element);
@@ -99,6 +100,30 @@ export class BaseGrid extends Resizable {
     isVisible(panel) {
         return this.gridview.isViewVisible(getGridLocation(panel.element));
     }
+    updateOptions(options) {
+        var _a, _b, _c, _d;
+        if (typeof options.proportionalLayout === 'boolean') {
+            // this.gridview.proportionalLayout = options.proportionalLayout; // not supported
+        }
+        if (options.orientation) {
+            this.gridview.orientation = options.orientation;
+        }
+        if ('styles' in options) {
+            // this.gridview.styles = options.styles; // not supported
+        }
+        if ('disableResizing' in options) {
+            this.disableResizing = (_a = options.disableAutoResizing) !== null && _a !== void 0 ? _a : false;
+        }
+        if ('locked' in options) {
+            this.locked = (_b = options.locked) !== null && _b !== void 0 ? _b : false;
+        }
+        if ('margin' in options) {
+            this.gridview.margin = (_c = options.margin) !== null && _c !== void 0 ? _c : 0;
+        }
+        if ('className' in options) {
+            this._classNames.setClassNames((_d = options.className) !== null && _d !== void 0 ? _d : '');
+        }
+    }
     maximizeGroup(panel) {
         this.gridview.maximizeView(panel);
         this.doSetGroupActive(panel);

package/dist/esm/gridview/gridviewComponent.d.ts

@@ -25,11 +25,10 @@ export interface AddComponentOptions<T extends object = Parameters> extends Base
 export interface IGridPanelComponentView extends IGridPanelView {
     init: (params: GridviewInitParameters) => void;
 }
-export type GridviewComponentUpdateOptions = Pick<GridviewComponentOptions, 'orientation' | 'components' | 'frameworkComponents'>;
 export interface IGridviewComponent extends IBaseGrid<GridviewPanel> {
     readonly orientation: Orientation;
     readonly onDidLayoutFromJSON: Event<void>;
-    updateOptions(options: Partial<GridviewComponentUpdateOptions>): void;
+    updateOptions(options: Partial<GridviewComponentOptions>): void;
     addPanel<T extends object = Parameters>(options: AddComponentOptions<T>): IGridviewPanel;
     removePanel(panel: IGridviewPanel, sizing?: Sizing): void;
     focus(): void;
@@ -63,7 +62,7 @@ export declare class GridviewComponent extends BaseGrid<GridviewPanel> implement
     get deserializer(): IPanelDeserializer | undefined;
     set deserializer(value: IPanelDeserializer | undefined);
     constructor(parentElement: HTMLElement, options: GridviewComponentOptions);
-    updateOptions(options: Partial<GridviewComponentUpdateOptions>): void;
+    updateOptions(options: Partial<GridviewComponentOptions>): void;
     removePanel(panel: GridviewPanel): void;
     /**
      * Serialize the current state of the layout

package/dist/esm/gridview/gridviewComponent.js

@@ -21,8 +21,7 @@ export class GridviewComponent extends BaseGrid {
         this._deserializer = value;
     }
     constructor(parentElement, options) {
-        super({
-            parentElement: parentElement,
+        super(parentElement, {
             proportionalLayout: options.proportionalLayout,
             orientation: options.orientation,
             styles: options.styles,
@@ -53,6 +52,7 @@ export class GridviewComponent extends BaseGrid {
         }
     }
     updateOptions(options) {
+        super.updateOptions(options);
         const hasOrientationChanged = typeof options.orientation === 'string' &&
             this.gridview.orientation !== options.orientation;
         this._options = Object.assign(Object.assign({}, this.options), options);

package/dist/esm/gridview/gridviewPanel.d.ts

@@ -6,6 +6,12 @@ import { LayoutPriority } from '../splitview/splitview';
 import { Event } from '../events';
 import { IViewSize } from './gridview';
 import { BaseGrid, IGridPanelView } from './baseComponentGridview';
+export interface Contraints {
+    minimumWidth?: number;
+    maximumWidth?: number;
+    minimumHeight?: number;
+    maximumHeight?: number;
+}
 export interface GridviewInitParameters extends PanelInitParameters {
     minimumWidth?: number;
     maximumWidth?: number;

package/dist/esm/overlay/overlay.js

@@ -154,7 +154,7 @@ export class Overlay extends CompositeDisposable {
                 dispose: () => {
                     iframes.release();
                 },
-            }, addDisposableWindowListener(window, 'mousemove', (e) => {
+            }, addDisposableWindowListener(window, 'pointermove', (e) => {
                 const containerRect = this.options.container.getBoundingClientRect();
                 const x = e.clientX - containerRect.left;
                 const y = e.clientY - containerRect.top;
@@ -197,7 +197,7 @@ export class Overlay extends CompositeDisposable {
                 this._onDidChangeEnd.fire();
             }));
         };
-        this.addDisposables(move, addDisposableListener(dragTarget, 'mousedown', (event) => {
+        this.addDisposables(move, addDisposableListener(dragTarget, 'pointerdown', (event) => {
             if (event.defaultPrevented) {
                 event.preventDefault();
                 return;
@@ -208,7 +208,7 @@ export class Overlay extends CompositeDisposable {
                 return;
             }
             track();
-        }), addDisposableListener(this.options.content, 'mousedown', (event) => {
+        }), addDisposableListener(this.options.content, 'pointerdown', (event) => {
             if (event.defaultPrevented) {
                 return;
             }
@@ -220,7 +220,7 @@ export class Overlay extends CompositeDisposable {
             if (event.shiftKey) {
                 track();
             }
-        }), addDisposableListener(this.options.content, 'mousedown', () => {
+        }), addDisposableListener(this.options.content, 'pointerdown', () => {
             arialLevelTracker.push(this._element);
         }, true));
         if (options.inDragMode) {
@@ -232,11 +232,11 @@ export class Overlay extends CompositeDisposable {
         resizeHandleElement.className = `dv-resize-handle-${direction}`;
         this._element.appendChild(resizeHandleElement);
         const move = new MutableDisposable();
-        this.addDisposables(move, addDisposableListener(resizeHandleElement, 'mousedown', (e) => {
+        this.addDisposables(move, addDisposableListener(resizeHandleElement, 'pointerdown', (e) => {
             e.preventDefault();
             let startPosition = null;
             const iframes = disableIframePointEvents();
-            move.value = new CompositeDisposable(addDisposableWindowListener(window, 'mousemove', (e) => {
+            move.value = new CompositeDisposable(addDisposableWindowListener(window, 'pointermove', (e) => {
                 const containerRect = this.options.container.getBoundingClientRect();
                 const overlayRect = this._element.getBoundingClientRect();
                 const y = e.clientY - containerRect.top;

package/dist/esm/paneview/paneviewComponent.d.ts

@@ -103,6 +103,7 @@ export declare class PaneviewComponent extends Resizable implements IPaneviewCom
     readonly onDidAddView: Event<PaneviewPanel>;
     private readonly _onDidRemoveView;
     readonly onDidRemoveView: Event<PaneviewPanel>;
+    private readonly _classNames;
     get id(): string;
     get panels(): PaneviewPanel[];
     set paneview(value: Paneview);

package/dist/esm/paneview/paneviewComponent.js

@@ -8,6 +8,7 @@ import { DraggablePaneviewPanel, } from './draggablePaneviewPanel';
 import { DefaultHeader } from './defaultPaneviewHeader';
 import { sequentialNumberGenerator } from '../math';
 import { Resizable } from '../resizable';
+import { Classnames } from '../dom';
 const nextLayoutId = sequentialNumberGenerator();
 export class PaneFramework extends DraggablePaneviewPanel {
     constructor(options) {
@@ -57,6 +58,7 @@ export class PaneviewComponent extends Resizable {
         return this._options;
     }
     constructor(parentElement, options) {
+        var _a;
         super(parentElement, options.disableAutoResizing);
         this._id = nextLayoutId.next();
         this._disposable = new MutableDisposable();
@@ -71,10 +73,9 @@ export class PaneviewComponent extends Resizable {
         this.onDidAddView = this._onDidAddView.event;
         this._onDidRemoveView = new Emitter();
         this.onDidRemoveView = this._onDidRemoveView.event;
-        if (typeof options.className === 'string') {
-            this.element.classList.add(options.className);
-        }
         this.addDisposables(this._onDidLayoutChange, this._onDidLayoutfromJSON, this._onDidDrop, this._onDidAddView, this._onDidRemoveView);
+        this._classNames = new Classnames(this.element);
+        this._classNames.setClassNames((_a = options.className) !== null && _a !== void 0 ? _a : '');
         this._options = options;
         if (!options.components) {
             options.components = {};
@@ -96,6 +97,13 @@ export class PaneviewComponent extends Resizable {
         //noop
     }
     updateOptions(options) {
+        var _a, _b;
+        if ('className' in options) {
+            this._classNames.setClassNames((_a = options.className) !== null && _a !== void 0 ? _a : '');
+        }
+        if ('disableResizing' in options) {
+            this.disableResizing = (_b = options.disableAutoResizing) !== null && _b !== void 0 ? _b : false;
+        }
         this._options = Object.assign(Object.assign({}, this.options), options);
     }
     addPanel(options) {

package/dist/esm/splitview/splitviewComponent.d.ts

@@ -1,5 +1,5 @@
 import { IDisposable } from '../lifecycle';
-import { IView, LayoutPriority, Orientation, Sizing, Splitview } from './splitview';
+import { IView, LayoutPriority, Orientation, Sizing, Splitview, SplitViewOptions } from './splitview';
 import { SplitviewComponentOptions } from './options';
 import { BaseComponentOptions, Parameters } from '../panel/types';
 import { Event } from '../events';
@@ -31,7 +31,6 @@ export interface AddSplitviewComponentOptions<T extends Parameters = Parameters>
     minimumSize?: number;
     maximumSize?: number;
 }
-export type SplitviewComponentUpdateOptions = Pick<SplitviewComponentOptions, 'orientation' | 'components' | 'frameworkComponents'>;
 export interface ISplitviewComponent extends IDisposable {
     readonly minimumSize: number;
     readonly maximumSize: number;
@@ -43,7 +42,7 @@ export interface ISplitviewComponent extends IDisposable {
     readonly onDidRemoveView: Event<IView>;
     readonly onDidLayoutFromJSON: Event<void>;
     readonly panels: SplitviewPanel[];
-    updateOptions(options: Partial<SplitviewComponentUpdateOptions>): void;
+    updateOptions(options: Partial<SplitViewOptions>): void;
     addPanel<T extends object = Parameters>(options: AddSplitviewComponentOptions<T>): ISplitviewPanel;
     layout(width: number, height: number): void;
     onDidLayoutChange: Event<void>;
@@ -73,6 +72,7 @@ export declare class SplitviewComponent extends Resizable implements ISplitviewC
     readonly onDidRemoveView: Event<IView>;
     private readonly _onDidLayoutChange;
     readonly onDidLayoutChange: Event<void>;
+    private readonly _classNames;
     get panels(): SplitviewPanel[];
     get options(): SplitviewComponentOptions;
     get length(): number;
@@ -84,7 +84,7 @@ export declare class SplitviewComponent extends Resizable implements ISplitviewC
     get height(): number;
     get width(): number;
     constructor(parentElement: HTMLElement, options: SplitviewComponentOptions);
-    updateOptions(options: Partial<SplitviewComponentUpdateOptions>): void;
+    updateOptions(options: Partial<SplitviewComponentOptions>): void;
     focus(): void;
     movePanel(from: number, to: number): void;
     setVisible(panel: SplitviewPanel, visible: boolean): void;

package/dist/esm/splitview/splitviewComponent.js

@@ -3,6 +3,7 @@ import { Orientation, Sizing, Splitview, } from './splitview';
 import { Emitter } from '../events';
 import { createComponent } from '../panel/componentFactory';
 import { Resizable } from '../resizable';
+import { Classnames } from '../dom';
 /**
  * A high-level implementation of splitview that works using 'panels'
  */
@@ -45,6 +46,7 @@ export class SplitviewComponent extends Resizable {
             : this.splitview.orthogonalSize;
     }
     constructor(parentElement, options) {
+        var _a;
         super(parentElement, options.disableAutoResizing);
         this._splitviewChangeDisposable = new MutableDisposable();
         this._panels = new Map();
@@ -56,9 +58,8 @@ export class SplitviewComponent extends Resizable {
         this.onDidRemoveView = this._onDidRemoveView.event;
         this._onDidLayoutChange = new Emitter();
         this.onDidLayoutChange = this._onDidLayoutChange.event;
-        if (typeof options.className === 'string') {
-            this.element.classList.add(options.className);
-        }
+        this._classNames = new Classnames(this.element);
+        this._classNames.setClassNames((_a = options.className) !== null && _a !== void 0 ? _a : '');
         this._options = options;
         if (!options.components) {
             options.components = {};
@@ -70,12 +71,17 @@ export class SplitviewComponent extends Resizable {
         this.addDisposables(this._onDidAddView, this._onDidLayoutfromJSON, this._onDidRemoveView, this._onDidLayoutChange);
     }
     updateOptions(options) {
-        const hasOrientationChanged = typeof options.orientation === 'string' &&
-            this.options.orientation !== options.orientation;
-        this._options = Object.assign(Object.assign({}, this.options), options);
-        if (hasOrientationChanged) {
+        var _a, _b;
+        if ('className' in options) {
+            this._classNames.setClassNames((_a = options.className) !== null && _a !== void 0 ? _a : '');
+        }
+        if ('disableResizing' in options) {
+            this.disableResizing = (_b = options.disableAutoResizing) !== null && _b !== void 0 ? _b : false;
+        }
+        if (typeof options.orientation === 'string') {
             this.splitview.orientation = options.orientation;
         }
+        this._options = Object.assign(Object.assign({}, this.options), options);
         this.splitview.layout(this.splitview.size, this.splitview.orthogonalSize);
     }
     focus() {

package/dist/styles/dockview.css

@@ -200,7 +200,7 @@
   --dv-group-view-background-color: #ebeced;
   --dv-tabs-and-actions-container-background-color: #fcfcfc;
   --dv-activegroup-visiblepanel-tab-background-color: #f0f1f2;
-  --dv-activegroup-hiddenpanel-tab-background-color: ##fcfcfc;
+  --dv-activegroup-hiddenpanel-tab-background-color: #fcfcfc;
   --dv-inactivegroup-visiblepanel-tab-background-color: #f0f1f2;
   --dv-inactivegroup-hiddenpanel-tab-background-color: #fcfcfc;
   --dv-tab-divider-color: transparent;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dockview-core",
-  "version": "1.16.0",
+  "version": "1.17.0",
   "description": "Zero dependency layout manager supporting tabs, grids and splitviews",
   "keywords": [
     "splitview",