UIAPI
Defined in: namespaces.ts:375
Methods
Section titled “Methods”registerPanel()
Section titled “registerPanel()”registerPanel(
id,options):string
Defined in: namespaces.ts:378
Registers a structured panel (sidebar or pane).
Parameters
Section titled “Parameters”string
options
Section titled “options”Returns
Section titled “Returns”string
updatePanel()
Section titled “updatePanel()”updatePanel(
id,options):string
Defined in: namespaces.ts:380
Updates an existing structured panel’s content.
Parameters
Section titled “Parameters”string
options
Section titled “options”Partial<PanelOptions>
Returns
Section titled “Returns”string
registerSidebarPanel()
Section titled “registerSidebarPanel()”registerSidebarPanel(
id,options):string
Defined in: namespaces.ts:382
Parameters
Section titled “Parameters”string
options
Section titled “options”Returns
Section titled “Returns”string
registerActivityBarItem()
Section titled “registerActivityBarItem()”registerActivityBarItem(
id,options):string
Defined in: namespaces.ts:384
Registers an activity bar item.
Parameters
Section titled “Parameters”string
options
Section titled “options”Returns
Section titled “Returns”string
registerActivityView()
Section titled “registerActivityView()”registerActivityView(
id,options):string
Defined in: namespaces.ts:386
Registers a structured activity sidebar view.
Parameters
Section titled “Parameters”string
options
Section titled “options”Returns
Section titled “Returns”string
registerStatusBarItem()
Section titled “registerStatusBarItem()”registerStatusBarItem(
id,options):string
Defined in: namespaces.ts:388
Registers a status bar item.
Parameters
Section titled “Parameters”string
options
Section titled “options”Returns
Section titled “Returns”string
unregister()
Section titled “unregister()”unregister(
tokenId):void
Defined in: namespaces.ts:390
Unregisters an existing slot-based UI contribution.
Parameters
Section titled “Parameters”tokenId
Section titled “tokenId”string
Returns
Section titled “Returns”void
showPanel()
Section titled “showPanel()”showPanel(
id,options):string
Defined in: namespaces.ts:392
Registers a content panel.
Parameters
Section titled “Parameters”string
options
Section titled “options”Returns
Section titled “Returns”string
registerContextMenuItem()
Section titled “registerContextMenuItem()”registerContextMenuItem(
id,options):string
Defined in: namespaces.ts:394
Registers a context menu item.
Parameters
Section titled “Parameters”string
options
Section titled “options”Returns
Section titled “Returns”string
registerToolbarItem()
Section titled “registerToolbarItem()”registerToolbarItem(
id,options):string
Defined in: namespaces.ts:396
Registers a toolbar item.
Parameters
Section titled “Parameters”string
options
Section titled “options”Returns
Section titled “Returns”string
registerFileRowAnnotation()
Section titled “registerFileRowAnnotation()”registerFileRowAnnotation(
id,options):string
Defined in: namespaces.ts:398
Registers a file row annotation provider.
Parameters
Section titled “Parameters”string
options
Section titled “options”Returns
Section titled “Returns”string
registerProfile()
Section titled “registerProfile()”registerProfile(
options):string
Defined in: namespaces.ts:400
Registers a profile contribution. Returns a SlotToken id for unregister.
Parameters
Section titled “Parameters”options
Section titled “options”unknown
Returns
Section titled “Returns”string
showNotification()
Section titled “showNotification()”showNotification(
options):void
Defined in: namespaces.ts:404
Shows a notification toast.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”void
showSheet()
Section titled “showSheet()”showSheet(
options):void
Defined in: namespaces.ts:406
Shows a modal sheet.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”void
setQuickFilter()
Section titled “setQuickFilter()”setQuickFilter(
text):void
Defined in: namespaces.ts:410
Sets the quick filter text on the active pane’s file list.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
showPaneTab()
Section titled “showPaneTab()”showPaneTab(
id,options?):string
Defined in: namespaces.ts:414
Opens or focuses a pane tab that renders a previously registered panel.
Parameters
Section titled “Parameters”string
options?
Section titled “options?”title?
Section titled “title?”string
"left" | "right"
Returns
Section titled “Returns”string
hidePaneTab()
Section titled “hidePaneTab()”hidePaneTab(
id):string
Defined in: namespaces.ts:416
Closes any open pane tabs for the given panel ID across both panes.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”string
openInPane()
Section titled “openInPane()”openInPane(
url,options?):string
Defined in: namespaces.ts:421
Opens a file in an in-pane viewer tab. Returns a viewer id.
Parameters
Section titled “Parameters”string
options?
Section titled “options?”"left" | "right"
"view"
Returns
Section titled “Returns”string
openTerminal()
Section titled “openTerminal()”openTerminal(
workingDirectory,options?):string
Defined in: namespaces.ts:423
Opens a terminal tab at the given working directory. Returns a viewer id.
Parameters
Section titled “Parameters”workingDirectory
Section titled “workingDirectory”string
options?
Section titled “options?”"left" | "right"
Returns
Section titled “Returns”string
openEditor()
Section titled “openEditor()”openEditor(
url,options?):string
Defined in: namespaces.ts:425
Opens a code editor tab for the given file URL. Returns a viewer id.
Parameters
Section titled “Parameters”string
options?
Section titled “options?”"left" | "right"
Returns
Section titled “Returns”string
openWebView()
Section titled “openWebView()”openWebView(
url,options?):string
Defined in: namespaces.ts:427
Opens a web browser tab for the given URL. Returns a viewer id.
Parameters
Section titled “Parameters”string
options?
Section titled “options?”"left" | "right"
Returns
Section titled “Returns”string
openMarkdownPreview()
Section titled “openMarkdownPreview()”openMarkdownPreview(
url,options?):string
Defined in: namespaces.ts:429
Opens a markdown preview tab for the given file URL. Returns a viewer id.
Parameters
Section titled “Parameters”string
options?
Section titled “options?”"left" | "right"
Returns
Section titled “Returns”string
openAIChat()
Section titled “openAIChat()”openAIChat(
options?):string
Defined in: namespaces.ts:431
Opens a new AI chat pane tab with optional prefill. Returns a viewer id.
Parameters
Section titled “Parameters”options?
Section titled “options?”"left" | "right"
connector?
Section titled “connector?”string
systemPrompt?
Section titled “systemPrompt?”string
context?
Section titled “context?”string[]
Returns
Section titled “Returns”string
registerWebPanel()
Section titled “registerWebPanel()”registerWebPanel(
id,options):string
Defined in: namespaces.ts:440
Registers a WebView panel definition. Returns a registration id.
Parameters
Section titled “Parameters”string
options
Section titled “options”Returns
Section titled “Returns”string
postToWebPanel()
Section titled “postToWebPanel()”postToWebPanel(
panelId,message,options?):unknown
Defined in: namespaces.ts:442
Posts a JSON message to active WebView instances of a panel.
Parameters
Section titled “Parameters”panelId
Section titled “panelId”string
message
Section titled “message”unknown
options?
Section titled “options?”instanceId?
Section titled “instanceId?”string
Returns
Section titled “Returns”unknown
onWebPanelMessage()
Section titled “onWebPanelMessage()”onWebPanelMessage(
panelId,handler):string
Defined in: namespaces.ts:444
Registers a fire-and-forget message handler for WebView messages. Returns a token.
Parameters
Section titled “Parameters”panelId
Section titled “panelId”string
handler
Section titled “handler”(message) => void
Returns
Section titled “Returns”string
onWebPanelRequest()
Section titled “onWebPanelRequest()”onWebPanelRequest(
panelId,handler):string
Defined in: namespaces.ts:446
Registers a request/response handler for WebView messages. Returns a token.
Parameters
Section titled “Parameters”panelId
Section titled “panelId”string
handler
Section titled “handler”(message) => unknown
Returns
Section titled “Returns”string
pipeShellToWebPanel()
Section titled “pipeShellToWebPanel()”pipeShellToWebPanel(
panelId,shellOptions):Promise<ShellExecuteResult>
Defined in: namespaces.ts:448
Pipes shell output to WebView panel instances.
Parameters
Section titled “Parameters”panelId
Section titled “panelId”string
shellOptions
Section titled “shellOptions”Returns
Section titled “Returns”Promise<ShellExecuteResult>