StatusBarItem

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

Online Documentation

Properties

Link copied to clipboard

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

Link copied to clipboard

The alignment of this item.

Link copied to clipboard

The background color for this entry.

Link copied to clipboard
abstract var color: JsAny?

The foreground color for this entry.

Link copied to clipboard
abstract var command: JsAny?

{@linkcode Command} or identifier of a command to run on click.

Link copied to clipboard
abstract val id: String

The identifier of this item.

Link copied to clipboard
abstract var name: 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.

Link copied to clipboard
abstract val priority: Int?

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

Link copied to clipboard
abstract var text: String

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

Link copied to clipboard
abstract var tooltip: JsAny?

The tooltip text when you hover over this entry.

Functions

Link copied to clipboard
abstract override fun dispose()

Dispose and free associated resources. Call hide.

Link copied to clipboard
abstract fun hide()

Hide the entry in the status bar.

Link copied to clipboard
abstract fun show()

Shows the entry in the status bar.