• Public
  • Public/Protected
  • All

Namespace TabBarToolbarItem

Representation of an item in the tab



Readonly command

command: string

The command to execute.

Optional Readonly group

group: undefined | string

Optional group for the item. Default navigation. navigation group will be inlined, while all the others will be within the ... dropdown. A group in format submenu_group_1/submenu 1/.../submenu_group_n/ submenu n/item_group means that the item will be located in a submenu(s) of the ... dropdown. The submenu's title is named by the submenu section name, e.g. group/<submenu name>/subgroup.

Optional Readonly icon

icon: string | (() => string)

Optional icon for the item.

Readonly id

id: string

The unique ID of the toolbar item.

Optional Readonly onDidChange

onDidChange: Event<void>

When defined, the container tool-bar will be updated if this event is fired.

Note: currently, each item of the container toolbar will be re-rendered if any of the items have changed.

Optional Readonly priority

priority: undefined | number

Priority among the items. Can be negative. The smaller the number the left-most the item will be placed in the toolbar. It is 0 by default.

Optional Readonly text

text: undefined | string

Optional text of the item.

Shamelessly copied and reused from status-bar:

More details about the available fontawesome icons and CSS class names can be hound here. To set a text with icon use the following pattern in text string:


To use animated icons use the following pattern:


The type of animation can be either spin or pulse. Look here for more information to animated icons.

Optional Readonly tooltip

tooltip: undefined | string

Optional tooltip for the item.

Optional Readonly when

when: undefined | string




  • is(arg: Object | undefined): arg is TabBarToolbarItem