rei-mirrors/dockview
1
0
Fork 0
mirror of https://github.com/mathuo/dockview synced 2025-02-21 15:45:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: addPanel generics

Browse Source
This commit is contained in:
mathuo 2023-06-13 20:08:03 +01:00
parent bfc4faeed2
commit 6665c61a95
No known key found for this signature in database
GPG Key ID: C6EEDEFD6CA07281
7 changed files with 43 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
packages/dockview-core/src/api/component.api.ts
View File

@ -118,7 +118,7 @@ export class SplitviewApi implements CommonApi<SerializedSplitview> {
return this.component.layout(width, height); return this.component.layout(width, height);
} }
addPanel(options: AddSplitviewComponentOptions): ISplitviewPanel { addPanel<T extends object = Parameters>(options: AddSplitviewComponentOptions<T>): ISplitviewPanel {
return this.component.addPanel(options); return this.component.addPanel(options);
} }
@ -213,7 +213,7 @@ export class PaneviewApi implements CommonApi<SerializedPaneview> {
this.component.layout(width, height); this.component.layout(width, height);
} }
addPanel(options: AddPaneviewComponentOptions): IPaneviewPanel { addPanel<T extends object = Parameters>(options: AddPaneviewComponentOptions<T>): IPaneviewPanel {
return this.component.addPanel(options); return this.component.addPanel(options);
} }
@ -297,7 +297,7 @@ export class GridviewApi implements CommonApi<SerializedGridviewComponent> {
this.component.layout(width, height, force); this.component.layout(width, height, force);
} }
addPanel(options: AddComponentOptions): IGridviewPanel { addPanel<T extends object = Parameters>(options: AddComponentOptions<T>): IGridviewPanel {
return this.component.addPanel(options); return this.component.addPanel(options);
} }
@ -432,7 +432,7 @@ export class DockviewApi implements CommonApi<SerializedDockview> {
this.component.layout(width, height, force); this.component.layout(width, height, force);
} }
addPanel<P extends object = Parameters>(options: AddPanelOptions<P>): IDockviewPanel { addPanel<T extends object = Parameters>(options: AddPanelOptions<T>): IDockviewPanel {
return this.component.addPanel(options); return this.component.addPanel(options);
} }

14
packages/dockview-core/src/dockview/dockviewComponent.ts
View File

@ -28,7 +28,6 @@ import {
isPanelOptionsWithPanel, isPanelOptionsWithPanel,
MovementOptions, MovementOptions,
} from './options'; } from './options';
import { Parameters } from '../panel/types';
import { import {
BaseGrid, BaseGrid,
Direction, Direction,
@ -45,6 +44,7 @@ import {
import { DockviewGroupPanel, IDockviewGroupPanel } from './dockviewGroupPanel'; import { DockviewGroupPanel, IDockviewGroupPanel } from './dockviewGroupPanel';
import { DockviewPanelModel } from './dockviewPanelModel'; import { DockviewPanelModel } from './dockviewPanelModel';
import { getPanelData } from '../dnd/dataTransfer'; import { getPanelData } from '../dnd/dataTransfer';
import { Parameters } from '../panel/types';
export interface PanelReference { export interface PanelReference {
update: (event: { params: { [key: string]: any } }) => void; update: (event: { params: { [key: string]: any } }) => void;
@ -97,7 +97,9 @@ export interface IDockviewComponent extends IBaseGrid<DockviewGroupPanel> {
doSetGroupActive: (group: DockviewGroupPanel, skipFocus?: boolean) => void; doSetGroupActive: (group: DockviewGroupPanel, skipFocus?: boolean) => void;
removeGroup: (group: DockviewGroupPanel) => void; removeGroup: (group: DockviewGroupPanel) => void;
options: DockviewComponentOptions; options: DockviewComponentOptions;
addPanel<P extends object = Parameters>(options: AddPanelOptions<P>): IDockviewPanel; addPanel<T extends object = Parameters>(
options: AddPanelOptions<T>
): IDockviewPanel;
removePanel(panel: IDockviewPanel): void; removePanel(panel: IDockviewPanel): void;
getGroupPanel: (id: string) => IDockviewPanel | undefined; getGroupPanel: (id: string) => IDockviewPanel | undefined;
createWatermarkComponent(): IWatermarkRenderer; createWatermarkComponent(): IWatermarkRenderer;
@ -496,7 +498,9 @@ export class DockviewComponent
} }
} }
addPanel<P extends object = Parameters>(options: AddPanelOptions<P>): IDockviewPanel { addPanel<T extends object = Parameters>(
options: AddPanelOptions<T>
): IDockviewPanel {
if (this.panels.find((_) => _.id === options.id)) { if (this.panels.find((_) => _.id === options.id)) {
throw new Error(`panel with id ${options.id} already exists`); throw new Error(`panel with id ${options.id} already exists`);
} }
@ -914,8 +918,8 @@ export class DockviewComponent
return view; return view;
} }
private createPanel<P extends object = Parameters>( private createPanel(
options: AddPanelOptions<P>, options: AddPanelOptions,
group: DockviewGroupPanel group: DockviewGroupPanel
): IDockviewPanel { ): IDockviewPanel {
const contentComponent = options.component; const contentComponent = options.component;

2
packages/dockview-core/src/dockview/dockviewPanel.ts
View File

@ -14,7 +14,7 @@ export interface IDockviewPanel extends IDisposable, IPanel {
readonly view: IDockviewPanelModel; readonly view: IDockviewPanelModel;
readonly group: DockviewGroupPanel; readonly group: DockviewGroupPanel;
readonly api: DockviewPanelApi; readonly api: DockviewPanelApi;
readonly title: string; readonly title: string | undefined;
readonly params: Parameters | undefined; readonly params: Parameters | undefined;
updateParentGroup(group: DockviewGroupPanel, isGroupActive: boolean): void; updateParentGroup(group: DockviewGroupPanel, isGroupActive: boolean): void;
init(params: IGroupPanelInitParameters): void; init(params: IGroupPanelInitParameters): void;

13
packages/dockview-core/src/gridview/gridviewComponent.ts
View File

@ -21,7 +21,7 @@ import {
GridPanelViewState, GridPanelViewState,
IGridviewPanel, IGridviewPanel,
} from './gridviewPanel'; } from './gridviewPanel';
import { BaseComponentOptions } from '../panel/types'; import { BaseComponentOptions, Parameters } from '../panel/types';
import { Orientation, Sizing } from '../splitview/splitview'; import { Orientation, Sizing } from '../splitview/splitview';
import { createComponent } from '../panel/componentFactory'; import { createComponent } from '../panel/componentFactory';
import { Emitter, Event } from '../events'; import { Emitter, Event } from '../events';
@ -32,7 +32,8 @@ export interface SerializedGridviewComponent {
activePanel?: string; activePanel?: string;
} }
export interface AddComponentOptions extends BaseComponentOptions { export interface AddComponentOptions<T extends object = Parameters>
extends BaseComponentOptions<T> {
minimumWidth?: number; minimumWidth?: number;
maximumWidth?: number; maximumWidth?: number;
minimumHeight?: number; minimumHeight?: number;
@ -57,7 +58,9 @@ export interface IGridviewComponent extends IBaseGrid<GridviewPanel> {
readonly orientation: Orientation; readonly orientation: Orientation;
readonly onDidLayoutFromJSON: Event<void>; readonly onDidLayoutFromJSON: Event<void>;
updateOptions(options: Partial<GridviewComponentUpdateOptions>): void; updateOptions(options: Partial<GridviewComponentUpdateOptions>): void;
addPanel(options: AddComponentOptions): IGridviewPanel; addPanel<T extends object = Parameters>(
options: AddComponentOptions<T>
): IGridviewPanel;
removePanel(panel: IGridviewPanel, sizing?: Sizing): void; removePanel(panel: IGridviewPanel, sizing?: Sizing): void;
focus(): void; focus(): void;
fromJSON(serializedGridview: SerializedGridviewComponent): void; fromJSON(serializedGridview: SerializedGridviewComponent): void;
@ -276,7 +279,9 @@ export class GridviewComponent
this.doAddGroup(removedPanel, relativeLocation, options.size); this.doAddGroup(removedPanel, relativeLocation, options.size);
} }
public addPanel(options: AddComponentOptions): IGridviewPanel { public addPanel<T extends object = Parameters>(
options: AddComponentOptions<T>
): IGridviewPanel {
let relativeLocation: number[] = options.location || [0]; let relativeLocation: number[] = options.location || [0];
if (options.position?.referencePanel) { if (options.position?.referencePanel) {

4
packages/dockview-core/src/panel/types.ts
View File

@ -29,10 +29,10 @@ export interface IFrameworkPart extends IDisposable {
update(params: Parameters): void; update(params: Parameters): void;
} }
export interface BaseComponentOptions { export interface BaseComponentOptions<T extends object = Parameters> {
id: string; id: string;
component: string; component: string;
params?: Parameters; params?: T;
snap?: boolean; snap?: boolean;
priority?: LayoutPriority; priority?: LayoutPriority;
size?: number; size?: number;

15
packages/dockview-core/src/paneview/paneviewComponent.ts
View File

@ -23,6 +23,7 @@ import { DefaultHeader } from './defaultPaneviewHeader';
import { sequentialNumberGenerator } from '../math'; import { sequentialNumberGenerator } from '../math';
import { PaneTransfer } from '../dnd/dataTransfer'; import { PaneTransfer } from '../dnd/dataTransfer';
import { Resizable } from '../resizable'; import { Resizable } from '../resizable';
import { Parameters } from '../panel/types';
const nextLayoutId = sequentialNumberGenerator(); const nextLayoutId = sequentialNumberGenerator();
@ -87,13 +88,11 @@ export class PaneFramework extends DraggablePaneviewPanel {
} }
} }
export interface AddPaneviewComponentOptions { export interface AddPaneviewComponentOptions<T extends object = Parameters> {
id: string; id: string;
component: string; component: string;
headerComponent?: string; headerComponent?: string;
params?: { params?: T;
[key: string]: any;
};
minimumBodySize?: number; minimumBodySize?: number;
maximumBodySize?: number; maximumBodySize?: number;
isExpanded?: boolean; isExpanded?: boolean;
@ -115,7 +114,9 @@ export interface IPaneviewComponent extends IDisposable {
readonly onDidDrop: Event<PaneviewDropEvent>; readonly onDidDrop: Event<PaneviewDropEvent>;
readonly onDidLayoutChange: Event<void>; readonly onDidLayoutChange: Event<void>;
readonly onDidLayoutFromJSON: Event<void>; readonly onDidLayoutFromJSON: Event<void>;
addPanel(options: AddPaneviewComponentOptions): IPaneviewPanel; addPanel<T extends object = Parameters>(
options: AddPaneviewComponentOptions<T>
): IPaneviewPanel;
layout(width: number, height: number): void; layout(width: number, height: number): void;
toJSON(): SerializedPaneview; toJSON(): SerializedPaneview;
fromJSON(serializedPaneview: SerializedPaneview): void; fromJSON(serializedPaneview: SerializedPaneview): void;
@ -233,7 +234,9 @@ export class PaneviewComponent extends Resizable implements IPaneviewComponent {
this._options = { ...this.options, ...options }; this._options = { ...this.options, ...options };
} }
addPanel(options: AddPaneviewComponentOptions): IPaneviewPanel { addPanel<T extends object = Parameters>(
options: AddPaneviewComponentOptions<T>
): IPaneviewPanel {
const body = createComponent( const body = createComponent(
options.id, options.id,
options.component, options.component,

13
packages/dockview-core/src/splitview/splitviewComponent.ts
View File

@ -11,7 +11,7 @@ import {
Splitview, Splitview,
} from './splitview'; } from './splitview';
import { SplitviewComponentOptions } from './options'; import { SplitviewComponentOptions } from './options';
import { BaseComponentOptions } from '../panel/types'; import { BaseComponentOptions, Parameters } from '../panel/types';
import { Emitter, Event } from '../events'; import { Emitter, Event } from '../events';
import { SplitviewPanel, ISplitviewPanel } from './splitviewPanel'; import { SplitviewPanel, ISplitviewPanel } from './splitviewPanel';
import { createComponent } from '../panel/componentFactory'; import { createComponent } from '../panel/componentFactory';
@ -39,7 +39,8 @@ export interface SerializedSplitview {
views: SerializedSplitviewPanel[]; views: SerializedSplitviewPanel[];
} }
export interface AddSplitviewComponentOptions extends BaseComponentOptions { export interface AddSplitviewComponentOptions<T extends Parameters = Parameters>
extends BaseComponentOptions<T> {
index?: number; index?: number;
minimumSize?: number; minimumSize?: number;
maximumSize?: number; maximumSize?: number;
@ -62,7 +63,9 @@ export interface ISplitviewComponent extends IDisposable {
readonly onDidLayoutFromJSON: Event<void>; readonly onDidLayoutFromJSON: Event<void>;
readonly panels: SplitviewPanel[]; readonly panels: SplitviewPanel[];
updateOptions(options: Partial<SplitviewComponentUpdateOptions>): void; updateOptions(options: Partial<SplitviewComponentUpdateOptions>): void;
addPanel(options: AddSplitviewComponentOptions): ISplitviewPanel; addPanel<T extends object = Parameters>(
options: AddSplitviewComponentOptions<T>
): ISplitviewPanel;
layout(width: number, height: number): void; layout(width: number, height: number): void;
onDidLayoutChange: Event<void>; onDidLayoutChange: Event<void>;
toJSON(): SerializedSplitview; toJSON(): SerializedSplitview;
@ -248,7 +251,9 @@ export class SplitviewComponent
return this.panels.find((view) => view.id === id); return this.panels.find((view) => view.id === id);
} }
addPanel(options: AddSplitviewComponentOptions): SplitviewPanel { addPanel<T extends object = Parameters>(
options: AddSplitviewComponentOptions<T>
): SplitviewPanel {
if (this._panels.has(options.id)) { if (this._panels.has(options.id)) {
throw new Error(`panel ${options.id} already exists`); throw new Error(`panel ${options.id} already exists`);
} }