Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ReactTabBarToolbarItem

Tab-bar toolbar item backed by a React.ReactNode. Unlike the TabBarToolbarItem, this item is not connected to the command service.

Hierarchy

  • RegisteredToolbarItem
  • SelfRenderingToolbarItem
  • ConditionalToolbarItem
  • Pick<InlineToolbarItemMetadata, "priority">
  • Pick<Partial<MenuToolbarItemMetadata>, "group">
    • ReactTabBarToolbarItem

Index

Properties

Methods

Properties

Optional group

group?: string

Optional group for the item. Default navigation. navigation group will be inlined, while all the others will appear in 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.

id

id: string

The unique ID of the toolbar item.

Optional 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 priority

priority?: 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 when

when?: string

https://code.visualstudio.com/docs/getstarted/keybindings#_when-clause-contexts

Methods

Optional isVisible

  • isVisible(widget?: Widget): boolean

render

  • render(widget?: Widget): ReactNode