Skip to main content

Interface: StatusBarItem

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

Properties

alignment

readonly alignment: StatusBarAlignment

The alignment of this item.

Source

packages/extension-api/src/extension-api.d.ts:1352


command?

optional command: string

The identifier of a command, previously registered with commands.registerCommand, to run on click.

Source

packages/extension-api/src/extension-api.d.ts:1380


commandArgs?

optional commandArgs: any[]

Arguments that the command handler should be invoked with.

Source

packages/extension-api/src/extension-api.d.ts:1385


enabled

enabled: boolean

Marks an item as disabled. When property is set to true, then icon will be changed to inactive and there won't be possible to execute a command if it is provided in the following configuration.

Source

packages/extension-api/src/extension-api.d.ts:1376


iconClass?

optional iconClass: string | object

Icon class that is used to display the particular icon from the Font Awesome icon set. Icon class should be in format e.g. 'fa fa-toggle-on'. It is possible to provide an icons for state which can be enabled or disabled.

Source

packages/extension-api/src/extension-api.d.ts:1371


priority

readonly priority: number

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

Source

packages/extension-api/src/extension-api.d.ts:1357


text?

optional text: string

The text to show for the entry.

Source

packages/extension-api/src/extension-api.d.ts:1361


tooltip?

optional tooltip: string

The tooltip text when you hover over this entry.

Source

packages/extension-api/src/extension-api.d.ts:1365

Methods

dispose()

dispose(): void

Dispose and free associated resources. Call StatusBarItem.hide.

Returns

void

Source

packages/extension-api/src/extension-api.d.ts:1399


hide()

hide(): void

Hides the entry in the status bar.

Returns

void

Source

packages/extension-api/src/extension-api.d.ts:1393


show()

show(): void

Shows the entry in the status bar.

Returns

void

Source

packages/extension-api/src/extension-api.d.ts:1389