Skip to content

Commit 52c55f8

Browse files
committed
chore: auto update API docs
1 parent 3621616 commit 52c55f8

3 files changed

Lines changed: 38 additions & 2 deletions

File tree

docs/API-Reference/command/Commands.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -452,6 +452,12 @@ Opens theme settings
452452
## VIEW\_HIDE\_SIDEBAR
453453
Toggles sidebar visibility
454454

455+
**Kind**: global variable
456+
<a name="VIEW_TOGGLE_DESIGN_MODE"></a>
457+
458+
## VIEW\_TOGGLE\_DESIGN\_MODE
459+
Toggles the design (full live-preview) mode — collapses/expands the editor
460+
455461
**Kind**: global variable
456462
<a name="TOGGLE_TABBAR"></a>
457463

docs/API-Reference/view/WorkspaceManager.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ Events:
2828
* [.EVENT_WORKSPACE_UPDATE_LAYOUT](#module_view/WorkspaceManager..EVENT_WORKSPACE_UPDATE_LAYOUT)
2929
* [.EVENT_WORKSPACE_PANEL_SHOWN](#module_view/WorkspaceManager..EVENT_WORKSPACE_PANEL_SHOWN)
3030
* [.EVENT_WORKSPACE_PANEL_HIDDEN](#module_view/WorkspaceManager..EVENT_WORKSPACE_PANEL_HIDDEN)
31+
* [.EVENT_WORKSPACE_DESIGN_MODE_CHANGE](#module_view/WorkspaceManager..EVENT_WORKSPACE_DESIGN_MODE_CHANGE)
3132
* [.createBottomPanel(id, $panel, [minSize], [title], [options])](#module_view/WorkspaceManager..createBottomPanel) ⇒ <code>Panel</code>
3233
* [.destroyBottomPanel(id)](#module_view/WorkspaceManager..destroyBottomPanel)
3334
* [.createPluginPanel(id, $panel, [minSize], $toolbarIcon, [initialSize])](#module_view/WorkspaceManager..createPluginPanel) ⇒ <code>Panel</code>
@@ -36,6 +37,8 @@ Events:
3637
* [.recomputeLayout(refreshHint)](#module_view/WorkspaceManager..recomputeLayout)
3738
* [.isPanelVisible(panelID)](#module_view/WorkspaceManager..isPanelVisible) ⇒ <code>boolean</code>
3839
* [.setPluginPanelWidth(width)](#module_view/WorkspaceManager..setPluginPanelWidth)
40+
* [.isInDesignMode()](#module_view/WorkspaceManager..isInDesignMode) ⇒ <code>boolean</code>
41+
* [.setDesignMode(active)](#module_view/WorkspaceManager..setDesignMode)
3942
* [.addEscapeKeyEventHandler(consumerName, eventHandler)](#module_view/WorkspaceManager..addEscapeKeyEventHandler) ⇒ <code>boolean</code>
4043
* [.removeEscapeKeyEventHandler(consumerName)](#module_view/WorkspaceManager..removeEscapeKeyEventHandler) ⇒ <code>boolean</code>
4144

@@ -86,6 +89,13 @@ Event triggered when a panel is shown.
8689
### view/WorkspaceManager.EVENT\_WORKSPACE\_PANEL\_HIDDEN
8790
Event triggered when a panel is hidden.
8891

92+
**Kind**: inner constant of [<code>view/WorkspaceManager</code>](#module_view/WorkspaceManager)
93+
<a name="module_view/WorkspaceManager..EVENT_WORKSPACE_DESIGN_MODE_CHANGE"></a>
94+
95+
### view/WorkspaceManager.EVENT\_WORKSPACE\_DESIGN\_MODE\_CHANGE
96+
Event triggered when design mode (editor collapsed, full live preview) is
97+
entered or exited. Payload: `(active: boolean)`.
98+
8999
**Kind**: inner constant of [<code>view/WorkspaceManager</code>](#module_view/WorkspaceManager)
90100
<a name="module_view/WorkspaceManager..createBottomPanel"></a>
91101

@@ -189,6 +199,26 @@ No-op if no panel is currently visible.
189199
| --- | --- | --- |
190200
| width | <code>number</code> | Desired content width in pixels |
191201

202+
<a name="module_view/WorkspaceManager..isInDesignMode"></a>
203+
204+
### view/WorkspaceManager.isInDesignMode() ⇒ <code>boolean</code>
205+
Returns true while the workspace is in design mode (editor collapsed and
206+
live preview expanded to fill the editor area).
207+
208+
**Kind**: inner method of [<code>view/WorkspaceManager</code>](#module_view/WorkspaceManager)
209+
<a name="module_view/WorkspaceManager..setDesignMode"></a>
210+
211+
### view/WorkspaceManager.setDesignMode(active)
212+
Sets the design-mode flag and fires EVENT_WORKSPACE_DESIGN_MODE_CHANGE when
213+
the value actually changes. Intended to be called by the control bar; other
214+
callers should use the dedicated toggle command instead.
215+
216+
**Kind**: inner method of [<code>view/WorkspaceManager</code>](#module_view/WorkspaceManager)
217+
218+
| Param | Type |
219+
| --- | --- |
220+
| active | <code>boolean</code> |
221+
192222
<a name="module_view/WorkspaceManager..addEscapeKeyEventHandler"></a>
193223

194224
### view/WorkspaceManager.addEscapeKeyEventHandler(consumerName, eventHandler) ⇒ <code>boolean</code>

src-node/package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)