• Public
  • Public/Protected
  • All

A status bar item is a status bar contribution that can show text and icons and run a command on click.


  • StatusBarItem



Readonly id

id: string

The identifier of this item.

Note: if no identifier was provided by the window.createStatusBarItem method, the identifier will match the extension identifier.

Readonly alignment

The alignment of this item.

Optional Readonly priority

priority: number

The priority of this item. Higher value means the item should be shown more to the left.


name: undefined | string

The name of the entry, like 'Python Language Indicator', 'Git Status' etc. Try to keep the length of the name short, yet descriptive enough that users can understand what the status bar item is about.


text: string

The text to show for the entry. You can embed icons in the text by leveraging the syntax:

My text $(icon-name) contains icons like $(icon-name) this one.

Where the icon-name is taken from the ThemeIcon icon set, e.g. light-bulb, thumbsup, zap etc.


tooltip: undefined | string | MarkdownString

The tooltip text when you hover over this entry.


color: undefined | string | ThemeColor

The foreground color for this entry.


backgroundColor: undefined | ThemeColor

The background color for this entry.

Note: only the following colors are supported:

  • new ThemeColor('statusBarItem.errorBackground')
  • new ThemeColor('statusBarItem.warningBackground')

More background colors may be supported in the future.

Note: when a background color is set, the statusbar may override the color choice to ensure the entry is readable in all themes.


command: undefined | string | Command

Command or identifier of a command to run on click.

The command must be known.

Note that if this is a Command object, only the command and arguments are used by the editor.

Optional accessibilityInformation

accessibilityInformation: AccessibilityInformation

Accessibility information used when a screen reader interacts with this StatusBar item



  • show(): void


  • hide(): void


  • dispose(): void

友链:VS Code 中文文档 | VS Code 官网文档 | VS Code 扩展市场

Generated by TypeDoc. Maintained by 洛竹