Class TabBarRenderer

A tab bar renderer that offers a context menu. In addition, this renderer is able to set an explicit position and size on the icon and label of each tab in a side bar. This is necessary because the elements of side bar tabs are rotated using the CSS transform property, disrupting the browser's ability to arrange those elements automatically.

Hierarchy (View Summary)

TabBar.Renderer
- TabBarRenderer

Constructors

constructor

new TabBarRenderer(
    contextMenuRenderer?: ContextMenuRenderer,
    decoratorService?: TabBarDecoratorService,
    iconThemeService?: IconThemeService,
    selectionService?: SelectionService,
    commandService?: CommandService,
    corePreferences?: CorePreferences,
    hoverService?: HoverService,
    contextKeyService?: ContextKeyService,
): TabBarRenderer
TODO refactor shell, rendered should only receive props with event handlers events should be handled by clients, like ApplicationShell right now it is mess: (1) client logic belong to renderer, (2) cyclic dependencies between renderers and clients
Parameters
- OptionalcontextMenuRenderer: ContextMenuRenderer
- OptionaldecoratorService: TabBarDecoratorService
- OptionaliconThemeService: IconThemeService
- OptionalselectionService: SelectionService
- OptionalcommandService: CommandService
- OptionalcorePreferences: CorePreferences
- OptionalhoverService: HoverService
- OptionalcontextKeyService: ContextKeyService
Returns TabBarRenderer
Overrides Renderer.constructor
- Defined in packages/core/src/browser/shell/tab-bars.ts:100

Properties

`Protected` `Optional`_tabBar

_tabBar?: TabBar<Widget>

`Readonly`closeIconSelector

closeIconSelector: ".lm-TabBar-tabCloseIcon"

A selector which matches the close icon node in a tab.

`Protected` `Optional` `Readonly`commandService

commandService?: CommandService

`Protected` `Optional` `Readonly`contextKeyService

contextKeyService?: ContextKeyService

`Optional`contextMenuPath

contextMenuPath?: MenuPath

The menu path used to render the context menu.

`Protected` `Optional` `Readonly`contextMenuRenderer

contextMenuRenderer?: ContextMenuRenderer

`Protected` `Optional` `Readonly`corePreferences

corePreferences?: CorePreferences

`Protected` `Readonly`decorations

decorations: Map<Title<Widget>, WidgetDecoration.Data[]> = ...

`Protected` `Optional` `Readonly`decoratorService

decoratorService?: TabBarDecoratorService

`Protected` `Optional` `Readonly`hoverService

hoverService?: HoverService

`Protected` `Optional` `Readonly`iconThemeService

iconThemeService?: IconThemeService

`Protected` `Optional` `Readonly`selectionService

selectionService?: SelectionService

`Protected` `Readonly`toDispose

toDispose: DisposableCollection = ...

`Protected` `Readonly`toDisposeOnTabBar

toDisposeOnTabBar: DisposableCollection = ...

Accessors

tabBar

get tabBar(): undefined | TabBar<Widget>
Returns undefined | TabBar<Widget>
- Defined in packages/core/src/browser/shell/tab-bars.ts:160
set tabBar(tabBar: undefined | TabBar<Widget>): void
A reference to the tab bar is required in order to activate it when a context menu is requested.
Parameters
- tabBar: undefined | TabBar<Widget>
Returns void
- Defined in packages/core/src/browser/shell/tab-bars.ts:143

Methods

createIconClass

createIconClass(data: TabBar.IRenderData<any>): string
Create the class name for the tab icon.
Parameters
- data: TabBar.IRenderData<any>
  The data to use for the tab.
Returns string
The full class name for the tab icon.
Inherited from Renderer.createIconClass
- Defined in node_modules/@lumino/widgets/types/tabbar.d.ts:704

createTabARIA

createTabARIA(
data: TabBar.IRenderData<any>,
): ElementARIAAttrs | ElementBaseAttrs
Create the ARIA attributes for a tab.
Parameters
- data: TabBar.IRenderData<any>
  The data to use for the tab.
Returns ElementARIAAttrs | ElementBaseAttrs
The ARIA attributes for the tab.
Inherited from Renderer.createTabARIA
- Defined in node_modules/@lumino/widgets/types/tabbar.d.ts:696

createTabClass

createTabClass(data: SideBarRenderData): string
Create the class name for the tab.
Parameters
- data: SideBarRenderData
  The data to use for the tab.
Returns string
The full class name for the tab.
Overrides Renderer.createTabClass
- Defined in packages/core/src/browser/shell/tab-bars.ts:223

createTabDataset

createTabDataset(data: TabBar.IRenderData<any>): ElementDataset
Create the dataset for a tab.
Parameters
- data: TabBar.IRenderData<any>
  The data to use for the tab.
Returns ElementDataset
The dataset for the tab.
Inherited from Renderer.createTabDataset
- Defined in node_modules/@lumino/widgets/types/tabbar.d.ts:688

createTabId

createTabId(title: Title<Widget>, isPartOfHiddenTabBar?: boolean): string
Generate ID for an entry in the tab bar
Parameters
- title: Title<Widget>
  Title of the widget controlled by this tab bar
- isPartOfHiddenTabBar: boolean = false
  Tells us if this entry is part of the hidden horizontal tab bar. If yes, add a suffix to differentiate it's ID from the entry in the visible tab bar
Returns string
DOM element ID
- Defined in packages/core/src/browser/shell/tab-bars.ts:238

createTabKey

createTabKey(data: TabBar.IRenderData<any>): string
Create a unique render key for the tab.
Parameters
- data: TabBar.IRenderData<any>
  The data to use for the tab.
Returns string
The unique render key for the tab.

Notes
This method caches the key against the tab title the first time the key is generated. This enables efficient rendering of moved tabs and avoids subtle hover style artifacts.
Inherited from Renderer.createTabKey
- Defined in node_modules/@lumino/widgets/types/tabbar.d.ts:664

createTabStyle

createTabStyle(
data: SideBarRenderData & ScrollableRenderData,
): ElementInlineStyle
If size information is available for the label and icon, set an explicit height on the tab. The height value also considers padding, which should be derived from CSS settings.
Parameters
- data: SideBarRenderData & ScrollableRenderData
Returns ElementInlineStyle
Overrides Renderer.createTabStyle
- Defined in packages/core/src/browser/shell/tab-bars.ts:246

dispose

dispose(): void
Returns void
- Defined in packages/core/src/browser/shell/tab-bars.ts:133

findDuplicateLabels

findDuplicateLabels(titles: Title<Widget>[]): Map<string, string>
Find duplicate labels from the currently opened tabs in the tab bar. Return the appropriate partial paths that can distinguish the identical labels.

E.g., a/p/index.ts => a/..., b/p/index.ts => b/...

To prevent excessively long path displayed, show at maximum three levels from the end by default.
Parameters
- titles: Title<Widget>[]
  Array of titles in the current tab bar.
Returns Map<string, string>
A map from each tab's original path to its displayed partial path.
- Defined in packages/core/src/browser/shell/tab-bars.ts:422

`Protected`getDecorationData

getDecorationData<K extends keyof WidgetDecoration.Data>(
title: Title<Widget>,
key: K,
): WidgetDecoration.Data[K][]
Get the decoration data given the tab URI and the decoration data type.
Type Parameters
- K extends keyof WidgetDecoration.Data
Parameters
- title: Title<Widget>
  The title.
- key: K
  The type of the decoration data.
Returns WidgetDecoration.Data[K][]
- Defined in packages/core/src/browser/shell/tab-bars.ts:398

`Protected`getDecorations

getDecorations(title: Title<Widget>): WidgetDecoration.Data[]
Get all available decorations of a given tab.
Parameters
- title: Title<Widget>
  The widget title.
Returns WidgetDecoration.Data[]
- Defined in packages/core/src/browser/shell/tab-bars.ts:378

`Protected`getIconClass

getIconClass(iconName: string | string[], additionalClasses?: string[]): string
Get the class of an icon.
Parameters
- iconName: string | string[]
  The name of the icon.
- additionalClasses: string[] = []
  Additional classes of the icon.
Returns string
- Defined in packages/core/src/browser/shell/tab-bars.ts:407

`Protected`handleCloseClickEvent

handleCloseClickEvent(event: MouseEvent): void
Parameters
- event: MouseEvent
Returns void
- Defined in packages/core/src/browser/shell/tab-bars.ts:682

`Protected`handleContextMenuEvent

handleContextMenuEvent(event: MouseEvent): void
Parameters
- event: MouseEvent
Returns void
- Defined in packages/core/src/browser/shell/tab-bars.ts:651

`Protected`handleDblClickEvent

handleDblClickEvent(event: MouseEvent): void
Parameters
- event: MouseEvent
Returns void
- Defined in packages/core/src/browser/shell/tab-bars.ts:692

`Protected`handleMouseEnterEvent

handleMouseEnterEvent(event: MouseEvent): void
Parameters
- event: MouseEvent
Returns void
- Defined in packages/core/src/browser/shell/tab-bars.ts:627

renderBadge

renderBadge(data: SideBarRenderData, isInSidePanel?: boolean): VirtualElement
Parameters
- data: SideBarRenderData
- OptionalisInSidePanel: boolean
Returns VirtualElement
- Defined in packages/core/src/browser/shell/tab-bars.ts:344

renderCloseIcon

renderCloseIcon(data: TabBar.IRenderData<any>): VirtualElement
Render the close icon element for a tab.
Parameters
- data: TabBar.IRenderData<any>
  The data to use for rendering the tab.
Returns VirtualElement
A virtual element representing the tab close icon.
Inherited from Renderer.renderCloseIcon
- Defined in node_modules/@lumino/widgets/types/tabbar.d.ts:651

`Protected`renderEnhancedPreview

renderEnhancedPreview(title: Title<Widget>): HTMLDivElement
Parameters
- title: Title<Widget>
Returns HTMLDivElement
- Defined in packages/core/src/browser/shell/tab-bars.ts:553

renderIcon

renderIcon(data: SideBarRenderData, isInSidePanel?: boolean): VirtualElement
If size information is available for the icon, set it as inline style. Tab padding is also considered in the top position.
Parameters
- data: SideBarRenderData
  Data used to render the tab icon.
- OptionalisInSidePanel: boolean
  An optional check which determines if the tab is in the side-panel.
Returns VirtualElement
Overrides Renderer.renderIcon
- Defined in packages/core/src/browser/shell/tab-bars.ts:503

renderLabel

renderLabel(data: SideBarRenderData, isInSidePanel?: boolean): VirtualElement
If size information is available for the label, set it as inline style. Tab padding and icon size are also considered in the top position.
Parameters
- data: SideBarRenderData
  Data used to render the tab.
- OptionalisInSidePanel: boolean
  An optional check which determines if the tab is in the side-panel.
Returns VirtualElement
The virtual element of the rendered label.
Overrides Renderer.renderLabel
- Defined in packages/core/src/browser/shell/tab-bars.ts:278

renderLock

renderLock(data: SideBarRenderData, isInSidePanel?: boolean): VirtualElement
Parameters
- data: SideBarRenderData
- OptionalisInSidePanel: boolean
Returns VirtualElement
- Defined in packages/core/src/browser/shell/tab-bars.ts:355

renderTab

renderTab(
    data: SideBarRenderData,
    isInSidePanel?: boolean,
    isPartOfHiddenTabBar?: boolean,
): VirtualElement
Render tabs with the default DOM structure, but additionally register a context menu listener.
Parameters
- data: SideBarRenderData
  Data used to render the tab.
- OptionalisInSidePanel: boolean
  An optional check which determines if the tab is in the side-panel.
- OptionalisPartOfHiddenTabBar: boolean
  An optional check which determines if the tab is in the hidden horizontal tab bar.
Returns VirtualElement
The virtual element of the rendered tab.
Overrides Renderer.renderTab
- Defined in packages/core/src/browser/shell/tab-bars.ts:171

`Protected`renderTailDecorations

renderTailDecorations(
renderData: SideBarRenderData,
isInSidePanel?: boolean,
): VirtualElement[]
Parameters
- renderData: SideBarRenderData
- OptionalisInSidePanel: boolean
Returns VirtualElement[]
- Defined in packages/core/src/browser/shell/tab-bars.ts:313

`Protected`renderVisualPreview

renderVisualPreview(
desiredWidth: number,
title: Title<Widget>,
): undefined | HTMLElement
Parameters
- desiredWidth: number
- title: Title<Widget>
Returns undefined | HTMLElement
- Defined in packages/core/src/browser/shell/tab-bars.ts:575

`Protected`resetDecorations

resetDecorations(title?: Title<Widget>): void
Parameters
- Optionaltitle: Title<Widget>
Returns void
- Defined in packages/core/src/browser/shell/tab-bars.ts:363

Class TabBarRenderer

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns TabBarRenderer

Properties

Protected Optional_tabBar

ReadonlycloseIconSelector

Protected Optional ReadonlycommandService

Protected Optional ReadonlycontextKeyService

OptionalcontextMenuPath

Protected Optional ReadonlycontextMenuRenderer

Protected Optional ReadonlycorePreferences

Protected Readonlydecorations

Protected Optional ReadonlydecoratorService

Protected Optional ReadonlyhoverService

Protected Optional ReadonlyiconThemeService

Protected Optional ReadonlyselectionService

Protected ReadonlytoDispose

Protected ReadonlytoDisposeOnTabBar

Accessors

tabBar

Returns undefined | TabBar<Widget>

Parameters

Returns void

Methods

createIconClass

Parameters

Returns string

createTabARIA

Parameters

Returns ElementARIAAttrs | ElementBaseAttrs

createTabClass

Parameters

Returns string

createTabDataset

Parameters

Returns ElementDataset

createTabId

Parameters

Returns string

createTabKey

Parameters

Returns string

Notes

createTabStyle

Parameters

Returns ElementInlineStyle

dispose

Returns void

findDuplicateLabels

Parameters

Returns Map<string, string>

ProtectedgetDecorationData

Type Parameters

Parameters

Returns WidgetDecoration.Data[K][]

ProtectedgetDecorations

Parameters

Returns WidgetDecoration.Data[]

ProtectedgetIconClass

Parameters

Returns string

ProtectedhandleCloseClickEvent

Parameters

Returns void

ProtectedhandleContextMenuEvent

Parameters

Returns void

ProtectedhandleDblClickEvent

Parameters

Returns void

ProtectedhandleMouseEnterEvent

Parameters

`Protected` `Optional`_tabBar

`Readonly`closeIconSelector

`Protected` `Optional` `Readonly`commandService

`Protected` `Optional` `Readonly`contextKeyService

`Optional`contextMenuPath

`Protected` `Optional` `Readonly`contextMenuRenderer

`Protected` `Optional` `Readonly`corePreferences

`Protected` `Readonly`decorations

`Protected` `Optional` `Readonly`decoratorService

`Protected` `Optional` `Readonly`hoverService

`Protected` `Optional` `Readonly`iconThemeService

`Protected` `Optional` `Readonly`selectionService

`Protected` `Readonly`toDispose

`Protected` `Readonly`toDisposeOnTabBar

`Protected`getDecorationData

`Protected`getDecorations

`Protected`getIconClass

`Protected`handleCloseClickEvent

`Protected`handleContextMenuEvent

`Protected`handleDblClickEvent

`Protected`handleMouseEnterEvent

`Protected`renderEnhancedPreview

`Protected`renderTailDecorations

`Protected`renderVisualPreview

`Protected`resetDecorations