Class Renderer

The default implementation of IRenderer.

Notes

Subclasses are free to reimplement rendering methods as needed.

Implements

TabBar.IRenderer<any>

Index

Constructors

Properties

_tabID _tabKeys _uuid closeIconSelector _nInstance

Methods

createIconClass createTabARIA createTabClass createTabDataset createTabKey createTabStyle renderCloseIcon renderIcon renderLabel renderTab

Constructors

constructor

new Renderer(): TabBar.Renderer
Returns TabBar.Renderer
- Defined in widgets/src/tabbar.ts:1682

Properties

`Private` _tabID

_tabID: number = 0

`Private` _tabKeys

_tabKeys: WeakMap<Title<any>, string> = ...

`Private` `Readonly` _uuid

_uuid: number

`Readonly` closeIconSelector

closeIconSelector: ".lm-TabBar-tabCloseIcon" = '.lm-TabBar-tabCloseIcon'

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

`Private` `Static` _nInstance

_nInstance: number = 0

Methods

createIconClass

createIconClass(data): 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.
- Defined in widgets/src/tabbar.ts:1844

createTabARIA

createTabARIA(data): 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.
- Defined in widgets/src/tabbar.ts:1829

createTabClass

createTabClass(data): string
Create the class name for the tab.
Parameters
- data: TabBar.IRenderData<any>
  The data to use for the tab.
Returns string
The full class name for the tab.
- Defined in widgets/src/tabbar.ts:1797

createTabDataset

createTabDataset(data): 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.
- Defined in widgets/src/tabbar.ts:1818

createTabKey

createTabKey(data): 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.
- Defined in widgets/src/tabbar.ts:1770

createTabStyle

createTabStyle(data): ElementInlineStyle
Create the inline style object for a tab.
Parameters
- data: TabBar.IRenderData<any>
  The data to use for the tab.
Returns ElementInlineStyle
The inline style data for the tab.
- Defined in widgets/src/tabbar.ts:1786

renderCloseIcon

renderCloseIcon(data): 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.
- Defined in widgets/src/tabbar.ts:1754

renderIcon

renderIcon(data): VirtualElement
Render the 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 icon.
- Defined in widgets/src/tabbar.ts:1728

renderLabel

renderLabel(data): VirtualElement
Render the label 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 label.
- Defined in widgets/src/tabbar.ts:1743

renderTab

renderTab(data): VirtualElement
Render the virtual 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.
Implementation of IRenderer.renderTab
- Defined in widgets/src/tabbar.ts:1697