Skip to main content

modules/window/statusBar

Interfaces​

StatusBarItemController​

Defined in: modules/window/statusBar.d.ts:55

Controller interface returned upon successfully registering a status bar item. Allows dynamic, real-time patching of the item's properties.

Methods​

dispose()​

dispose(): void

Defined in: modules/window/statusBar.d.ts:64

Completely removes the item from the registry and frees up memory allocations.

Returns​

void

update()​

update(patch): void

Defined in: modules/window/statusBar.d.ts:61

Dynamically patches specific properties of the status bar item.

Parameters​
patch​

Partial<Omit<StatusBarItemOptions, "id">>

An object containing only the properties you wish to update.

Returns​

void

Example​
statusItem.update({ label: 'Parsing...', spin: true });

StatusBarItemOptions​

Defined in: modules/window/statusBar.d.ts:15

Configuration object for registering a new Status Bar item. This declarative pattern allows the IDE to evaluate visibility conditions and layout constraints before rendering.

Properties​

alignment?​

optional alignment?: StatusBarAlignment

Defined in: modules/window/statusBar.d.ts:19

The alignment position in the status bar. Defaults to 'left'.

className?​

optional className?: string

Defined in: modules/window/statusBar.d.ts:46

Optional CSS class names for custom layout tracking.

color?​

optional color?: string

Defined in: modules/window/statusBar.d.ts:30

Custom hexadecimal or CSS variable color applied to text/icons (e.g., 'var(--ms-error)').

hidden?​

optional hidden?: boolean

Defined in: modules/window/statusBar.d.ts:34

If true, the item is registered but unmounted from the DOM layout.

icon?​

optional icon?: string

Defined in: modules/window/statusBar.d.ts:26

Codicon alphanumeric name string mapping the indicator icon next to text.

id​

id: string

Defined in: modules/window/statusBar.d.ts:17

The universally unique identifier for this item (e.g., 'myExt.linter').

label?​

optional label?: string

Defined in: modules/window/statusBar.d.ts:24

The natural descriptive text displayed in the status bar.

onClick?​

optional onClick?: (e) => void

Defined in: modules/window/statusBar.d.ts:43

Callback executed when the user clicks the status bar item.

Parameters​
e​

MouseEvent

Returns​

void

priority?​

optional priority?: number

Defined in: modules/window/statusBar.d.ts:21

Layout priority. Higher numbers are placed closer to the outer edges. Defaults to 0.

spin?​

optional spin?: boolean

Defined in: modules/window/statusBar.d.ts:32

If true, applies an infinite spin animation to the icon.

style?​

optional style?: CSSProperties

Defined in: modules/window/statusBar.d.ts:48

Optional inline CSS styles passed down to the root block.

tooltip?​

optional tooltip?: string

Defined in: modules/window/statusBar.d.ts:28

Hover tooltip text shown to the user.

when?​

optional when?: string

Defined in: modules/window/statusBar.d.ts:40

Condition clause evaluated dynamically to determine if the item should be visible.

Example​
"activeTabType == 'code' && isWorkspaceOpen"

Type Aliases​

StatusBarAlignment​

StatusBarAlignment = "left" | "right"

Defined in: modules/window/statusBar.d.ts:8

References​

ActivityBarItemOptions​

Re-exports ActivityBarItemOptions

app​

Re-exports app

authentication​

Re-exports authentication

BookmarkFolder​

Re-exports BookmarkFolder

CommandMetadata​

Re-exports CommandMetadata

commands​

Re-exports commands

CommitOptions​

Re-exports CommitOptions

ConfigurationProperty​

Re-exports ConfigurationProperty

CopyOptions​

Re-exports CopyOptions

Diagnostic​

Re-exports Diagnostic

DiagnosticCollection​

Re-exports DiagnosticCollection

DiagnosticSeverity​

Re-exports DiagnosticSeverity

Disposable​

Re-exports Disposable

DocumentSymbol​

Re-exports DocumentSymbol

ExtensionContext​

Re-exports ExtensionContext

ExtensionInfo​

Re-exports ExtensionInfo

extensions​

Re-exports extensions

FileDecoration​

Re-exports FileDecoration

FileFilter​

Re-exports FileFilter

FileStat​

Re-exports FileStat

FileSystemAPI​

Re-exports FileSystemAPI

FindOptions​

Re-exports FindOptions

fs​

Re-exports fs

git​

Re-exports git

GitBranch​

Re-exports GitBranch

GitChangedFile​

Re-exports GitChangedFile

GitCommit​

Re-exports GitCommit

GitFileStatus​

Re-exports GitFileStatus

GitHubUser​

Re-exports GitHubUser

GitRepository​

Re-exports GitRepository

GitSortMode​

Re-exports GitSortMode

GitStash​

Re-exports GitStash

IConfigurationSection​

Re-exports IConfigurationSection

IconThemeDefinition​

Re-exports IconThemeDefinition

IconThemeMap​

Re-exports IconThemeMap

InputBoxOptions​

Re-exports InputBoxOptions

languages​

Re-exports languages

lsp​

Re-exports lsp

LspServerConfig​

Re-exports LspServerConfig

Re-exports MenuItem

Re-exports menus

ModalOptions​

Re-exports ModalOptions

MSCodeUIColors​

Re-exports MSCodeUIColors

MultiPickerOptions​

Re-exports MultiPickerOptions

NotificationAction​

Re-exports NotificationAction

OutputChannel​

Re-exports OutputChannel

PickerOptions​

Re-exports PickerOptions

Position​

Re-exports Position

ProgressNotification​

Re-exports ProgressNotification

QuickPickItem​

Re-exports QuickPickItem

QuickPickOptions​

Re-exports QuickPickOptions

RecentWorkspace​

Re-exports RecentWorkspace

ReplaceOptions​

Re-exports ReplaceOptions

ResolvedIcon​

Re-exports ResolvedIcon

Re-exports search

SearchFileResult​

Re-exports SearchFileResult

SearchMatch​

Re-exports SearchMatch

Selection​

Re-exports Selection

SettingOption​

Re-exports SettingOption

SettingType​

Re-exports SettingType

SidebarPanelDef​

Re-exports SidebarPanelDef

SidebarPanelHeader​

Re-exports SidebarPanelHeader

SidebarSectionContent​

Re-exports SidebarSectionContent

SidebarSectionContext​

Re-exports SidebarSectionContext

SidebarSectionDef​

Re-exports SidebarSectionDef

SidebarState​

Re-exports SidebarState

SilentSearchOptions​

Re-exports SilentSearchOptions

StashOptions​

Re-exports StashOptions

SymbolKind​

Re-exports SymbolKind

SymbolProvider​

Re-exports SymbolProvider

Tab​

Re-exports Tab

TabDiffData​

Re-exports TabDiffData

TabOptions​

Re-exports TabOptions

TabType​

Re-exports TabType

TaskExecution​

Re-exports TaskExecution

TaskOptions​

Re-exports TaskOptions

tasks​

Re-exports tasks

Terminal​

Re-exports Terminal

TerminalExitStatus​

Re-exports TerminalExitStatus

TerminalOptions​

Re-exports TerminalOptions

termis​

Re-exports termis

TermisView​

Re-exports TermisView

TextDocument​

Re-exports TextDocument

TextEditor​

Re-exports TextEditor

TextEditorEdit​

Re-exports TextEditorEdit

TextEditorOptions​

Re-exports TextEditorOptions

ThemeDefinition​

Re-exports ThemeDefinition

themes​

Re-exports themes

TokenColor​

Re-exports TokenColor

TreeDataProvider​

Re-exports TreeDataProvider

TreeItem​

Re-exports TreeItem

TreeView​

Re-exports TreeView

TreeViewOptions​

Re-exports TreeViewOptions

window​

Re-exports window

workspace​

Re-exports workspace

WorkspaceConfiguration​

Re-exports WorkspaceConfiguration

WorkspaceFolder​

Re-exports WorkspaceFolder

WriteOptions​

Re-exports WriteOptions