Functions

Category

Sort by

Filters

Has Original VSCode APIIs a Composable

asAbsolutePath-A shorthand for ExtensionContext.asAbsolutePath

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

useCommentController-Reactive API for comments.createCommentController.

debug

useActiveDebugSession-Reactive API for debug.activeDebugSession.

document

useDocumentText-Reactive API for TextDocument.getText.

editor

useActiveEditorDecorations-Reactively set decorations on the active editor. See window.activeTextEditor.

useActiveNotebookEditor-Reactive API for window.activeNotebookEditor.

useActiveTextEditor-Reactive API for window.activeTextEditor.

useEditorDecorations-Reactively set decorations on the given editor. See TextEditor.setDecorations.

useNotebookEditorSelection-Reactive API for NotebookEditor.selection.

useNotebookEditorSelections-Reactive API for NotebookEditor.selections.

useNotebookEditorVisibleRanges-Reactive API for NotebookEditor.visibleRanges.

useTextEditorSelection-Reactive API for TextEditor.selection.

useTextEditorSelections-Reactive API for TextEditor.selections.

useTextEditorViewColumn-Reactive API for TextEditor.viewColumn.

useTextEditorVisibleRanges-Reactive API for TextEditor.visibleRanges.

useVisibleNotebookEditors-Reactive API for window.visibleNotebookEditors.

useVisibleTextEditors-Reactive API for window.visibleTextEditors.

env

useDefaultShell-Reactive API for env.shell.

useIsTelemetryEnabled-Reactive API for env.isTelemetryEnabled.

useLogLevel-Reactive API for env.logLevel.

extension

useAllExtensions-Reactive API for extensions.all.

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

l10n

useL10nText-Reactive API for l10n.t.

languages

useFoldingRangeProvider-Reactive API for languages.registerFoldingRangeProvider.

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

useFetchTasks-Reactive API for tasks.fetchTasks.

useTaskExecutions-Reactive API for tasks.taskExecutions.

terminal

useActiveTerminal-Reactive API for window.activeTerminal.

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

useOpenedTerminals-Reactive API for window.terminals.

useTerminal-Reactive API for window.createTerminal().

useTerminalState-Reactive API for Terminal.state.

utilities

useAbsolutePath-Reactive API for ExtensionContext.asAbsolutePath.

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.

useOutputChannel-Reactive API for window.createOutputChannel.

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.

useWebviewView-Register a webview view. See window.registerWebviewViewProvider.

defineLogger-Define a logger which is usable before activation.

window

useActiveColorTheme-Reactive API for window.activeColorTheme.

useIsDarkTheme-Determines if the current color theme is dark. See ColorTheme.kind.

useQuickPick-Creates a customizable quick pick UI.

useStatusBarItem-Reactive API for window.createStatusBarItem.

useWindowState-Reactive API for window.state.

workspace

useFsWatcher-Reactive API for workspace.createFileSystemWatcher.

useWorkspaceFolders-Reactive API for workspace.workspaceFolders.