From a53665adc5c19ab989e4345f3056c37e98102853 Mon Sep 17 00:00:00 2001 From: mathuo <6710312+mathuo@users.noreply.github.com> Date: Mon, 23 Dec 2024 20:04:14 +0000 Subject: [PATCH] chore: autogen docs --- packages/docs/src/generated/api.output.json | 1281 ++++++++----------- 1 file changed, 515 insertions(+), 766 deletions(-) diff --git a/packages/docs/src/generated/api.output.json b/packages/docs/src/generated/api.output.json index 2e827390f..85cf823f6 100644 --- a/packages/docs/src/generated/api.output.json +++ b/packages/docs/src/generated/api.output.json @@ -2841,7 +2841,7 @@ }, { "name": "addFloatingGroup", - "code": "(item: IDockviewPanel | DockviewGroupPanel, options?: FloatingGroupOptions): void", + "code": "(item: DockviewGroupPanel | IDockviewPanel, options?: FloatingGroupOptions): void", "kind": "method", "signature": [ { @@ -2858,18 +2858,18 @@ "parameters": [ { "name": "item", - "code": "item: IDockviewPanel | DockviewGroupPanel", + "code": "item: DockviewGroupPanel | IDockviewPanel", "type": { "type": "or", "values": [ { "type": "reference", - "value": "IDockviewPanel", + "value": "DockviewGroupPanel", "source": "dockview-core" }, { "type": "reference", - "value": "DockviewGroupPanel", + "value": "IDockviewPanel", "source": "dockview-core" } ] @@ -2891,7 +2891,7 @@ "type": "intrinsic", "value": "void" }, - "code": "(item: IDockviewPanel | DockviewGroupPanel, options?: FloatingGroupOptions): void", + "code": "(item: DockviewGroupPanel | IDockviewPanel, options?: FloatingGroupOptions): void", "kind": "callSignature" } ], @@ -3060,7 +3060,7 @@ }, { "name": "addPopoutGroup", - "code": "(item: IDockviewPanel | DockviewGroupPanel, options?: { onDidOpen?: (event: { id: string, window: Window }): void, onWillClose?: (event: { id: string, window: Window }): void, popoutUrl?: string, position?: Box }): Promise", + "code": "(item: DockviewGroupPanel | IDockviewPanel, options?: { onDidOpen?: (event: { id: string, window: Window }): void, onWillClose?: (event: { id: string, window: Window }): void, popoutUrl?: string, position?: Box }): Promise", "kind": "method", "signature": [ { @@ -3077,18 +3077,18 @@ "parameters": [ { "name": "item", - "code": "item: IDockviewPanel | DockviewGroupPanel", + "code": "item: DockviewGroupPanel | IDockviewPanel", "type": { "type": "or", "values": [ { "type": "reference", - "value": "IDockviewPanel", + "value": "DockviewGroupPanel", "source": "dockview-core" }, { "type": "reference", - "value": "DockviewGroupPanel", + "value": "IDockviewPanel", "source": "dockview-core" } ] @@ -3279,7 +3279,7 @@ } ] }, - "code": "(item: IDockviewPanel | DockviewGroupPanel, options?: { onDidOpen?: (event: { id: string, window: Window }): void, onWillClose?: (event: { id: string, window: Window }): void, popoutUrl?: string, position?: Box }): Promise", + "code": "(item: DockviewGroupPanel | IDockviewPanel, options?: { onDidOpen?: (event: { id: string, window: Window }): void, onWillClose?: (event: { id: string, window: Window }): void, popoutUrl?: string, position?: Box }): Promise", "kind": "callSignature" } ], @@ -10187,7 +10187,7 @@ }, { "name": "getBodyComponent", - "code": "(): IPaneBodyPart", + "code": "(): IPanePart", "kind": "method", "signature": [ { @@ -10196,10 +10196,10 @@ "parameters": [], "returnType": { "type": "reference", - "value": "IPaneBodyPart", + "value": "IPanePart", "source": "dockview-core" }, - "code": "(): IPaneBodyPart", + "code": "(): IPanePart", "kind": "callSignature" } ] @@ -10225,7 +10225,7 @@ }, { "name": "getHeaderComponent", - "code": "(): IPaneHeaderPart", + "code": "(): IPanePart", "kind": "method", "signature": [ { @@ -10234,10 +10234,10 @@ "parameters": [], "returnType": { "type": "reference", - "value": "IPaneHeaderPart", + "value": "IPanePart", "source": "dockview-core" }, - "code": "(): IPaneHeaderPart", + "code": "(): IPanePart", "kind": "callSignature" } ] @@ -15393,7 +15393,7 @@ }, { "name": "getBodyComponent", - "code": "(): IPaneBodyPart", + "code": "(): IPanePart", "kind": "method", "signature": [ { @@ -15402,10 +15402,10 @@ "parameters": [], "returnType": { "type": "reference", - "value": "IPaneBodyPart", + "value": "IPanePart", "source": "dockview-core" }, - "code": "(): IPaneBodyPart", + "code": "(): IPanePart", "kind": "callSignature" } ] @@ -15431,7 +15431,7 @@ }, { "name": "getHeaderComponent", - "code": "(): IPaneHeaderPart", + "code": "(): IPanePart", "kind": "method", "signature": [ { @@ -15440,10 +15440,10 @@ "parameters": [], "returnType": { "type": "reference", - "value": "IPaneHeaderPart", + "value": "IPanePart", "source": "dockview-core" }, - "code": "(): IPaneHeaderPart", + "code": "(): IPanePart", "kind": "callSignature" } ] @@ -18289,7 +18289,7 @@ }, { "name": "getBodyComponent", - "code": "(): IPaneBodyPart", + "code": "(): IPanePart", "kind": "method", "signature": [ { @@ -18298,10 +18298,10 @@ "parameters": [], "returnType": { "type": "reference", - "value": "IPaneBodyPart", + "value": "IPanePart", "source": "dockview-core" }, - "code": "(): IPaneBodyPart", + "code": "(): IPanePart", "kind": "callSignature" } ] @@ -18327,7 +18327,7 @@ }, { "name": "getHeaderComponent", - "code": "(): IPaneHeaderPart", + "code": "(): IPanePart", "kind": "method", "signature": [ { @@ -18336,10 +18336,10 @@ "parameters": [], "returnType": { "type": "reference", - "value": "IPaneHeaderPart", + "value": "IPanePart", "source": "dockview-core" }, - "code": "(): IPaneHeaderPart", + "code": "(): IPanePart", "kind": "callSignature" } ] @@ -25437,7 +25437,7 @@ "summary": [ { "kind": "text", - "text": "The same-origin path at which the popout window will be created\n\nDefaults to " + "text": "The same-origin path at which the popout window will be created\r\n\r\nDefaults to " }, { "kind": "code", @@ -26087,126 +26087,55 @@ "BasePanelViewState" ] }, - "GridviewComponentOptions": { + "GridviewFrameworkOptions": { "kind": "interface", - "name": "GridviewComponentOptions", + "name": "GridviewFrameworkOptions", "children": [ { - "name": "className", - "code": "string", - "kind": "property", - "type": { - "type": "intrinsic", - "value": "string" - }, - "flags": { - "isOptional": true - } - }, - { - "name": "components", - "code": "", + "name": "createComponent", + "code": "(options: CreateComponentOptions): GridviewPanel", "kind": "property", "type": { "type": "reflection", "value": { "name": "__type", - "code": "", - "kind": "typeLiteral" - } - }, - "flags": { - "isOptional": true - } - }, - { - "name": "disableAutoResizing", - "code": "boolean", - "kind": "property", - "type": { - "type": "intrinsic", - "value": "boolean" - }, - "flags": { - "isOptional": true - } - }, - { - "name": "frameworkComponentFactory", - "code": "FrameworkFactory>", - "kind": "property", - "type": { - "type": "reference", - "value": "FrameworkFactory", - "source": "dockview-core", - "typeArguments": [ - { - "type": "reference", - "value": "GridviewPanel", - "source": "dockview-core", - "typeArguments": [ - { + "code": "(options: CreateComponentOptions): GridviewPanel", + "kind": "typeLiteral", + "signatures": [ + { + "name": "__type", + "typeParameters": [], + "parameters": [ + { + "name": "options", + "code": "options: CreateComponentOptions", + "type": { + "type": "reference", + "value": "CreateComponentOptions", + "source": "dockview-core" + }, + "kind": "parameter" + } + ], + "returnType": { "type": "reference", - "value": "GridviewPanelApiImpl", - "source": "dockview-core" - } - ] - } - ] - }, - "flags": { - "isOptional": true - } - }, - { - "name": "frameworkComponents", - "code": "", - "kind": "property", - "type": { - "type": "reflection", - "value": { - "name": "__type", - "code": "", - "kind": "typeLiteral" + "value": "GridviewPanel", + "source": "dockview-core", + "typeArguments": [ + { + "type": "reference", + "value": "GridviewPanelApiImpl", + "source": "dockview-core" + } + ] + }, + "code": "(options: CreateComponentOptions): GridviewPanel", + "kind": "callSignature" + } + ] } }, - "flags": { - "isOptional": true - } - }, - { - "name": "orientation", - "code": "Orientation", - "kind": "property", - "type": { - "type": "reference", - "value": "Orientation", - "source": "dockview-core" - }, - "flags": {} - }, - { - "name": "proportionalLayout", - "code": "boolean", - "kind": "property", - "type": { - "type": "intrinsic", - "value": "boolean" - }, "flags": {} - }, - { - "name": "styles", - "code": "ISplitviewStyles", - "kind": "property", - "type": { - "type": "reference", - "value": "ISplitviewStyles", - "source": "dockview-core" - }, - "flags": { - "isOptional": true - } } ], "extends": [] @@ -26349,6 +26278,72 @@ "PanelInitParameters" ] }, + "GridviewOptions": { + "kind": "interface", + "name": "GridviewOptions", + "children": [ + { + "name": "className", + "code": "string", + "kind": "property", + "type": { + "type": "intrinsic", + "value": "string" + }, + "flags": { + "isOptional": true + } + }, + { + "name": "disableAutoResizing", + "code": "boolean", + "kind": "property", + "type": { + "type": "intrinsic", + "value": "boolean" + }, + "flags": { + "isOptional": true + } + }, + { + "name": "hideBorders", + "code": "boolean", + "kind": "property", + "type": { + "type": "intrinsic", + "value": "boolean" + }, + "flags": { + "isOptional": true + } + }, + { + "name": "orientation", + "code": "Orientation", + "kind": "property", + "type": { + "type": "reference", + "value": "Orientation", + "source": "dockview-core" + }, + "flags": {} + }, + { + "name": "proportionalLayout", + "code": "boolean", + "kind": "property", + "type": { + "type": "intrinsic", + "value": "boolean" + }, + "flags": { + "isOptional": true + } + } + ], + "extends": [] + }, "GridviewPanelApi": { "kind": "interface", "name": "GridviewPanelApi", @@ -29132,7 +29127,7 @@ }, { "name": "addFloatingGroup", - "code": "(item: IDockviewPanel | DockviewGroupPanel, options?: FloatingGroupOptions): void", + "code": "(item: DockviewGroupPanel | IDockviewPanel, options?: FloatingGroupOptions): void", "kind": "method", "signature": [ { @@ -29141,18 +29136,18 @@ "parameters": [ { "name": "item", - "code": "item: IDockviewPanel | DockviewGroupPanel", + "code": "item: DockviewGroupPanel | IDockviewPanel", "type": { "type": "or", "values": [ { "type": "reference", - "value": "IDockviewPanel", + "value": "DockviewGroupPanel", "source": "dockview-core" }, { "type": "reference", - "value": "DockviewGroupPanel", + "value": "IDockviewPanel", "source": "dockview-core" } ] @@ -29174,7 +29169,7 @@ "type": "intrinsic", "value": "void" }, - "code": "(item: IDockviewPanel | DockviewGroupPanel, options?: FloatingGroupOptions): void", + "code": "(item: DockviewGroupPanel | IDockviewPanel, options?: FloatingGroupOptions): void", "kind": "callSignature" } ] @@ -29303,7 +29298,7 @@ }, { "name": "addPopoutGroup", - "code": "(item: IDockviewPanel | DockviewGroupPanel, options?: { onDidOpen?: (event: { id: string, window: Window }): void, onWillClose?: (event: { id: string, window: Window }): void, popoutUrl?: string, position?: Box }): Promise", + "code": "(item: DockviewGroupPanel | IDockviewPanel, options?: { onDidOpen?: (event: { id: string, window: Window }): void, onWillClose?: (event: { id: string, window: Window }): void, popoutUrl?: string, position?: Box }): Promise", "kind": "method", "signature": [ { @@ -29312,18 +29307,18 @@ "parameters": [ { "name": "item", - "code": "item: IDockviewPanel | DockviewGroupPanel", + "code": "item: DockviewGroupPanel | IDockviewPanel", "type": { "type": "or", "values": [ { "type": "reference", - "value": "IDockviewPanel", + "value": "DockviewGroupPanel", "source": "dockview-core" }, { "type": "reference", - "value": "DockviewGroupPanel", + "value": "IDockviewPanel", "source": "dockview-core" } ] @@ -29514,7 +29509,7 @@ } ] }, - "code": "(item: IDockviewPanel | DockviewGroupPanel, options?: { onDidOpen?: (event: { id: string, window: Window }): void, onWillClose?: (event: { id: string, window: Window }): void, popoutUrl?: string, position?: Box }): Promise", + "code": "(item: DockviewGroupPanel | IDockviewPanel, options?: { onDidOpen?: (event: { id: string, window: Window }): void, onWillClose?: (event: { id: string, window: Window }): void, popoutUrl?: string, position?: Box }): Promise", "kind": "callSignature" } ] @@ -34446,114 +34441,9 @@ ], "extends": [] }, - "IPaneBodyPart": { - "kind": "interface", - "name": "IPaneBodyPart", - "children": [ - { - "name": "element", - "code": "HTMLElement", - "kind": "property", - "type": { - "type": "reference", - "value": "HTMLElement", - "source": "typescript" - }, - "flags": { - "isReadonly": true - } - }, - { - "name": "dispose", - "code": "(): void", - "kind": "method", - "signature": [ - { - "name": "dispose", - "typeParameters": [], - "parameters": [], - "returnType": { - "type": "intrinsic", - "value": "void" - }, - "code": "(): void", - "kind": "callSignature" - } - ] - }, - { - "name": "init", - "code": "(parameters: PanePanelComponentInitParameter): void", - "kind": "method", - "signature": [ - { - "name": "init", - "typeParameters": [], - "parameters": [ - { - "name": "parameters", - "code": "parameters: PanePanelComponentInitParameter", - "type": { - "type": "reference", - "value": "PanePanelComponentInitParameter", - "source": "dockview-core" - }, - "kind": "parameter" - } - ], - "returnType": { - "type": "intrinsic", - "value": "void" - }, - "code": "(parameters: PanePanelComponentInitParameter): void", - "kind": "callSignature" - } - ] - }, - { - "name": "update", - "code": "(params: PanelUpdateEvent): void", - "kind": "method", - "signature": [ - { - "name": "update", - "typeParameters": [], - "parameters": [ - { - "name": "params", - "code": "params: PanelUpdateEvent", - "type": { - "type": "reference", - "value": "PanelUpdateEvent", - "source": "dockview-core", - "typeArguments": [ - { - "type": "reference", - "value": "Parameters", - "source": "dockview-core" - } - ] - }, - "kind": "parameter" - } - ], - "returnType": { - "type": "intrinsic", - "value": "void" - }, - "code": "(params: PanelUpdateEvent): void", - "kind": "callSignature" - } - ] - } - ], - "extends": [ - "IDisposable" - ] - }, - "IPaneHeaderPart": { + "IPanePart": { "kind": "interface", - "name": "IPaneHeaderPart", + "name": "IPanePart", "children": [ { "name": "element", @@ -38760,124 +38650,251 @@ "PanelInitParameters" ] }, - "PaneviewComponentOptions": { + "PaneviewDndOverlayEvent": { "kind": "interface", - "name": "PaneviewComponentOptions", + "name": "PaneviewDndOverlayEvent", "children": [ { - "name": "className", - "code": "string", + "name": "getData", + "code": "(): PaneTransfer | undefined", "kind": "property", "type": { - "type": "intrinsic", - "value": "string" + "type": "reflection", + "value": { + "name": "__type", + "code": "(): PaneTransfer | undefined", + "kind": "typeLiteral", + "signatures": [ + { + "name": "__type", + "typeParameters": [], + "parameters": [], + "returnType": { + "type": "or", + "values": [ + { + "type": "reference", + "value": "PaneTransfer", + "source": "dockview-core" + }, + { + "type": "intrinsic", + "value": "undefined" + } + ] + }, + "code": "(): PaneTransfer | undefined", + "kind": "callSignature" + } + ] + } }, - "flags": { - "isOptional": true - } + "flags": {} }, { - "name": "components", - "code": "", + "name": "nativeEvent", + "code": "DragEvent", + "kind": "property", + "type": { + "type": "reference", + "value": "DragEvent", + "source": "typescript" + }, + "flags": {} + }, + { + "name": "panel", + "code": "IPaneviewPanel", + "kind": "property", + "type": { + "type": "reference", + "value": "IPaneviewPanel", + "source": "dockview-core" + }, + "flags": {} + } + ], + "extends": [] + }, + "PaneviewDropEvent": { + "kind": "interface", + "name": "PaneviewDropEvent", + "children": [ + { + "name": "api", + "code": "PaneviewApi", + "kind": "property", + "type": { + "type": "reference", + "value": "PaneviewApi", + "source": "dockview-core" + }, + "flags": {} + }, + { + "name": "getData", + "code": "(): PaneTransfer | undefined", "kind": "property", "type": { "type": "reflection", "value": { "name": "__type", - "code": "", - "kind": "typeLiteral" + "code": "(): PaneTransfer | undefined", + "kind": "typeLiteral", + "signatures": [ + { + "name": "__type", + "typeParameters": [], + "parameters": [], + "returnType": { + "type": "or", + "values": [ + { + "type": "reference", + "value": "PaneTransfer", + "source": "dockview-core" + }, + { + "type": "intrinsic", + "value": "undefined" + } + ] + }, + "code": "(): PaneTransfer | undefined", + "kind": "callSignature" + } + ] } }, - "flags": { - "isOptional": true - } + "flags": {} }, { - "name": "disableAutoResizing", - "code": "boolean", + "name": "nativeEvent", + "code": "DragEvent", "kind": "property", "type": { - "type": "intrinsic", - "value": "boolean" + "type": "reference", + "value": "DragEvent", + "source": "typescript" }, "flags": { - "isOptional": true + "isReadonly": true } }, { - "name": "disableDnd", - "code": "boolean", + "name": "panel", + "code": "IPaneviewPanel", "kind": "property", "type": { - "type": "intrinsic", - "value": "boolean" + "type": "reference", + "value": "IPaneviewPanel", + "source": "dockview-core" + }, + "flags": {} + }, + { + "name": "position", + "code": "Position", + "kind": "property", + "type": { + "type": "reference", + "value": "Position", + "source": "dockview-core" }, "flags": { - "isOptional": true + "isReadonly": true } - }, + } + ], + "extends": [ + "DroptargetEvent" + ] + }, + "PaneviewFrameworkOptions": { + "kind": "interface", + "name": "PaneviewFrameworkOptions", + "children": [ { - "name": "frameworkComponents", - "code": "", + "name": "createComponent", + "code": "(options: CreateComponentOptions): IPanePart", "kind": "property", "type": { "type": "reflection", "value": { "name": "__type", - "code": "", - "kind": "typeLiteral" + "code": "(options: CreateComponentOptions): IPanePart", + "kind": "typeLiteral", + "signatures": [ + { + "name": "__type", + "typeParameters": [], + "parameters": [ + { + "name": "options", + "code": "options: CreateComponentOptions", + "type": { + "type": "reference", + "value": "CreateComponentOptions", + "source": "dockview-core" + }, + "kind": "parameter" + } + ], + "returnType": { + "type": "reference", + "value": "IPanePart", + "source": "dockview-core" + }, + "code": "(options: CreateComponentOptions): IPanePart", + "kind": "callSignature" + } + ] } }, - "flags": { - "isOptional": true - } + "flags": {} }, { - "name": "frameworkWrapper", - "code": "{ body: FrameworkFactory, header: FrameworkFactory }", + "name": "createHeaderComponent", + "code": "(options: CreateComponentOptions): IPanePart | undefined", "kind": "property", "type": { "type": "reflection", "value": { "name": "__type", - "code": "{ body: FrameworkFactory, header: FrameworkFactory }", + "code": "(options: CreateComponentOptions): IPanePart | undefined", "kind": "typeLiteral", - "properties": [ + "signatures": [ { - "name": "body", - "code": "FrameworkFactory", - "kind": "property", - "type": { - "type": "reference", - "value": "FrameworkFactory", - "source": "dockview-core", - "typeArguments": [ - { + "name": "__type", + "typeParameters": [], + "parameters": [ + { + "name": "options", + "code": "options: CreateComponentOptions", + "type": { "type": "reference", - "value": "IPaneBodyPart", + "value": "CreateComponentOptions", "source": "dockview-core" - } - ] - }, - "flags": {} - }, - { - "name": "header", - "code": "FrameworkFactory", - "kind": "property", - "type": { - "type": "reference", - "value": "FrameworkFactory", - "source": "dockview-core", - "typeArguments": [ + }, + "kind": "parameter" + } + ], + "returnType": { + "type": "or", + "values": [ { "type": "reference", - "value": "IPaneHeaderPart", + "value": "IPanePart", "source": "dockview-core" + }, + { + "type": "intrinsic", + "value": "undefined" } ] }, - "flags": {} + "code": "(options: CreateComponentOptions): IPanePart | undefined", + "kind": "callSignature" } ] } @@ -38885,34 +38902,45 @@ "flags": { "isOptional": true } + } + ], + "extends": [] + }, + "PaneviewOptions": { + "kind": "interface", + "name": "PaneviewOptions", + "children": [ + { + "name": "className", + "code": "string", + "kind": "property", + "type": { + "type": "intrinsic", + "value": "string" + }, + "flags": { + "isOptional": true + } }, { - "name": "headerComponents", - "code": "", + "name": "disableAutoResizing", + "code": "boolean", "kind": "property", "type": { - "type": "reflection", - "value": { - "name": "__type", - "code": "", - "kind": "typeLiteral" - } + "type": "intrinsic", + "value": "boolean" }, "flags": { "isOptional": true } }, { - "name": "headerframeworkComponents", - "code": "", + "name": "disableDnd", + "code": "boolean", "kind": "property", "type": { - "type": "reflection", - "value": { - "name": "__type", - "code": "", - "kind": "typeLiteral" - } + "type": "intrinsic", + "value": "boolean" }, "flags": { "isOptional": true @@ -38961,166 +38989,6 @@ ], "extends": [] }, - "PaneviewDndOverlayEvent": { - "kind": "interface", - "name": "PaneviewDndOverlayEvent", - "children": [ - { - "name": "getData", - "code": "(): PaneTransfer | undefined", - "kind": "property", - "type": { - "type": "reflection", - "value": { - "name": "__type", - "code": "(): PaneTransfer | undefined", - "kind": "typeLiteral", - "signatures": [ - { - "name": "__type", - "typeParameters": [], - "parameters": [], - "returnType": { - "type": "or", - "values": [ - { - "type": "reference", - "value": "PaneTransfer", - "source": "dockview-core" - }, - { - "type": "intrinsic", - "value": "undefined" - } - ] - }, - "code": "(): PaneTransfer | undefined", - "kind": "callSignature" - } - ] - } - }, - "flags": {} - }, - { - "name": "nativeEvent", - "code": "DragEvent", - "kind": "property", - "type": { - "type": "reference", - "value": "DragEvent", - "source": "typescript" - }, - "flags": {} - }, - { - "name": "panel", - "code": "IPaneviewPanel", - "kind": "property", - "type": { - "type": "reference", - "value": "IPaneviewPanel", - "source": "dockview-core" - }, - "flags": {} - } - ], - "extends": [] - }, - "PaneviewDropEvent": { - "kind": "interface", - "name": "PaneviewDropEvent", - "children": [ - { - "name": "api", - "code": "PaneviewApi", - "kind": "property", - "type": { - "type": "reference", - "value": "PaneviewApi", - "source": "dockview-core" - }, - "flags": {} - }, - { - "name": "getData", - "code": "(): PaneTransfer | undefined", - "kind": "property", - "type": { - "type": "reflection", - "value": { - "name": "__type", - "code": "(): PaneTransfer | undefined", - "kind": "typeLiteral", - "signatures": [ - { - "name": "__type", - "typeParameters": [], - "parameters": [], - "returnType": { - "type": "or", - "values": [ - { - "type": "reference", - "value": "PaneTransfer", - "source": "dockview-core" - }, - { - "type": "intrinsic", - "value": "undefined" - } - ] - }, - "code": "(): PaneTransfer | undefined", - "kind": "callSignature" - } - ] - } - }, - "flags": {} - }, - { - "name": "nativeEvent", - "code": "DragEvent", - "kind": "property", - "type": { - "type": "reference", - "value": "DragEvent", - "source": "typescript" - }, - "flags": { - "isReadonly": true - } - }, - { - "name": "panel", - "code": "IPaneviewPanel", - "kind": "property", - "type": { - "type": "reference", - "value": "IPaneviewPanel", - "source": "dockview-core" - }, - "flags": {} - }, - { - "name": "position", - "code": "Position", - "kind": "property", - "type": { - "type": "reference", - "value": "Position", - "source": "dockview-core" - }, - "flags": { - "isReadonly": true - } - } - ], - "extends": [ - "DroptargetEvent" - ] - }, "PaneviewPanelApi": { "kind": "interface", "name": "PaneviewPanelApi", @@ -40579,8 +40447,7 @@ "source": "dockview-core" }, "flags": { - "isOptional": true, - "isReadonly": true + "isOptional": true } }, { @@ -40592,8 +40459,7 @@ "value": "number" }, "flags": { - "isOptional": true, - "isReadonly": true + "isOptional": true } }, { @@ -40605,9 +40471,7 @@ "value": "Orientation", "source": "dockview-core" }, - "flags": { - "isReadonly": true - } + "flags": {} }, { "name": "proportionalLayout", @@ -40618,8 +40482,7 @@ "value": "boolean" }, "flags": { - "isOptional": true, - "isReadonly": true + "isOptional": true } }, { @@ -40632,41 +40495,70 @@ "source": "dockview-core" }, "flags": { - "isOptional": true, - "isReadonly": true + "isOptional": true } } ], "extends": [] }, - "SplitviewComponentOptions": { + "SplitviewFrameworkOptions": { "kind": "interface", - "name": "SplitviewComponentOptions", + "name": "SplitviewFrameworkOptions", "children": [ { - "name": "className", - "code": "string", - "kind": "property", - "type": { - "type": "intrinsic", - "value": "string" - }, - "flags": { - "isOptional": true - } - }, - { - "name": "components", - "code": "", + "name": "createComponent", + "code": "(options: CreateComponentOptions): SplitviewPanel", "kind": "property", "type": { "type": "reflection", "value": { "name": "__type", - "code": "", - "kind": "typeLiteral" + "code": "(options: CreateComponentOptions): SplitviewPanel", + "kind": "typeLiteral", + "signatures": [ + { + "name": "__type", + "typeParameters": [], + "parameters": [ + { + "name": "options", + "code": "options: CreateComponentOptions", + "type": { + "type": "reference", + "value": "CreateComponentOptions", + "source": "dockview-core" + }, + "kind": "parameter" + } + ], + "returnType": { + "type": "reference", + "value": "SplitviewPanel", + "source": "dockview-core" + }, + "code": "(options: CreateComponentOptions): SplitviewPanel", + "kind": "callSignature" + } + ] } }, + "flags": {} + } + ], + "extends": [] + }, + "SplitviewOptions": { + "kind": "interface", + "name": "SplitviewOptions", + "children": [ + { + "name": "className", + "code": "string", + "kind": "property", + "type": { + "type": "intrinsic", + "value": "string" + }, "flags": { "isOptional": true } @@ -40681,8 +40573,7 @@ "source": "dockview-core" }, "flags": { - "isOptional": true, - "isReadonly": true + "isOptional": true } }, { @@ -40697,42 +40588,6 @@ "isOptional": true } }, - { - "name": "frameworkComponents", - "code": "", - "kind": "property", - "type": { - "type": "reflection", - "value": { - "name": "__type", - "code": "", - "kind": "typeLiteral" - } - }, - "flags": { - "isOptional": true - } - }, - { - "name": "frameworkWrapper", - "code": "FrameworkFactory", - "kind": "property", - "type": { - "type": "reference", - "value": "FrameworkFactory", - "source": "dockview-core", - "typeArguments": [ - { - "type": "reference", - "value": "SplitviewPanel", - "source": "dockview-core" - } - ] - }, - "flags": { - "isOptional": true - } - }, { "name": "margin", "code": "number", @@ -40742,8 +40597,7 @@ "value": "number" }, "flags": { - "isOptional": true, - "isReadonly": true + "isOptional": true } }, { @@ -40755,9 +40609,7 @@ "value": "Orientation", "source": "dockview-core" }, - "flags": { - "isReadonly": true - } + "flags": {} }, { "name": "proportionalLayout", @@ -40768,8 +40620,7 @@ "value": "boolean" }, "flags": { - "isOptional": true, - "isReadonly": true + "isOptional": true } }, { @@ -40782,8 +40633,7 @@ "source": "dockview-core" }, "flags": { - "isOptional": true, - "isReadonly": true + "isOptional": true } } ], @@ -42028,6 +41878,27 @@ }, "kind": "typeAlias" }, + "GridviewComponentOptions": { + "name": "GridviewComponentOptions", + "code": "GridviewFrameworkOptions & GridviewOptions", + "typeParameters": [], + "type": { + "type": "intersection", + "values": [ + { + "type": "reference", + "value": "GridviewFrameworkOptions", + "source": "dockview-core" + }, + { + "type": "reference", + "value": "GridviewOptions", + "source": "dockview-core" + } + ] + }, + "kind": "typeAlias" + }, "IDockviewGroupPanelPublic": { "name": "IDockviewGroupPanelPublic", "code": "IDockviewGroupPanel", @@ -42179,6 +42050,27 @@ }, "kind": "typeAlias" }, + "PaneviewComponentOptions": { + "name": "PaneviewComponentOptions", + "code": "PaneviewFrameworkOptions & PaneviewOptions", + "typeParameters": [], + "type": { + "type": "intersection", + "values": [ + { + "type": "reference", + "value": "PaneviewFrameworkOptions", + "source": "dockview-core" + }, + { + "type": "reference", + "value": "PaneviewOptions", + "source": "dockview-core" + } + ] + }, + "kind": "typeAlias" + }, "Position": { "name": "Position", "code": "'center' | 'right' | 'left' | 'bottom' | 'top'", @@ -42246,8 +42138,44 @@ }, "kind": "typeAlias" }, - "PROPERTY_KEYS": { - "name": "PROPERTY_KEYS", + "SplitviewComponentOptions": { + "name": "SplitviewComponentOptions", + "code": "SplitviewFrameworkOptions & SplitviewOptions", + "typeParameters": [], + "type": { + "type": "intersection", + "values": [ + { + "type": "reference", + "value": "SplitviewFrameworkOptions", + "source": "dockview-core" + }, + { + "type": "reference", + "value": "SplitviewOptions", + "source": "dockview-core" + } + ] + }, + "kind": "typeAlias" + }, + "PROPERTY_KEYS_DOCKVIEW": { + "name": "PROPERTY_KEYS_DOCKVIEW", + "code": "", + "kind": "variable" + }, + "PROPERTY_KEYS_GRIDVIEW": { + "name": "PROPERTY_KEYS_GRIDVIEW", + "code": "", + "kind": "variable" + }, + "PROPERTY_KEYS_PANEVIEW": { + "name": "PROPERTY_KEYS_PANEVIEW", + "code": "", + "kind": "variable" + }, + "PROPERTY_KEYS_SPLITVIEW": { + "name": "PROPERTY_KEYS_SPLITVIEW", "code": "", "kind": "variable" }, @@ -43021,18 +42949,6 @@ "kind": "interface", "name": "IDockviewReactProps", "children": [ - { - "name": "className", - "code": "string", - "kind": "property", - "type": { - "type": "intrinsic", - "value": "string" - }, - "flags": { - "isOptional": true - } - }, { "name": "components", "code": "Record>", @@ -43363,18 +43279,6 @@ "kind": "interface", "name": "IGridviewReactProps", "children": [ - { - "name": "className", - "code": "string", - "kind": "property", - "type": { - "type": "intrinsic", - "value": "string" - }, - "flags": { - "isOptional": true - } - }, { "name": "components", "code": "Record>>", @@ -43410,30 +43314,6 @@ }, "flags": {} }, - { - "name": "disableAutoResizing", - "code": "boolean", - "kind": "property", - "type": { - "type": "intrinsic", - "value": "boolean" - }, - "flags": { - "isOptional": true - } - }, - { - "name": "hideBorders", - "code": "boolean", - "kind": "property", - "type": { - "type": "intrinsic", - "value": "boolean" - }, - "flags": { - "isOptional": true - } - }, { "name": "onReady", "code": "(event: GridviewReadyEvent): void", @@ -43471,44 +43351,11 @@ } }, "flags": {} - }, - { - "name": "orientation", - "code": "Orientation.VERTICAL | Orientation.HORIZONTAL", - "kind": "property", - "type": { - "type": "or", - "values": [ - { - "type": "reference", - "value": "Orientation.VERTICAL", - "source": "dockview-core" - }, - { - "type": "reference", - "value": "Orientation.HORIZONTAL", - "source": "dockview-core" - } - ] - }, - "flags": { - "isOptional": true - } - }, - { - "name": "proportionalLayout", - "code": "boolean", - "kind": "property", - "type": { - "type": "intrinsic", - "value": "boolean" - }, - "flags": { - "isOptional": true - } } ], - "extends": [] + "extends": [ + "GridviewOptions" + ] }, "IPaneviewPanelProps": { "kind": "interface", @@ -43567,18 +43414,6 @@ "kind": "interface", "name": "IPaneviewReactProps", "children": [ - { - "name": "className", - "code": "string", - "kind": "property", - "type": { - "type": "intrinsic", - "value": "string" - }, - "flags": { - "isOptional": true - } - }, { "name": "components", "code": "Record>>", @@ -43614,30 +43449,6 @@ }, "flags": {} }, - { - "name": "disableAutoResizing", - "code": "boolean", - "kind": "property", - "type": { - "type": "intrinsic", - "value": "boolean" - }, - "flags": { - "isOptional": true - } - }, - { - "name": "disableDnd", - "code": "boolean", - "kind": "property", - "type": { - "type": "intrinsic", - "value": "boolean" - }, - "flags": { - "isOptional": true - } - }, { "name": "headerComponents", "code": "Record>>", @@ -43783,7 +43594,9 @@ ] } ], - "extends": [] + "extends": [ + "PaneviewOptions" + ] }, "ISplitviewPanelProps": { "kind": "interface", @@ -43832,18 +43645,6 @@ "kind": "interface", "name": "ISplitviewReactProps", "children": [ - { - "name": "className", - "code": "string", - "kind": "property", - "type": { - "type": "intrinsic", - "value": "string" - }, - "flags": { - "isOptional": true - } - }, { "name": "components", "code": "Record>>", @@ -43879,30 +43680,6 @@ }, "flags": {} }, - { - "name": "disableAutoResizing", - "code": "boolean", - "kind": "property", - "type": { - "type": "intrinsic", - "value": "boolean" - }, - "flags": { - "isOptional": true - } - }, - { - "name": "hideBorders", - "code": "boolean", - "kind": "property", - "type": { - "type": "intrinsic", - "value": "boolean" - }, - "flags": { - "isOptional": true - } - }, { "name": "onReady", "code": "(event: SplitviewReadyEvent): void", @@ -43940,44 +43717,11 @@ } }, "flags": {} - }, - { - "name": "orientation", - "code": "Orientation.VERTICAL | Orientation.HORIZONTAL", - "kind": "property", - "type": { - "type": "or", - "values": [ - { - "type": "reference", - "value": "Orientation.VERTICAL", - "source": "dockview-core" - }, - { - "type": "reference", - "value": "Orientation.HORIZONTAL", - "source": "dockview-core" - } - ] - }, - "flags": { - "isOptional": true - } - }, - { - "name": "proportionalLayout", - "code": "boolean", - "kind": "property", - "type": { - "type": "intrinsic", - "value": "boolean" - }, - "flags": { - "isOptional": true - } } ], - "extends": [] + "extends": [ + "SplitviewOptions" + ] }, "PanelParameters": { "kind": "interface", @@ -44159,6 +43903,11 @@ }, "kind": "typeAlias" }, + "ReactPartContext": { + "name": "ReactPartContext", + "code": "", + "kind": "variable" + }, "DockviewDefaultTab": { "kind": "function", "name": "DockviewDefaultTab", @@ -44712,7 +44461,7 @@ "summary": [ { "kind": "text", - "text": "A React Hook that returns an array of portals to be rendered by the user of this hook\nand a disposable function to add a portal. Calling dispose removes this portal from the\nportal array" + "text": "A React Hook that returns an array of portals to be rendered by the user of this hook\r\nand a disposable function to add a portal. Calling dispose removes this portal from the\r\nportal array" } ] },