chore: prepare v1.12.0

This commit is contained in:
mathuo 2024-04-15 21:03:47 +01:00
parent ce3706d1b3
commit 95685efbbd
No known key found for this signature in database
GPG Key ID: C6EEDEFD6CA07281
2 changed files with 43202 additions and 42928 deletions

View File

@ -0,0 +1,19 @@
---
slug: dockview-1.12.0-release
title: Dockview 1.12.0
tags: [release]
---
# Release Notes
Please reference docs @ [dockview.dev](https://dockview.dev).
## 🚀 Features
- Enhance `onWillShowOverlay` event to contain additional commonly used methods and properties [#564](https://github.com/mathuo/dockview/issues/564)
- Expose `api.component` and `api.tabComponent` on panel api [#569](https://github.com/mathuo/dockview/issues/569)
## 🔥 Breaking changes
- Fix Typo: `onlyWhenVisibile` to `onlyWhenVisible` [#559](https://github.com/mathuo/dockview/pull/559)

View File

@ -2467,7 +2467,7 @@
"summary": [ "summary": [
{ {
"kind": "text", "kind": "text",
"text": "Invoked before a group is dragged.\n\nCalling " "text": "Invoked before a group is dragged.\r\n\r\nCalling "
}, },
{ {
"kind": "code", "kind": "code",
@ -2498,7 +2498,7 @@
"summary": [ "summary": [
{ {
"kind": "text", "kind": "text",
"text": "Invoked before a group is dragged.\n\nCalling " "text": "Invoked before a group is dragged.\r\n\r\nCalling "
}, },
{ {
"kind": "code", "kind": "code",
@ -2521,7 +2521,7 @@
"summary": [ "summary": [
{ {
"kind": "text", "kind": "text",
"text": "Invoked before a panel is dragged.\n\nCalling " "text": "Invoked before a panel is dragged.\r\n\r\nCalling "
}, },
{ {
"kind": "code", "kind": "code",
@ -2552,7 +2552,7 @@
"summary": [ "summary": [
{ {
"kind": "text", "kind": "text",
"text": "Invoked before a panel is dragged.\n\nCalling " "text": "Invoked before a panel is dragged.\r\n\r\nCalling "
}, },
{ {
"kind": "code", "kind": "code",
@ -2575,7 +2575,7 @@
"summary": [ "summary": [
{ {
"kind": "text", "kind": "text",
"text": "Invoked when a Drag'n'Drop event occurs but before dockview handles it giving the user an opportunity to intecept and\nprevent the event from occuring using the standard " "text": "Invoked when a Drag'n'Drop event occurs but before dockview handles it giving the user an opportunity to intecept and\r\nprevent the event from occuring using the standard "
}, },
{ {
"kind": "code", "kind": "code",
@ -2583,7 +2583,7 @@
}, },
{ {
"kind": "text", "kind": "text",
"text": " syntax.\n\nPreventing certain events may causes unexpected behaviours, use carefully." "text": " syntax.\r\n\r\nPreventing certain events may causes unexpected behaviours, use carefully."
} }
] ]
}, },
@ -2606,7 +2606,7 @@
"summary": [ "summary": [
{ {
"kind": "text", "kind": "text",
"text": "Invoked when a Drag'n'Drop event occurs but before dockview handles it giving the user an opportunity to intecept and\nprevent the event from occuring using the standard " "text": "Invoked when a Drag'n'Drop event occurs but before dockview handles it giving the user an opportunity to intecept and\r\nprevent the event from occuring using the standard "
}, },
{ {
"kind": "code", "kind": "code",
@ -2614,7 +2614,7 @@
}, },
{ {
"kind": "text", "kind": "text",
"text": " syntax.\n\nPreventing certain events may causes unexpected behaviours, use carefully." "text": " syntax.\r\n\r\nPreventing certain events may causes unexpected behaviours, use carefully."
} }
] ]
} }
@ -2629,7 +2629,7 @@
"summary": [ "summary": [
{ {
"kind": "text", "kind": "text",
"text": "Invoked before an overlay is shown indicating a drop target.\n\nCalling " "text": "Invoked before an overlay is shown indicating a drop target.\r\n\r\nCalling "
}, },
{ {
"kind": "code", "kind": "code",
@ -2637,7 +2637,7 @@
}, },
{ {
"kind": "text", "kind": "text",
"text": " will prevent the overlay being shown and prevent\nthe any subsequent drop event." "text": " will prevent the overlay being shown and prevent\r\nthe any subsequent drop event."
} }
] ]
}, },
@ -2660,7 +2660,7 @@
"summary": [ "summary": [
{ {
"kind": "text", "kind": "text",
"text": "Invoked before an overlay is shown indicating a drop target.\n\nCalling " "text": "Invoked before an overlay is shown indicating a drop target.\r\n\r\nCalling "
}, },
{ {
"kind": "code", "kind": "code",
@ -2668,7 +2668,7 @@
}, },
{ {
"kind": "text", "kind": "text",
"text": " will prevent the overlay being shown and prevent\nthe any subsequent drop event." "text": " will prevent the overlay being shown and prevent\r\nthe any subsequent drop event."
} }
] ]
} }
@ -4441,6 +4441,21 @@
} }
} }
}, },
{
"name": "api",
"code": "DockviewApi",
"kind": "accessor",
"value": {
"name": "api",
"code": "DockviewApi",
"kind": "getSignature",
"returnType": {
"type": "reference",
"value": "DockviewApi",
"source": "dockview-core"
}
}
},
{ {
"name": "disableResizing", "name": "disableResizing",
"code": "boolean", "code": "boolean",
@ -10648,7 +10663,7 @@
"summary": [ "summary": [
{ {
"kind": "text", "kind": "text",
"text": "If the root is orientated as a VERTICAL node then nest the existing root within a new HORIZIONTAL root node\nIf the root is orientated as a HORIZONTAL node then nest the existing root within a new VERITCAL root node" "text": "If the root is orientated as a VERTICAL node then nest the existing root within a new HORIZIONTAL root node\r\nIf the root is orientated as a HORIZONTAL node then nest the existing root within a new VERITCAL root node"
} }
] ]
}, },
@ -10666,7 +10681,7 @@
"summary": [ "summary": [
{ {
"kind": "text", "kind": "text",
"text": "If the root is orientated as a VERTICAL node then nest the existing root within a new HORIZIONTAL root node\nIf the root is orientated as a HORIZONTAL node then nest the existing root within a new VERITCAL root node" "text": "If the root is orientated as a VERTICAL node then nest the existing root within a new HORIZIONTAL root node\r\nIf the root is orientated as a HORIZONTAL node then nest the existing root within a new VERITCAL root node"
} }
] ]
} }
@ -18987,7 +19002,7 @@
"summary": [ "summary": [
{ {
"kind": "text", "kind": "text",
"text": "Invoked whenever any aspect of the layout changes.\nIf listening to this event it may be worth debouncing ouputs." "text": "Invoked whenever any aspect of the layout changes.\r\nIf listening to this event it may be worth debouncing ouputs."
} }
] ]
}, },
@ -19009,7 +19024,7 @@
"summary": [ "summary": [
{ {
"kind": "text", "kind": "text",
"text": "Invoked whenever any aspect of the layout changes.\nIf listening to this event it may be worth debouncing ouputs." "text": "Invoked whenever any aspect of the layout changes.\r\nIf listening to this event it may be worth debouncing ouputs."
} }
] ]
} }
@ -19571,7 +19586,7 @@
}, },
{ {
"kind": "text", "kind": "text",
"text": " method\nfor the subsequent resize." "text": " method\r\nfor the subsequent resize."
} }
] ]
}, },
@ -19633,7 +19648,7 @@
}, },
{ {
"kind": "text", "kind": "text",
"text": " method\nfor the subsequent resize." "text": " method\r\nfor the subsequent resize."
} }
] ]
} }
@ -21339,6 +21354,21 @@
"kind": "constructor", "kind": "constructor",
"code": "" "code": ""
}, },
{
"name": "api",
"code": "DockviewApi",
"kind": "accessor",
"value": {
"name": "api",
"code": "DockviewApi",
"kind": "getSignature",
"returnType": {
"type": "reference",
"value": "DockviewApi",
"source": "dockview-core"
}
}
},
{ {
"name": "defaultPrevented", "name": "defaultPrevented",
"code": "boolean", "code": "boolean",
@ -21353,6 +21383,30 @@
} }
} }
}, },
{
"name": "group",
"code": "DockviewGroupPanel | undefined",
"kind": "accessor",
"value": {
"name": "group",
"code": "DockviewGroupPanel | undefined",
"kind": "getSignature",
"returnType": {
"type": "or",
"values": [
{
"type": "reference",
"value": "DockviewGroupPanel",
"source": "dockview-core"
},
{
"type": "intrinsic",
"value": "undefined"
}
]
}
}
},
{ {
"name": "kind", "name": "kind",
"code": "DockviewGroupDropLocation", "code": "DockviewGroupDropLocation",
@ -21383,6 +21437,30 @@
} }
} }
}, },
{
"name": "panel",
"code": "IDockviewPanel | undefined",
"kind": "accessor",
"value": {
"name": "panel",
"code": "IDockviewPanel | undefined",
"kind": "getSignature",
"returnType": {
"type": "or",
"values": [
{
"type": "reference",
"value": "IDockviewPanel",
"source": "dockview-core"
},
{
"type": "intrinsic",
"value": "undefined"
}
]
}
}
},
{ {
"name": "position", "name": "position",
"code": "Position", "code": "Position",
@ -21398,6 +21476,34 @@
} }
} }
}, },
{
"name": "getData",
"code": "(): PanelTransfer | undefined",
"kind": "method",
"signature": [
{
"name": "getData",
"typeParameters": [],
"parameters": [],
"returnType": {
"type": "or",
"values": [
{
"type": "reference",
"value": "PanelTransfer",
"source": "dockview-core"
},
{
"type": "intrinsic",
"value": "undefined"
}
]
},
"code": "(): PanelTransfer | undefined",
"kind": "callSignature"
}
]
},
{ {
"name": "preventDefault", "name": "preventDefault",
"code": "(): void", "code": "(): void",
@ -22867,6 +22973,26 @@
"kind": "interface", "kind": "interface",
"name": "DockviewGroupPanelApi", "name": "DockviewGroupPanelApi",
"children": [ "children": [
{
"name": "component",
"code": "string",
"kind": "property",
"type": {
"type": "intrinsic",
"value": "string"
},
"flags": {
"isReadonly": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "The id of the component renderer"
}
]
}
},
{ {
"name": "height", "name": "height",
"code": "number", "code": "number",
@ -23535,6 +23661,26 @@
"kind": "interface", "kind": "interface",
"name": "DockviewPanelApi", "name": "DockviewPanelApi",
"children": [ "children": [
{
"name": "component",
"code": "string",
"kind": "property",
"type": {
"type": "intrinsic",
"value": "string"
},
"flags": {
"isReadonly": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "The id of the component renderer"
}
]
}
},
{ {
"name": "group", "name": "group",
"code": "DockviewGroupPanel", "code": "DockviewGroupPanel",
@ -23906,6 +24052,35 @@
"isReadonly": true "isReadonly": true
} }
}, },
{
"name": "tabComponent",
"code": "string | undefined",
"kind": "property",
"type": {
"type": "or",
"values": [
{
"type": "intrinsic",
"value": "string"
},
{
"type": "intrinsic",
"value": "undefined"
}
]
},
"flags": {
"isReadonly": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "The id of the tab component renderer\r\n\r\nUndefined if no custom tab renderer is provided"
}
]
}
},
{ {
"name": "title", "name": "title",
"code": "string | undefined", "code": "string | undefined",
@ -25076,6 +25251,26 @@
"kind": "interface", "kind": "interface",
"name": "GridviewPanelApi", "name": "GridviewPanelApi",
"children": [ "children": [
{
"name": "component",
"code": "string",
"kind": "property",
"type": {
"type": "intrinsic",
"value": "string"
},
"flags": {
"isReadonly": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "The id of the component renderer"
}
]
}
},
{ {
"name": "height", "name": "height",
"code": "number", "code": "number",
@ -36205,6 +36400,26 @@
"kind": "interface", "kind": "interface",
"name": "PanelApi", "name": "PanelApi",
"children": [ "children": [
{
"name": "component",
"code": "string",
"kind": "property",
"type": {
"type": "intrinsic",
"value": "string"
},
"flags": {
"isReadonly": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "The id of the component renderer"
}
]
}
},
{ {
"name": "height", "name": "height",
"code": "number", "code": "number",
@ -37279,6 +37494,26 @@
"kind": "interface", "kind": "interface",
"name": "PaneviewPanelApi", "name": "PaneviewPanelApi",
"children": [ "children": [
{
"name": "component",
"code": "string",
"kind": "property",
"type": {
"type": "intrinsic",
"value": "string"
},
"flags": {
"isReadonly": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "The id of the component renderer"
}
]
}
},
{ {
"name": "height", "name": "height",
"code": "number", "code": "number",
@ -38837,6 +39072,26 @@
"kind": "interface", "kind": "interface",
"name": "SplitviewPanelApi", "name": "SplitviewPanelApi",
"children": [ "children": [
{
"name": "component",
"code": "string",
"kind": "property",
"type": {
"type": "intrinsic",
"value": "string"
},
"flags": {
"isReadonly": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "The id of the component renderer"
}
]
}
},
{ {
"name": "height", "name": "height",
"code": "number", "code": "number",
@ -40453,7 +40708,7 @@
"summary": [ "summary": [
{ {
"kind": "text", "kind": "text",
"text": "Find the grid location of a specific DOM element by traversing the parent\nchain and finding each child index on the way.\n\nThis will break as soon as DOM structures of the Splitview or Gridview change." "text": "Find the grid location of a specific DOM element by traversing the parent\r\nchain and finding each child index on the way.\r\n\r\nThis will break as soon as DOM structures of the Splitview or Gridview change."
} }
] ]
}, },
@ -43086,7 +43341,7 @@
"summary": [ "summary": [
{ {
"kind": "text", "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"
} }
] ]
}, },