Skip to content

Functions

Category
Sort by
Filters

commands

useCommand-Register a command. See commands.registerCommand.
useCommands-Register multiple commands. See commands.registerCommand.
useTextEditorCommand-Register a text editor command. See commands.registerTextEditorCommand.
useTextEditorCommands-Register multiple text editor commands. See commands.registerTextEditorCommand.
executeCommand-Execute a command, with type checking. See commands.executeCommand.

comments

debug

document

editor

useActiveEditorDecorations-Reactively set decorations on the active editor. See window.activeTextEditor.
useEditorDecorations-Reactively set decorations on the given editor. See TextEditor.setDecorations.

env

useDefaultShell-Reactive API for env.shell.
useLogLevel-Reactive API for env.logLevel.

extension

useExtensionSecret-Get a reactive secret value from the extension's secrets.

l10n

useL10nText-Reactive API for l10n.t.

languages

lifecycle

useDisposable-Dispose the disposable when the current scope is disposed. See Disposable.
useVscodeContext-Reactively set a VS Code context. See custom when clause context.
defineConfigObject-Define configurations of an extension. See workspace.getConfiguration. You can use this function with vscode-ext-gen.
defineConfigs-Define configurations of an extension. See workspace.getConfiguration. You can use this function with vscode-ext-gen.
defineExtension-Define a new extension.
onActivate-Registers a callback to be called after the extension has been activated.
onDeactivate-Registers a callback to be called when the extension is deactivated.
tryOnScopeDispose-The safe version of onScopeDispose.

tasks

terminal

useControlledTerminal-Create terminal, and allows you to control the terminal lifecycle.

utilities

useEvent-Reactive API for Event.
useEventEmitter-Reactive API for EventEmitter.
useFileUri-Reactive API for Uri.file.
createKeyedComposable-Creates a composable that caches the result of a function based on a key.
createSingletonComposable-Creates a composable that should only be called once.

view

useLogger-Creates a logger that writes to the output channel.
useTreeView-Register a tree view. See window.createTreeView.
useViewBadge-Reactively set the badge of a view (TreeView or WebviewView).
useViewTitle-Reactively set the title of a view (TreeView or WebviewView).
useViewVisibility-Reactively get the visibility of a view (TreeView or WebviewView).
useWebviewPanel-Register a webview panel. See window.createWebviewPanel.
defineLogger-Define a logger which is usable before activation.

window

useIsDarkTheme-Determines if the current color theme is dark. See ColorTheme.kind.
useQuickPick-Creates a customizable quick pick UI.
useWindowState-Reactive API for window.state.

workspace