Skip to content

Commit 2d989a4

Browse files
devvaannshabose
devvaannsh
authored and
abose
committed
chore: auto update API docs
1 parent c7670aa commit 2d989a4

4 files changed

Lines changed: 133 additions & 6 deletions

File tree

‎docs/API-Reference/command/Commands.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -992,6 +992,12 @@ Performs a mixed reset
992992
## CMD\_GIT\_TOGGLE\_PANEL
993993
Toggles the git panel
994994

995+
**Kind**: global variable
996+
<a name="CMD_CUSTOM_SNIPPETS_PANEL"></a>
997+
998+
## CMD\_CUSTOM\_SNIPPETS\_PANEL
999+
Toggles the custom snippets panel
1000+
9951001
**Kind**: global variable
9961002
<a name="CMD_GIT_GOTO_NEXT_CHANGE"></a>
9971003

‎docs/API-Reference/search/SearchResultsView.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,13 @@ Dispatches the following events_
2121
### new Handles the search results panel.
2222
Dispatches the following events:
2323
replaceBatch - when the Replace button is clicked.
24-
close - when the panel is closed.(model, panelID, panelName, type)
24+
close - when the panel is closed.(model, panelID, panelName, type, [title])
2525

2626
| Param | Type | Description |
2727
| --- | --- | --- |
2828
| model | <code>SearchModel</code> | The model that this view is showing. |
2929
| panelID | <code>string</code> | The CSS ID to use for the panel. |
3030
| panelName | <code>string</code> | The name to use for the panel, as passed to WorkspaceManager.createBottomPanel(). |
3131
| type | <code>string</code> | type to identify if it is reference search or string match serach |
32+
| [title] | <code>string</code> | Display title for the panel tab. |
3233

‎docs/API-Reference/view/PanelView.md‎

Lines changed: 87 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,29 @@ const PanelView = brackets.getModule("view/PanelView")
99
**Kind**: global class
1010

1111
* [Panel](#Panel)
12-
* [new Panel($panel)](#new_Panel_new)
12+
* [new Panel($panel, id, [title])](#new_Panel_new)
1313
* [.$panel](#Panel+$panel) : <code>jQueryObject</code>
1414
* [.isVisible()](#Panel+isVisible) ⇒ <code>boolean</code>
1515
* [.registerCanBeShownHandler(canShowHandlerFn)](#Panel+registerCanBeShownHandler) ⇒ <code>boolean</code>
1616
* [.canBeShown()](#Panel+canBeShown) ⇒ <code>boolean</code>
1717
* [.show()](#Panel+show)
1818
* [.hide()](#Panel+hide)
1919
* [.setVisible(visible)](#Panel+setVisible)
20+
* [.setTitle(newTitle)](#Panel+setTitle)
21+
* [.destroy()](#Panel+destroy)
2022
* [.getPanelType()](#Panel+getPanelType) ⇒ <code>string</code>
2123

2224
<a name="new_Panel_new"></a>
2325

24-
### new Panel($panel)
26+
### new Panel($panel, id, [title])
2527
Represents a panel below the editor area (a child of ".content").
2628

2729

2830
| Param | Type | Description |
2931
| --- | --- | --- |
3032
| $panel | <code>jQueryObject</code> | The entire panel, including any chrome, already in the DOM. |
33+
| id | <code>string</code> | Unique panel identifier. |
34+
| [title] | <code>string</code> | Optional display title for the tab bar. |
3135

3236
<a name="Panel+$panel"></a>
3337

@@ -84,12 +88,66 @@ Sets the panel's visibility state
8488
| --- | --- | --- |
8589
| visible | <code>boolean</code> | true to show, false to hide |
8690

91+
<a name="Panel+setTitle"></a>
92+
93+
### panel.setTitle(newTitle)
94+
Updates the display title shown in the tab bar for this panel.
95+
96+
**Kind**: instance method of [<code>Panel</code>](#Panel)
97+
98+
| Param | Type | Description |
99+
| --- | --- | --- |
100+
| newTitle | <code>string</code> | The new title to display. |
101+
102+
<a name="Panel+destroy"></a>
103+
104+
### panel.destroy()
105+
Destroys the panel, removing it from the tab bar, internal maps, and the DOM.
106+
After calling this, the Panel instance should not be reused.
107+
108+
**Kind**: instance method of [<code>Panel</code>](#Panel)
87109
<a name="Panel+getPanelType"></a>
88110

89111
### panel.getPanelType() ⇒ <code>string</code>
90112
gets the Panel's type
91113

92114
**Kind**: instance method of [<code>Panel</code>](#Panel)
115+
<a name="_panelMap"></a>
116+
117+
## \_panelMap : <code>Object.&lt;string, Panel&gt;</code>
118+
Maps panel ID to Panel instance
119+
120+
**Kind**: global variable
121+
<a name="_$container"></a>
122+
123+
## \_$container : <code>jQueryObject</code>
124+
The single container wrapping all bottom panels
125+
126+
**Kind**: global variable
127+
<a name="_$tabBar"></a>
128+
129+
## \_$tabBar : <code>jQueryObject</code>
130+
The tab bar inside the container
131+
132+
**Kind**: global variable
133+
<a name="_$tabsOverflow"></a>
134+
135+
## \_$tabsOverflow : <code>jQueryObject</code>
136+
Scrollable area holding the tab elements
137+
138+
**Kind**: global variable
139+
<a name="_openIds"></a>
140+
141+
## \_openIds : <code>Array.&lt;string&gt;</code>
142+
Ordered list of currently open (tabbed) panel IDs
143+
144+
**Kind**: global variable
145+
<a name="_activeId"></a>
146+
147+
## \_activeId : <code>string</code> \| <code>null</code>
148+
The panel ID of the currently visible (active) tab
149+
150+
**Kind**: global variable
93151
<a name="EVENT_PANEL_HIDDEN"></a>
94152

95153
## EVENT\_PANEL\_HIDDEN : <code>string</code>
@@ -108,3 +166,30 @@ Event when panel is shown
108166
type for bottom panel
109167

110168
**Kind**: global constant
169+
<a name="init"></a>
170+
171+
## init($container, $tabBar, $tabsOverflow)
172+
Initializes the PanelView module with references to the bottom panel container DOM elements.
173+
Called by WorkspaceManager during htmlReady.
174+
175+
**Kind**: global function
176+
177+
| Param | Type | Description |
178+
| --- | --- | --- |
179+
| $container | <code>jQueryObject</code> | The bottom panel container element. |
180+
| $tabBar | <code>jQueryObject</code> | The tab bar element inside the container. |
181+
| $tabsOverflow | <code>jQueryObject</code> | The scrollable area holding tab elements. |
182+
183+
<a name="getOpenBottomPanelIDs"></a>
184+
185+
## getOpenBottomPanelIDs() ⇒ <code>Array.&lt;string&gt;</code>
186+
Returns a copy of the currently open bottom panel IDs in tab order.
187+
188+
**Kind**: global function
189+
<a name="hideAllOpenPanels"></a>
190+
191+
## hideAllOpenPanels() ⇒ <code>Array.&lt;string&gt;</code>
192+
Hides every open bottom panel tab in a single batch
193+
194+
**Kind**: global function
195+
**Returns**: <code>Array.&lt;string&gt;</code> - The IDs of panels that were open (useful for restoring later).

‎docs/API-Reference/view/WorkspaceManager.md‎

Lines changed: 38 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,14 @@ Events:
2222
* [.PANEL_TYPE_BOTTOM_PANEL](#module_view/WorkspaceManager.PANEL_TYPE_BOTTOM_PANEL) : <code>string</code>
2323
* [.PANEL_TYPE_PLUGIN_PANEL](#module_view/WorkspaceManager.PANEL_TYPE_PLUGIN_PANEL) : <code>string</code>
2424
* _inner_
25+
* [.$bottomPanelContainer](#module_view/WorkspaceManager..$bottomPanelContainer) : <code>jQueryObject</code>
26+
* [.$statusBarPanelToggle](#module_view/WorkspaceManager..$statusBarPanelToggle) : <code>jQueryObject</code>
27+
* [._statusBarToggleInProgress](#module_view/WorkspaceManager.._statusBarToggleInProgress) : <code>boolean</code>
2528
* [.EVENT_WORKSPACE_UPDATE_LAYOUT](#module_view/WorkspaceManager..EVENT_WORKSPACE_UPDATE_LAYOUT)
2629
* [.EVENT_WORKSPACE_PANEL_SHOWN](#module_view/WorkspaceManager..EVENT_WORKSPACE_PANEL_SHOWN)
2730
* [.EVENT_WORKSPACE_PANEL_HIDDEN](#module_view/WorkspaceManager..EVENT_WORKSPACE_PANEL_HIDDEN)
28-
* [.createBottomPanel(id, $panel, [minSize])](#module_view/WorkspaceManager..createBottomPanel) ⇒ <code>Panel</code>
31+
* [.createBottomPanel(id, $panel, [minSize], [title])](#module_view/WorkspaceManager..createBottomPanel) ⇒ <code>Panel</code>
32+
* [.destroyBottomPanel(id)](#module_view/WorkspaceManager..destroyBottomPanel)
2933
* [.createPluginPanel(id, $panel, [minSize], $toolbarIcon, [initialSize])](#module_view/WorkspaceManager..createPluginPanel) ⇒ <code>Panel</code>
3034
* [.getAllPanelIDs()](#module_view/WorkspaceManager..getAllPanelIDs) ⇒ <code>Array</code>
3135
* [.getPanelForID(panelID)](#module_view/WorkspaceManager..getPanelForID) ⇒ <code>Object</code>
@@ -47,6 +51,24 @@ Constant representing the type of bottom panel
4751
Constant representing the type of plugin panel
4852

4953
**Kind**: static property of [<code>view/WorkspaceManager</code>](#module_view/WorkspaceManager)
54+
<a name="module_view/WorkspaceManager..$bottomPanelContainer"></a>
55+
56+
### view/WorkspaceManager.$bottomPanelContainer : <code>jQueryObject</code>
57+
The single container wrapping all bottom panels
58+
59+
**Kind**: inner property of [<code>view/WorkspaceManager</code>](#module_view/WorkspaceManager)
60+
<a name="module_view/WorkspaceManager..$statusBarPanelToggle"></a>
61+
62+
### view/WorkspaceManager.$statusBarPanelToggle : <code>jQueryObject</code>
63+
Chevron toggle in the status bar
64+
65+
**Kind**: inner property of [<code>view/WorkspaceManager</code>](#module_view/WorkspaceManager)
66+
<a name="module_view/WorkspaceManager.._statusBarToggleInProgress"></a>
67+
68+
### view/WorkspaceManager.\_statusBarToggleInProgress : <code>boolean</code>
69+
True while the status bar toggle button is handling a click
70+
71+
**Kind**: inner property of [<code>view/WorkspaceManager</code>](#module_view/WorkspaceManager)
5072
<a name="module_view/WorkspaceManager..EVENT_WORKSPACE_UPDATE_LAYOUT"></a>
5173

5274
### view/WorkspaceManager.EVENT\_WORKSPACE\_UPDATE\_LAYOUT
@@ -67,7 +89,7 @@ Event triggered when a panel is hidden.
6789
**Kind**: inner constant of [<code>view/WorkspaceManager</code>](#module_view/WorkspaceManager)
6890
<a name="module_view/WorkspaceManager..createBottomPanel"></a>
6991

70-
### view/WorkspaceManager.createBottomPanel(id, $panel, [minSize]) ⇒ <code>Panel</code>
92+
### view/WorkspaceManager.createBottomPanel(id, $panel, [minSize], [title]) ⇒ <code>Panel</code>
7193
Creates a new resizable panel beneath the editor area and above the status bar footer. Panel is initially invisible.
7294
The panel's size & visibility are automatically saved & restored as a view-state preference.
7395

@@ -77,7 +99,20 @@ The panel's size & visibility are automatically saved & restored as a view-state
7799
| --- | --- | --- |
78100
| id | <code>string</code> | Unique id for this panel. Use package-style naming, e.g. "myextension.feature.panelname" |
79101
| $panel | <code>jQueryObject</code> | DOM content to use as the panel. Need not be in the document yet. Must have an id attribute, for use as a preferences key. |
80-
| [minSize] | <code>number</code> | Minimum height of panel in px. |
102+
| [minSize] | <code>number</code> | @deprecated No longer used. Pass `undefined`. |
103+
| [title] | <code>string</code> | Display title shown in the bottom panel tab bar. |
104+
105+
<a name="module_view/WorkspaceManager..destroyBottomPanel"></a>
106+
107+
### view/WorkspaceManager.destroyBottomPanel(id)
108+
Destroys a bottom panel, removing it from internal registries, the tab bar, and the DOM.
109+
After calling this, the panel ID is no longer valid and the Panel instance should not be reused.
110+
111+
**Kind**: inner method of [<code>view/WorkspaceManager</code>](#module_view/WorkspaceManager)
112+
113+
| Param | Type | Description |
114+
| --- | --- | --- |
115+
| id | <code>string</code> | The panel ID that was passed to createBottomPanel. |
81116

82117
<a name="module_view/WorkspaceManager..createPluginPanel"></a>
83118

0 commit comments

Comments
 (0)