diff --git a/packages/docs/blog/2024-11-03-dockview-2.0.0.md b/packages/docs/blog/2024-11-03-dockview-2.0.0.md new file mode 100644 index 000000000..3cc856412 --- /dev/null +++ b/packages/docs/blog/2024-11-03-dockview-2.0.0.md @@ -0,0 +1,32 @@ +--- +slug: dockview-2.0.0-release +title: Dockview 2.0.0 +tags: [release] +--- + +# Release Notes + +This major version bump is due to breaking changes related to classnames. + +Please reference docs @ [dockview.dev](https://dockview.dev). + +## 🚀 Features + +- Add panel within group at specific index [#751](https://github.com/mathuo/dockview/pull/751) + +## 🛠 Miscs + +- Set drag event dataTransfer object to empty string [#738](https://github.com/mathuo/dockview/pull/738) +- General code cleanup / housekeeping [#740](https://github.com/mathuo/dockview/pull/740) [#746](https://github.com/mathuo/dockview/pull/746) +- Bug: Popout window initial sizing [#737](https://github.com/mathuo/dockview/pull/737) [#727](https://github.com/mathuo/dockview/pull/727) +- Bug: Close popout window on unload (refresh) [#731](https://github.com/mathuo/dockview/pull/731) +- Bug: Preserve Vue3 inject/provide context [#673](https://github.com/mathuo/dockview/pull/673) +- Bug: Fix Contraints [#744](https://github.com/mathuo/dockview/pull/744) +- Bug: Fix popout window issues [#748](https://github.com/mathuo/dockview/pull/748) + +## 🔥 Breaking changes + +- Prefix all classnames with `-dv-*` [#688](https://github.com/mathuo/dockview/pull/688) +- Remove depreciated methods [#742](https://github.com/mathuo/dockview/pull/742) + + diff --git a/packages/docs/docs/core/panels/add.mdx b/packages/docs/docs/core/panels/add.mdx index b964cdc05..cb151eb6e 100644 --- a/packages/docs/docs/core/panels/add.mdx +++ b/packages/docs/docs/core/panels/add.mdx @@ -115,6 +115,15 @@ api.addPanel({ direction: 'above' } }); + +api.addPanel({ + id: 'panel_4', + component: 'default', + position: { + referencePanel: panel2, + index: 2 // optionally specify which index to add the panel at + } +}); ``` #### Relative to another Group @@ -129,7 +138,9 @@ const panel2: IDockviewPanel = api.addPanel({ } }); -const panel = api.addPanel({ + + +api.addPanel({ id: 'panel_2', component: 'default', position: { @@ -137,6 +148,15 @@ const panel = api.addPanel({ direction: 'left' } }); + +api.addPanel({ + id: 'panel_3', + component: 'default', + position: { + referenceGroup: panel2.group, + index: 2 // optionally specify which index to add the panel at + } +}); ``` #### Relative to the container diff --git a/packages/docs/src/generated/api.output.json b/packages/docs/src/generated/api.output.json index 4f2f51762..d7024baab 100644 --- a/packages/docs/src/generated/api.output.json +++ b/packages/docs/src/generated/api.output.json @@ -5155,7 +5155,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, skipRemoveGroup?: boolean }): Promise", + "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", "kind": "method", "signature": [ { @@ -5184,12 +5184,12 @@ }, { "name": "options", - "code": "options?: { onDidOpen?: (event: { id: string, window: Window }): void, onWillClose?: (event: { id: string, window: Window }): void, overridePopoutGroup?: DockviewGroupPanel, popoutUrl?: string, position?: Box, skipRemoveGroup?: boolean }", + "code": "options?: { onDidOpen?: (event: { id: string, window: Window }): void, onWillClose?: (event: { id: string, window: Window }): void, overridePopoutGroup?: DockviewGroupPanel, popoutUrl?: string, position?: Box }", "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, skipRemoveGroup?: boolean }", + "code": "{ onDidOpen?: (event: { id: string, window: Window }): void, onWillClose?: (event: { id: string, window: Window }): void, overridePopoutGroup?: DockviewGroupPanel, popoutUrl?: string, position?: Box }", "kind": "typeLiteral", "properties": [ { @@ -5361,18 +5361,6 @@ "flags": { "isOptional": true } - }, - { - "name": "skipRemoveGroup", - "code": "boolean", - "kind": "property", - "type": { - "type": "intrinsic", - "value": "boolean" - }, - "flags": { - "isOptional": true - } } ] } @@ -5391,7 +5379,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, skipRemoveGroup?: boolean }): Promise", + "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", "kind": "callSignature" } ] @@ -7337,6 +7325,78 @@ } } }, + { + "name": "__maximumHeight", + "code": "(): number", + "kind": "method", + "signature": [ + { + "name": "__maximumHeight", + "typeParameters": [], + "parameters": [], + "returnType": { + "type": "intrinsic", + "value": "number" + }, + "code": "(): number", + "kind": "callSignature" + } + ] + }, + { + "name": "__maximumWidth", + "code": "(): number", + "kind": "method", + "signature": [ + { + "name": "__maximumWidth", + "typeParameters": [], + "parameters": [], + "returnType": { + "type": "intrinsic", + "value": "number" + }, + "code": "(): number", + "kind": "callSignature" + } + ] + }, + { + "name": "__minimumHeight", + "code": "(): number", + "kind": "method", + "signature": [ + { + "name": "__minimumHeight", + "typeParameters": [], + "parameters": [], + "returnType": { + "type": "intrinsic", + "value": "number" + }, + "code": "(): number", + "kind": "callSignature" + } + ] + }, + { + "name": "__minimumWidth", + "code": "(): number", + "kind": "method", + "signature": [ + { + "name": "__minimumWidth", + "typeParameters": [], + "parameters": [], + "returnType": { + "type": "intrinsic", + "value": "number" + }, + "code": "(): number", + "kind": "callSignature" + } + ] + }, { "name": "addDisposables", "code": "(args: IDisposable[]): void", @@ -14662,6 +14722,78 @@ } } }, + { + "name": "__maximumHeight", + "code": "(): number", + "kind": "method", + "signature": [ + { + "name": "__maximumHeight", + "typeParameters": [], + "parameters": [], + "returnType": { + "type": "intrinsic", + "value": "number" + }, + "code": "(): number", + "kind": "callSignature" + } + ] + }, + { + "name": "__maximumWidth", + "code": "(): number", + "kind": "method", + "signature": [ + { + "name": "__maximumWidth", + "typeParameters": [], + "parameters": [], + "returnType": { + "type": "intrinsic", + "value": "number" + }, + "code": "(): number", + "kind": "callSignature" + } + ] + }, + { + "name": "__minimumHeight", + "code": "(): number", + "kind": "method", + "signature": [ + { + "name": "__minimumHeight", + "typeParameters": [], + "parameters": [], + "returnType": { + "type": "intrinsic", + "value": "number" + }, + "code": "(): number", + "kind": "callSignature" + } + ] + }, + { + "name": "__minimumWidth", + "code": "(): number", + "kind": "method", + "signature": [ + { + "name": "__minimumWidth", + "typeParameters": [], + "parameters": [], + "returnType": { + "type": "intrinsic", + "value": "number" + }, + "code": "(): number", + "kind": "callSignature" + } + ] + }, { "name": "addDisposables", "code": "(args: IDisposable[]): void", @@ -23422,6 +23554,79 @@ ], "extends": [] }, + "DockviewGroupMoveParams": { + "kind": "interface", + "name": "DockviewGroupMoveParams", + "children": [ + { + "name": "group", + "code": "DockviewGroupPanel", + "kind": "property", + "type": { + "type": "reference", + "value": "DockviewGroupPanel", + "source": "dockview-core" + }, + "flags": { + "isOptional": true + } + }, + { + "name": "index", + "code": "number", + "kind": "property", + "type": { + "type": "intrinsic", + "value": "number" + }, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The index to place the panel within a group, only applicable if the placement is within an existing group" + } + ] + } + }, + { + "name": "position", + "code": "'bottom' | 'right' | 'top' | 'left' | 'center'", + "kind": "property", + "type": { + "type": "or", + "values": [ + { + "type": "literal", + "value": "bottom" + }, + { + "type": "literal", + "value": "right" + }, + { + "type": "literal", + "value": "top" + }, + { + "type": "literal", + "value": "left" + }, + { + "type": "literal", + "value": "center" + } + ] + }, + "flags": { + "isOptional": true + } + } + ], + "extends": [] + }, "DockviewGroupPanelApi": { "kind": "interface", "name": "DockviewGroupPanelApi", @@ -23898,7 +24103,7 @@ }, { "name": "moveTo", - "code": "(options: { group?: DockviewGroupPanel, position?: 'right' | 'bottom' | 'top' | 'left' | 'center' }): void", + "code": "(options: DockviewGroupMoveParams): void", "kind": "method", "signature": [ { @@ -23907,62 +24112,11 @@ "parameters": [ { "name": "options", - "code": "options: { group?: DockviewGroupPanel, position?: 'right' | 'bottom' | 'top' | 'left' | 'center' }", + "code": "options: DockviewGroupMoveParams", "type": { - "type": "reflection", - "value": { - "name": "__type", - "code": "{ group?: DockviewGroupPanel, position?: 'right' | 'bottom' | 'top' | 'left' | 'center' }", - "kind": "typeLiteral", - "properties": [ - { - "name": "group", - "code": "DockviewGroupPanel", - "kind": "property", - "type": { - "type": "reference", - "value": "DockviewGroupPanel", - "source": "dockview-core" - }, - "flags": { - "isOptional": true - } - }, - { - "name": "position", - "code": "'right' | 'bottom' | 'top' | 'left' | 'center'", - "kind": "property", - "type": { - "type": "or", - "values": [ - { - "type": "literal", - "value": "right" - }, - { - "type": "literal", - "value": "bottom" - }, - { - "type": "literal", - "value": "top" - }, - { - "type": "literal", - "value": "left" - }, - { - "type": "literal", - "value": "center" - } - ] - }, - "flags": { - "isOptional": true - } - } - ] - } + "type": "reference", + "value": "DockviewGroupMoveParams", + "source": "dockview-core" }, "kind": "parameter" } @@ -23971,7 +24125,7 @@ "type": "intrinsic", "value": "void" }, - "code": "(options: { group?: DockviewGroupPanel, position?: 'right' | 'bottom' | 'top' | 'left' | 'center' }): void", + "code": "(options: DockviewGroupMoveParams): void", "kind": "callSignature" } ] @@ -25016,7 +25170,7 @@ }, { "name": "moveTo", - "code": "(options: { group: DockviewGroupPanel, index?: number, position?: 'right' | 'bottom' | 'top' | 'left' | 'center' }): void", + "code": "(options: DockviewGroupMoveParams): void", "kind": "method", "signature": [ { @@ -25025,72 +25179,11 @@ "parameters": [ { "name": "options", - "code": "options: { group: DockviewGroupPanel, index?: number, position?: 'right' | 'bottom' | 'top' | 'left' | 'center' }", + "code": "options: DockviewGroupMoveParams", "type": { - "type": "reflection", - "value": { - "name": "__type", - "code": "{ group: DockviewGroupPanel, index?: number, position?: 'right' | 'bottom' | 'top' | 'left' | 'center' }", - "kind": "typeLiteral", - "properties": [ - { - "name": "group", - "code": "DockviewGroupPanel", - "kind": "property", - "type": { - "type": "reference", - "value": "DockviewGroupPanel", - "source": "dockview-core" - }, - "flags": {} - }, - { - "name": "index", - "code": "number", - "kind": "property", - "type": { - "type": "intrinsic", - "value": "number" - }, - "flags": { - "isOptional": true - } - }, - { - "name": "position", - "code": "'right' | 'bottom' | 'top' | 'left' | 'center'", - "kind": "property", - "type": { - "type": "or", - "values": [ - { - "type": "literal", - "value": "right" - }, - { - "type": "literal", - "value": "bottom" - }, - { - "type": "literal", - "value": "top" - }, - { - "type": "literal", - "value": "left" - }, - { - "type": "literal", - "value": "center" - } - ] - }, - "flags": { - "isOptional": true - } - } - ] - } + "type": "reference", + "value": "DockviewGroupMoveParams", + "source": "dockview-core" }, "kind": "parameter" } @@ -25099,7 +25192,7 @@ "type": "intrinsic", "value": "void" }, - "code": "(options: { group: DockviewGroupPanel, index?: number, position?: 'right' | 'bottom' | 'top' | 'left' | 'center' }): void", + "code": "(options: DockviewGroupMoveParams): void", "kind": "callSignature" } ] @@ -41519,6 +41612,17 @@ }, "kind": "typeAlias" }, + "DockviewPanelMoveParams": { + "name": "DockviewPanelMoveParams", + "code": "DockviewGroupMoveParams", + "typeParameters": [], + "type": { + "type": "reference", + "value": "DockviewGroupMoveParams", + "source": "dockview-core" + }, + "kind": "typeAlias" + }, "DockviewPanelRenderer": { "name": "DockviewPanelRenderer", "code": "'always' | 'onlyWhenVisible'",