From fc27fdd7f8a7e00848531f6de98f176c8fc18bd5 Mon Sep 17 00:00:00 2001 From: mathuo <6710312+mathuo@users.noreply.github.com> Date: Thu, 19 Jun 2025 21:34:11 +0100 Subject: [PATCH] chore: update api docs --- packages/docs/src/generated/api.output.json | 185 ++++++++++++++++---- 1 file changed, 155 insertions(+), 30 deletions(-) diff --git a/packages/docs/src/generated/api.output.json b/packages/docs/src/generated/api.output.json index 38f726915..573b00015 100644 --- a/packages/docs/src/generated/api.output.json +++ b/packages/docs/src/generated/api.output.json @@ -2387,6 +2387,27 @@ } } }, + { + "name": "onDidOpenPopoutWindowFail", + "code": "Event", + "kind": "accessor", + "value": { + "name": "onDidOpenPopoutWindowFail", + "code": "Event", + "kind": "getSignature", + "returnType": { + "type": "reference", + "value": "Event", + "source": "dockview-core", + "typeArguments": [ + { + "type": "intrinsic", + "value": "void" + } + ] + } + } + }, { "name": "onDidPopoutGroupPositionChange", "code": "Event", @@ -2539,7 +2560,7 @@ "summary": [ { "kind": "text", - "text": "Invoked before a group is dragged.\r\n\r\nCalling " + "text": "Invoked before a group is dragged.\n\nCalling " }, { "kind": "code", @@ -2570,7 +2591,7 @@ "summary": [ { "kind": "text", - "text": "Invoked before a group is dragged.\r\n\r\nCalling " + "text": "Invoked before a group is dragged.\n\nCalling " }, { "kind": "code", @@ -2593,7 +2614,7 @@ "summary": [ { "kind": "text", - "text": "Invoked before a panel is dragged.\r\n\r\nCalling " + "text": "Invoked before a panel is dragged.\n\nCalling " }, { "kind": "code", @@ -2624,7 +2645,7 @@ "summary": [ { "kind": "text", - "text": "Invoked before a panel is dragged.\r\n\r\nCalling " + "text": "Invoked before a panel is dragged.\n\nCalling " }, { "kind": "code", @@ -2647,7 +2668,7 @@ "summary": [ { "kind": "text", - "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 " + "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 " }, { "kind": "code", @@ -2655,7 +2676,7 @@ }, { "kind": "text", - "text": " syntax.\r\n\r\nPreventing certain events may causes unexpected behaviours, use carefully." + "text": " syntax.\n\nPreventing certain events may causes unexpected behaviours, use carefully." } ] }, @@ -2678,7 +2699,7 @@ "summary": [ { "kind": "text", - "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 " + "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 " }, { "kind": "code", @@ -2686,7 +2707,7 @@ }, { "kind": "text", - "text": " syntax.\r\n\r\nPreventing certain events may causes unexpected behaviours, use carefully." + "text": " syntax.\n\nPreventing certain events may causes unexpected behaviours, use carefully." } ] } @@ -2701,7 +2722,7 @@ "summary": [ { "kind": "text", - "text": "Invoked before an overlay is shown indicating a drop target.\r\n\r\nCalling " + "text": "Invoked before an overlay is shown indicating a drop target.\n\nCalling " }, { "kind": "code", @@ -2709,7 +2730,7 @@ }, { "kind": "text", - "text": " will prevent the overlay being shown and prevent\r\nthe any subsequent drop event." + "text": " will prevent the overlay being shown and prevent\nthe any subsequent drop event." } ] }, @@ -2732,7 +2753,7 @@ "summary": [ { "kind": "text", - "text": "Invoked before an overlay is shown indicating a drop target.\r\n\r\nCalling " + "text": "Invoked before an overlay is shown indicating a drop target.\n\nCalling " }, { "kind": "code", @@ -2740,7 +2761,7 @@ }, { "kind": "text", - "text": " will prevent the overlay being shown and prevent\r\nthe any subsequent drop event." + "text": " will prevent the overlay being shown and prevent\nthe any subsequent drop event." } ] } @@ -3523,7 +3544,7 @@ }, { "name": "getGroup", - "code": "(id: string): DockviewGroupPanel | undefined", + "code": "(id: string): IDockviewGroupPanel | undefined", "kind": "method", "signature": [ { @@ -3561,7 +3582,7 @@ "values": [ { "type": "reference", - "value": "DockviewGroupPanel", + "value": "IDockviewGroupPanel", "source": "dockview-core" }, { @@ -3570,7 +3591,7 @@ } ] }, - "code": "(id: string): DockviewGroupPanel | undefined", + "code": "(id: string): IDockviewGroupPanel | undefined", "kind": "callSignature" } ], @@ -4424,6 +4445,25 @@ "isReadonly": true } }, + { + "name": "onDidOpenPopoutWindowFail", + "code": "Event", + "kind": "property", + "type": { + "type": "reference", + "value": "Event", + "source": "dockview-core", + "typeArguments": [ + { + "type": "intrinsic", + "value": "void" + } + ] + }, + "flags": { + "isReadonly": true + } + }, { "name": "onDidOptionsChange", "code": "Event", @@ -11173,7 +11213,7 @@ "summary": [ { "kind": "text", - "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" + "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" } ] }, @@ -11191,7 +11231,7 @@ "summary": [ { "kind": "text", - "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" + "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" } ] } @@ -19908,7 +19948,7 @@ "summary": [ { "kind": "text", - "text": "Invoked whenever any aspect of the layout changes.\r\nIf listening to this event it may be worth debouncing ouputs." + "text": "Invoked whenever any aspect of the layout changes.\nIf listening to this event it may be worth debouncing ouputs." } ] }, @@ -19930,7 +19970,7 @@ "summary": [ { "kind": "text", - "text": "Invoked whenever any aspect of the layout changes.\r\nIf listening to this event it may be worth debouncing ouputs." + "text": "Invoked whenever any aspect of the layout changes.\nIf listening to this event it may be worth debouncing ouputs." } ] } @@ -20526,7 +20566,7 @@ }, { "kind": "text", - "text": " method\r\nfor the subsequent resize." + "text": " method\nfor the subsequent resize." } ] }, @@ -20588,7 +20628,7 @@ }, { "kind": "text", - "text": " method\r\nfor the subsequent resize." + "text": " method\nfor the subsequent resize." } ] } @@ -24725,7 +24765,7 @@ }, { "kind": "text", - "text": ".\r\nCall " + "text": ".\nCall " }, { "kind": "code", @@ -24955,6 +24995,59 @@ ] } }, + { + "name": "scrollbars", + "code": "'custom' | 'native'", + "kind": "property", + "type": { + "type": "or", + "values": [ + { + "type": "literal", + "value": "custom" + }, + { + "type": "literal", + "value": "native" + } + ] + }, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Select " + }, + { + "kind": "code", + "text": "`native`" + }, + { + "kind": "text", + "text": " to use built-in scrollbar behaviours and " + }, + { + "kind": "code", + "text": "`custom`" + }, + { + "kind": "text", + "text": " to use an internal implementation\nthat allows for improved scrollbar overlay UX.\n\nThis is only applied to the tab header section. Defaults to " + }, + { + "kind": "code", + "text": "`custom`" + }, + { + "kind": "text", + "text": "." + } + ] + } + }, { "name": "singleTabMode", "code": "'default' | 'fullwidth'", @@ -25411,7 +25504,7 @@ "summary": [ { "kind": "text", - "text": "The id of the tab component renderer\r\n\r\nUndefined if no custom tab renderer is provided" + "text": "The id of the tab component renderer\n\nUndefined if no custom tab renderer is provided" } ] } @@ -25923,7 +26016,7 @@ "summary": [ { "kind": "text", - "text": "The same-origin path at which the popout window will be created\r\n\r\nDefaults to " + "text": "The same-origin path at which the popout window will be created\n\nDefaults to " }, { "kind": "code", @@ -25956,6 +26049,19 @@ } ] } + }, + { + "name": "referenceGroup", + "code": "DockviewGroupPanel", + "kind": "property", + "type": { + "type": "reference", + "value": "DockviewGroupPanel", + "source": "dockview-core" + }, + "flags": { + "isOptional": true + } } ], "extends": [] @@ -26032,7 +26138,7 @@ }, { "kind": "text", - "text": "\r\nwill mount the overlay to root of the dockview component whereas " + "text": "\nwill mount the overlay to root of the dockview component whereas " }, { "kind": "code", @@ -29480,6 +29586,25 @@ "isReadonly": true } }, + { + "name": "onDidOpenPopoutWindowFail", + "code": "Event", + "kind": "property", + "type": { + "type": "reference", + "value": "Event", + "source": "dockview-core", + "typeArguments": [ + { + "type": "intrinsic", + "value": "void" + } + ] + }, + "flags": { + "isReadonly": true + } + }, { "name": "onDidPopoutGroupPositionChange", "code": "Event", @@ -42238,7 +42363,7 @@ "summary": [ { "kind": "text", - "text": "If true then add the panel without setting it as the active panel.\r\n\r\nDefaults to " + "text": "If true then add the panel without setting it as the active panel.\n\nDefaults to " }, { "kind": "code", @@ -42305,7 +42430,7 @@ "summary": [ { "kind": "text", - "text": "The rendering mode of the panel.\r\n\r\nThis dictates what happens to the HTML of the panel when it is hidden." + "text": "The rendering mode of the panel.\n\nThis dictates what happens to the HTML of the panel when it is hidden." } ] } @@ -42345,7 +42470,7 @@ "summary": [ { "kind": "text", - "text": "The title for the panel which can be accessed within both the tab and component.\r\n\r\nIf using the default tab renderer this title will be displayed in the tab." + "text": "The title for the panel which can be accessed within both the tab and component.\n\nIf using the default tab renderer this title will be displayed in the tab." } ] } @@ -43319,7 +43444,7 @@ "summary": [ { "kind": "text", - "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." + "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." } ] }, @@ -45344,7 +45469,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" } ] },