diff --git a/packages/docs/src/generated/api.output.json b/packages/docs/src/generated/api.output.json index d7024baab..2e827390f 100644 --- a/packages/docs/src/generated/api.output.json +++ b/packages/docs/src/generated/api.output.json @@ -315,6 +315,34 @@ "isReadonly": true } }, + { + "name": "onDidMaximizedChange", + "code": "Event>", + "kind": "property", + "type": { + "type": "reference", + "value": "Event", + "source": "dockview-core", + "typeArguments": [ + { + "type": "reference", + "value": "MaximizedChanged", + "source": "dockview-core", + "typeArguments": [ + { + "type": "reference", + "value": "T", + "source": "dockview-core", + "refersToTypeParameter": true + } + ] + } + ] + }, + "flags": { + "isReadonly": true + } + }, { "name": "onDidRemove", "code": "Event", @@ -540,27 +568,6 @@ } } }, - { - "name": "onDidMaximizedGroupChange", - "code": "Event", - "kind": "accessor", - "value": { - "name": "onDidMaximizedGroupChange", - "code": "Event", - "kind": "getSignature", - "returnType": { - "type": "reference", - "value": "Event", - "source": "dockview-core", - "typeArguments": [ - { - "type": "intrinsic", - "value": "void" - } - ] - } - } - }, { "name": "size", "code": "number", @@ -2352,11 +2359,11 @@ }, { "name": "onDidMaximizedGroupChange", - "code": "Event", + "code": "Event", "kind": "accessor", "value": { "name": "onDidMaximizedGroupChange", - "code": "Event", + "code": "Event", "kind": "getSignature", "returnType": { "type": "reference", @@ -2364,8 +2371,9 @@ "source": "dockview-core", "typeArguments": [ { - "type": "intrinsic", - "value": "void" + "type": "reference", + "value": "DockviewMaximizedGroupChanged", + "source": "dockview-core" } ] } @@ -4356,6 +4364,53 @@ "isReadonly": true } }, + { + "name": "onDidMaximizedChange", + "code": "Event>", + "kind": "property", + "type": { + "type": "reference", + "value": "Event", + "source": "dockview-core", + "typeArguments": [ + { + "type": "reference", + "value": "MaximizedChanged", + "source": "dockview-core", + "typeArguments": [ + { + "type": "reference", + "value": "DockviewGroupPanel", + "source": "dockview-core" + } + ] + } + ] + }, + "flags": { + "isReadonly": true + } + }, + { + "name": "onDidMaximizedGroupChange", + "code": "Event", + "kind": "property", + "type": { + "type": "reference", + "value": "Event", + "source": "dockview-core", + "typeArguments": [ + { + "type": "reference", + "value": "DockviewMaximizedGroupChanged", + "source": "dockview-core" + } + ] + }, + "flags": { + "isReadonly": true + } + }, { "name": "onDidMovePanel", "code": "Event", @@ -4824,27 +4879,6 @@ } } }, - { - "name": "onDidMaximizedGroupChange", - "code": "Event", - "kind": "accessor", - "value": { - "name": "onDidMaximizedGroupChange", - "code": "Event", - "kind": "getSignature", - "returnType": { - "type": "reference", - "value": "Event", - "source": "dockview-core", - "typeArguments": [ - { - "type": "intrinsic", - "value": "void" - } - ] - } - } - }, { "name": "options", "code": "DockviewComponentOptions", @@ -5155,7 +5189,7 @@ }, { "name": "addPopoutGroup", - "code": "(itemToPopout: DockviewPanel | DockviewGroupPanel, options?: { onDidOpen?: (event: { id: string, window: Window }): void, onWillClose?: (event: { id: string, window: Window }): void, overridePopoutGroup?: DockviewGroupPanel, popoutUrl?: string, position?: Box }): Promise", + "code": "(itemToPopout: DockviewPanel | DockviewGroupPanel, options?: DockviewPopoutGroupOptions): Promise", "kind": "method", "signature": [ { @@ -5184,186 +5218,11 @@ }, { "name": "options", - "code": "options?: { onDidOpen?: (event: { id: string, window: Window }): void, onWillClose?: (event: { id: string, window: Window }): void, overridePopoutGroup?: DockviewGroupPanel, popoutUrl?: string, position?: Box }", + "code": "options?: DockviewPopoutGroupOptions", "type": { - "type": "reflection", - "value": { - "name": "__type", - "code": "{ onDidOpen?: (event: { id: string, window: Window }): void, onWillClose?: (event: { id: string, window: Window }): void, overridePopoutGroup?: DockviewGroupPanel, popoutUrl?: string, position?: Box }", - "kind": "typeLiteral", - "properties": [ - { - "name": "onDidOpen", - "code": "(event: { id: string, window: Window }): void", - "kind": "property", - "type": { - "type": "reflection", - "value": { - "name": "__type", - "code": "(event: { id: string, window: Window }): void", - "kind": "typeLiteral", - "signatures": [ - { - "name": "__type", - "typeParameters": [], - "parameters": [ - { - "name": "event", - "code": "event: { id: string, window: Window }", - "type": { - "type": "reflection", - "value": { - "name": "__type", - "code": "{ id: string, window: Window }", - "kind": "typeLiteral", - "properties": [ - { - "name": "id", - "code": "string", - "kind": "property", - "type": { - "type": "intrinsic", - "value": "string" - }, - "flags": {} - }, - { - "name": "window", - "code": "Window", - "kind": "property", - "type": { - "type": "reference", - "value": "Window", - "source": "typescript" - }, - "flags": {} - } - ] - } - }, - "kind": "parameter" - } - ], - "returnType": { - "type": "intrinsic", - "value": "void" - }, - "code": "(event: { id: string, window: Window }): void", - "kind": "callSignature" - } - ] - } - }, - "flags": { - "isOptional": true - } - }, - { - "name": "onWillClose", - "code": "(event: { id: string, window: Window }): void", - "kind": "property", - "type": { - "type": "reflection", - "value": { - "name": "__type", - "code": "(event: { id: string, window: Window }): void", - "kind": "typeLiteral", - "signatures": [ - { - "name": "__type", - "typeParameters": [], - "parameters": [ - { - "name": "event", - "code": "event: { id: string, window: Window }", - "type": { - "type": "reflection", - "value": { - "name": "__type", - "code": "{ id: string, window: Window }", - "kind": "typeLiteral", - "properties": [ - { - "name": "id", - "code": "string", - "kind": "property", - "type": { - "type": "intrinsic", - "value": "string" - }, - "flags": {} - }, - { - "name": "window", - "code": "Window", - "kind": "property", - "type": { - "type": "reference", - "value": "Window", - "source": "typescript" - }, - "flags": {} - } - ] - } - }, - "kind": "parameter" - } - ], - "returnType": { - "type": "intrinsic", - "value": "void" - }, - "code": "(event: { id: string, window: Window }): void", - "kind": "callSignature" - } - ] - } - }, - "flags": { - "isOptional": true - } - }, - { - "name": "overridePopoutGroup", - "code": "DockviewGroupPanel", - "kind": "property", - "type": { - "type": "reference", - "value": "DockviewGroupPanel", - "source": "dockview-core" - }, - "flags": { - "isOptional": true - } - }, - { - "name": "popoutUrl", - "code": "string", - "kind": "property", - "type": { - "type": "intrinsic", - "value": "string" - }, - "flags": { - "isOptional": true - } - }, - { - "name": "position", - "code": "Box", - "kind": "property", - "type": { - "type": "reference", - "value": "Box", - "source": "dockview-core" - }, - "flags": { - "isOptional": true - } - } - ] - } + "type": "reference", + "value": "DockviewPopoutGroupOptions", + "source": "dockview-core" }, "kind": "parameter" } @@ -5379,7 +5238,7 @@ } ] }, - "code": "(itemToPopout: DockviewPanel | DockviewGroupPanel, options?: { onDidOpen?: (event: { id: string, window: Window }): void, onWillClose?: (event: { id: string, window: Window }): void, overridePopoutGroup?: DockviewGroupPanel, popoutUrl?: string, position?: Box }): Promise", + "code": "(itemToPopout: DockviewPanel | DockviewGroupPanel, options?: DockviewPopoutGroupOptions): Promise", "kind": "callSignature" } ] @@ -6261,7 +6120,7 @@ }, { "name": "removePanel", - "code": "(panel: IDockviewPanel, options: { removeEmptyGroup: boolean, skipDispose: boolean, skipSetActiveGroup?: boolean }): void", + "code": "(panel: IDockviewPanel, options: { removeEmptyGroup: boolean, skipDispose?: boolean, skipSetActiveGroup?: boolean }): void", "kind": "method", "signature": [ { @@ -6280,12 +6139,12 @@ }, { "name": "options", - "code": "options: { removeEmptyGroup: boolean, skipDispose: boolean, skipSetActiveGroup?: boolean }", + "code": "options: { removeEmptyGroup: boolean, skipDispose?: boolean, skipSetActiveGroup?: boolean }", "type": { "type": "reflection", "value": { "name": "__type", - "code": "{ removeEmptyGroup: boolean, skipDispose: boolean, skipSetActiveGroup?: boolean }", + "code": "{ removeEmptyGroup: boolean, skipDispose?: boolean, skipSetActiveGroup?: boolean }", "kind": "typeLiteral", "properties": [ { @@ -6306,7 +6165,9 @@ "type": "intrinsic", "value": "boolean" }, - "flags": {} + "flags": { + "isOptional": true + } }, { "name": "skipSetActiveGroup", @@ -6330,7 +6191,7 @@ "type": "intrinsic", "value": "void" }, - "code": "(panel: IDockviewPanel, options: { removeEmptyGroup: boolean, skipDispose: boolean, skipSetActiveGroup?: boolean }): void", + "code": "(panel: IDockviewPanel, options: { removeEmptyGroup: boolean, skipDispose?: boolean, skipSetActiveGroup?: boolean }): void", "kind": "callSignature" } ] @@ -10682,7 +10543,7 @@ }, { "name": "onDidMaximizedNodeChange", - "code": "Event", + "code": "Event", "kind": "property", "type": { "type": "reference", @@ -10690,8 +10551,9 @@ "source": "dockview-core", "typeArguments": [ { - "type": "intrinsic", - "value": "void" + "type": "reference", + "value": "MaximizedViewChanged", + "source": "dockview-core" } ] }, @@ -13011,6 +12873,40 @@ "isReadonly": true } }, + { + "name": "onDidMaximizedChange", + "code": "Event>>", + "kind": "property", + "type": { + "type": "reference", + "value": "Event", + "source": "dockview-core", + "typeArguments": [ + { + "type": "reference", + "value": "MaximizedChanged", + "source": "dockview-core", + "typeArguments": [ + { + "type": "reference", + "value": "GridviewPanel", + "source": "dockview-core", + "typeArguments": [ + { + "type": "reference", + "value": "GridviewPanelApiImpl", + "source": "dockview-core" + } + ] + } + ] + } + ] + }, + "flags": { + "isReadonly": true + } + }, { "name": "onDidRemove", "code": "Event>", @@ -13293,27 +13189,6 @@ } } }, - { - "name": "onDidMaximizedGroupChange", - "code": "Event", - "kind": "accessor", - "value": { - "name": "onDidMaximizedGroupChange", - "code": "Event", - "kind": "getSignature", - "returnType": { - "type": "reference", - "value": "Event", - "source": "dockview-core", - "typeArguments": [ - { - "type": "intrinsic", - "value": "void" - } - ] - } - } - }, { "name": "options", "code": "GridviewComponentOptions", @@ -24313,6 +24188,34 @@ ], "extends": [] }, + "DockviewMaximizedGroupChanged": { + "kind": "interface", + "name": "DockviewMaximizedGroupChanged", + "children": [ + { + "name": "group", + "code": "DockviewGroupPanel", + "kind": "property", + "type": { + "type": "reference", + "value": "DockviewGroupPanel", + "source": "dockview-core" + }, + "flags": {} + }, + { + "name": "isMaximized", + "code": "boolean", + "kind": "property", + "type": { + "type": "intrinsic", + "value": "boolean" + }, + "flags": {} + } + ], + "extends": [] + }, "DockviewOptions": { "kind": "interface", "name": "DockviewOptions", @@ -24517,6 +24420,43 @@ "isOptional": true } }, + { + "name": "noPanelsOverlay", + "code": "'watermark' | 'emptyGroup'", + "kind": "property", + "type": { + "type": "or", + "values": [ + { + "type": "literal", + "value": "watermark" + }, + { + "type": "literal", + "value": "emptyGroup" + } + ] + }, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Define the behaviour of the dock when there are no panels to display. Defaults to " + }, + { + "kind": "code", + "text": "`watermark`" + }, + { + "kind": "text", + "text": "." + } + ] + } + }, { "name": "popoutUrl", "code": "string", @@ -25333,6 +25273,207 @@ ], "extends": [] }, + "DockviewPopoutGroupOptions": { + "kind": "interface", + "name": "DockviewPopoutGroupOptions", + "children": [ + { + "name": "onDidOpen", + "code": "(event: { id: string, window: Window }): void", + "kind": "property", + "type": { + "type": "reflection", + "value": { + "name": "__type", + "code": "(event: { id: string, window: Window }): void", + "kind": "typeLiteral", + "signatures": [ + { + "name": "__type", + "typeParameters": [], + "parameters": [ + { + "name": "event", + "code": "event: { id: string, window: Window }", + "type": { + "type": "reflection", + "value": { + "name": "__type", + "code": "{ id: string, window: Window }", + "kind": "typeLiteral", + "properties": [ + { + "name": "id", + "code": "string", + "kind": "property", + "type": { + "type": "intrinsic", + "value": "string" + }, + "flags": {} + }, + { + "name": "window", + "code": "Window", + "kind": "property", + "type": { + "type": "reference", + "value": "Window", + "source": "typescript" + }, + "flags": {} + } + ] + } + }, + "kind": "parameter" + } + ], + "returnType": { + "type": "intrinsic", + "value": "void" + }, + "code": "(event: { id: string, window: Window }): void", + "kind": "callSignature" + } + ] + } + }, + "flags": { + "isOptional": true + } + }, + { + "name": "onWillClose", + "code": "(event: { id: string, window: Window }): void", + "kind": "property", + "type": { + "type": "reflection", + "value": { + "name": "__type", + "code": "(event: { id: string, window: Window }): void", + "kind": "typeLiteral", + "signatures": [ + { + "name": "__type", + "typeParameters": [], + "parameters": [ + { + "name": "event", + "code": "event: { id: string, window: Window }", + "type": { + "type": "reflection", + "value": { + "name": "__type", + "code": "{ id: string, window: Window }", + "kind": "typeLiteral", + "properties": [ + { + "name": "id", + "code": "string", + "kind": "property", + "type": { + "type": "intrinsic", + "value": "string" + }, + "flags": {} + }, + { + "name": "window", + "code": "Window", + "kind": "property", + "type": { + "type": "reference", + "value": "Window", + "source": "typescript" + }, + "flags": {} + } + ] + } + }, + "kind": "parameter" + } + ], + "returnType": { + "type": "intrinsic", + "value": "void" + }, + "code": "(event: { id: string, window: Window }): void", + "kind": "callSignature" + } + ] + } + }, + "flags": { + "isOptional": true + } + }, + { + "name": "overridePopoutGroup", + "code": "DockviewGroupPanel", + "kind": "property", + "type": { + "type": "reference", + "value": "DockviewGroupPanel", + "source": "dockview-core" + }, + "flags": { + "isOptional": true + } + }, + { + "name": "popoutUrl", + "code": "string", + "kind": "property", + "type": { + "type": "intrinsic", + "value": "string" + }, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The same-origin path at which the popout window will be created\n\nDefaults to " + }, + { + "kind": "code", + "text": "`/popout.html`" + }, + { + "kind": "text", + "text": " if not provided" + } + ] + } + }, + { + "name": "position", + "code": "Box", + "kind": "property", + "type": { + "type": "reference", + "value": "Box", + "source": "dockview-core" + }, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The position of the popout group" + } + ] + } + } + ], + "extends": [] + }, "DockviewReadyEvent": { "kind": "interface", "name": "DockviewReadyEvent", @@ -27325,8 +27466,8 @@ } }, { - "name": "onDidMaximizedGroupChange", - "code": "Event", + "name": "onDidMaximizedChange", + "code": "Event>", "kind": "property", "type": { "type": "reference", @@ -27334,8 +27475,17 @@ "source": "dockview-core", "typeArguments": [ { - "type": "intrinsic", - "value": "void" + "type": "reference", + "value": "MaximizedChanged", + "source": "dockview-core", + "typeArguments": [ + { + "type": "reference", + "value": "T", + "source": "dockview-core", + "refersToTypeParameter": true + } + ] } ] }, @@ -28657,9 +28807,36 @@ "isReadonly": true } }, + { + "name": "onDidMaximizedChange", + "code": "Event>", + "kind": "property", + "type": { + "type": "reference", + "value": "Event", + "source": "dockview-core", + "typeArguments": [ + { + "type": "reference", + "value": "MaximizedChanged", + "source": "dockview-core", + "typeArguments": [ + { + "type": "reference", + "value": "DockviewGroupPanel", + "source": "dockview-core" + } + ] + } + ] + }, + "flags": { + "isReadonly": true + } + }, { "name": "onDidMaximizedGroupChange", - "code": "Event", + "code": "Event", "kind": "property", "type": { "type": "reference", @@ -28667,8 +28844,9 @@ "source": "dockview-core", "typeArguments": [ { - "type": "intrinsic", - "value": "void" + "type": "reference", + "value": "DockviewMaximizedGroupChanged", + "source": "dockview-core" } ] }, @@ -33038,8 +33216,8 @@ } }, { - "name": "onDidMaximizedGroupChange", - "code": "Event", + "name": "onDidMaximizedChange", + "code": "Event>>", "kind": "property", "type": { "type": "reference", @@ -33047,8 +33225,23 @@ "source": "dockview-core", "typeArguments": [ { - "type": "intrinsic", - "value": "void" + "type": "reference", + "value": "MaximizedChanged", + "source": "dockview-core", + "typeArguments": [ + { + "type": "reference", + "value": "GridviewPanel", + "source": "dockview-core", + "typeArguments": [ + { + "type": "reference", + "value": "GridviewPanelApiImpl", + "source": "dockview-core" + } + ] + } + ] } ] }, @@ -37421,6 +37614,63 @@ "Optional" ] }, + "MaximizedChanged": { + "kind": "interface", + "name": "MaximizedChanged", + "children": [ + { + "name": "isMaximized", + "code": "boolean", + "kind": "property", + "type": { + "type": "intrinsic", + "value": "boolean" + }, + "flags": {} + }, + { + "name": "panel", + "code": "MaximizedChanged.T", + "kind": "property", + "type": { + "type": "reference", + "value": "T", + "source": "dockview-core", + "refersToTypeParameter": true + }, + "flags": {} + } + ], + "extends": [] + }, + "MaximizedViewChanged": { + "kind": "interface", + "name": "MaximizedViewChanged", + "children": [ + { + "name": "isMaximized", + "code": "boolean", + "kind": "property", + "type": { + "type": "intrinsic", + "value": "boolean" + }, + "flags": {} + }, + { + "name": "view", + "code": "IGridView", + "kind": "property", + "type": { + "type": "reference", + "value": "IGridView", + "source": "dockview-core" + }, + "flags": {} + } + ], + "extends": [] + }, "MovePanelEvent": { "kind": "interface", "name": "MovePanelEvent", @@ -39720,6 +39970,19 @@ }, "flags": {} }, + { + "name": "maximizedNode", + "code": "SerializedNodeDescriptor", + "kind": "property", + "type": { + "type": "reference", + "value": "SerializedNodeDescriptor", + "source": "dockview-core" + }, + "flags": { + "isOptional": true + } + }, { "name": "orientation", "code": "Orientation", @@ -39800,6 +40063,26 @@ ], "extends": [] }, + "SerializedNodeDescriptor": { + "kind": "interface", + "name": "SerializedNodeDescriptor", + "children": [ + { + "name": "location", + "code": "number[]", + "kind": "property", + "type": { + "type": "array", + "value": { + "type": "intrinsic", + "value": "number" + } + }, + "flags": {} + } + ], + "extends": [] + }, "SerializedPaneview": { "kind": "interface", "name": "SerializedPaneview", @@ -40044,6 +40327,18 @@ ] }, "flags": {} + }, + { + "name": "url", + "code": "string", + "kind": "property", + "type": { + "type": "intrinsic", + "value": "string" + }, + "flags": { + "isOptional": true + } } ], "extends": [] @@ -41496,7 +41791,7 @@ }, "DockviewGroupLocation": { "name": "DockviewGroupLocation", - "code": "{ getWindow: (): Window, type: 'popout' } | { type: 'floating' } | { type: 'grid' }", + "code": "{ getWindow: (): Window, popoutUrl?: string, type: 'popout' } | { type: 'floating' } | { type: 'grid' }", "typeParameters": [], "type": { "type": "or", @@ -41505,7 +41800,7 @@ "type": "reflection", "value": { "name": "__type", - "code": "{ getWindow: (): Window, type: 'popout' }", + "code": "{ getWindow: (): Window, popoutUrl?: string, type: 'popout' }", "kind": "typeLiteral", "properties": [ { @@ -41536,6 +41831,18 @@ }, "flags": {} }, + { + "name": "popoutUrl", + "code": "string", + "kind": "property", + "type": { + "type": "intrinsic", + "value": "string" + }, + "flags": { + "isOptional": true + } + }, { "name": "type", "code": "'popout'", @@ -43852,11 +44159,6 @@ }, "kind": "typeAlias" }, - "ReactPartContext": { - "name": "ReactPartContext", - "code": "", - "kind": "variable" - }, "DockviewDefaultTab": { "kind": "function", "name": "DockviewDefaultTab", @@ -44410,7 +44712,7 @@ "summary": [ { "kind": "text", - "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" + "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" } ] },