Class Renderer

The default implementation of IRenderer.

Notes

Subclasses are free to reimplement rendering methods as needed.

Hierarchy

Renderer

Implements

Menu.IRenderer

Index

Constructors

Methods

createIconClass createItemARIA createItemClass createItemDataset formatLabel formatShortcut renderIcon renderItem renderLabel renderShortcut renderSubmenu

Constructors

constructor

new Renderer(): Menu.Renderer
Returns Menu.Renderer

Methods

createIconClass

createIconClass(data: Menu.IRenderData): string
Create the class name for the menu item icon.

Returns
The full class name for the item icon.
Parameters
- data: Menu.IRenderData
  
  The data to use for the class name.
Returns string
- Defined in packages/widgets/src/menu.ts:1301

createItemARIA

createItemARIA(data: Menu.IRenderData): ElementARIAAttrs
Create the aria attributes for menu item.

Returns
The aria attributes object for the item.
Parameters
- data: Menu.IRenderData
  
  The data to use for the aria attributes.
Returns ElementARIAAttrs
- Defined in packages/widgets/src/menu.ts:1314

createItemClass

createItemClass(data: Menu.IRenderData): string
Create the class name for the menu item.

Returns
The full class name for the menu item.
Parameters
- data: Menu.IRenderData
  
  The data to use for the class name.
Returns string
- Defined in packages/widgets/src/menu.ts:1245

createItemDataset

createItemDataset(data: Menu.IRenderData): ElementDataset
Create the dataset for the menu item.

Returns
The dataset for the menu item.
Parameters
- data: Menu.IRenderData
  
  The data to use for creating the dataset.
Returns ElementDataset
- Defined in packages/widgets/src/menu.ts:1283

formatLabel

formatLabel(data: Menu.IRenderData): Child
Create the render content for the label node.

Returns
The content to add to the label node.
Parameters
- data: Menu.IRenderData
  
  The data to use for the label content.
Returns Child
- Defined in packages/widgets/src/menu.ts:1342

formatShortcut

formatShortcut(data: Menu.IRenderData): Child
Create the render content for the shortcut node.

Returns
The content to add to the shortcut node.
Parameters
- data: Menu.IRenderData
  
  The data to use for the shortcut content.
Returns Child
- Defined in packages/widgets/src/menu.ts:1370

renderIcon

renderIcon(data: Menu.IRenderData): VirtualElement
Render the icon element for a menu item.

Returns
A virtual element representing the item icon.
Parameters
- data: Menu.IRenderData
  
  The data to use for rendering the icon.
Returns VirtualElement
- Defined in packages/widgets/src/menu.ts:1196

renderItem

renderItem(data: Menu.IRenderData): VirtualElement
Render the virtual element for a menu item.

Returns
A virtual element representing the item.
Parameters
- data: Menu.IRenderData
  
  The data to use for rendering the item.
Returns VirtualElement
Implementation of IRenderer.renderItem
- Defined in packages/widgets/src/menu.ts:1170

renderLabel

renderLabel(data: Menu.IRenderData): VirtualElement
Render the label element for a menu item.

Returns
A virtual element representing the item label.
Parameters
- data: Menu.IRenderData
  
  The data to use for rendering the label.
Returns VirtualElement
- Defined in packages/widgets/src/menu.ts:1210

renderShortcut

renderShortcut(data: Menu.IRenderData): VirtualElement
Render the shortcut element for a menu item.

Returns
A virtual element representing the item shortcut.
Parameters
- data: Menu.IRenderData
  
  The data to use for rendering the shortcut.
Returns VirtualElement
- Defined in packages/widgets/src/menu.ts:1222

renderSubmenu

renderSubmenu(data: Menu.IRenderData): VirtualElement
Render the submenu icon element for a menu item.

Returns
A virtual element representing the submenu icon.
Parameters
- data: Menu.IRenderData
  
  The data to use for rendering the submenu icon.
Returns VirtualElement
- Defined in packages/widgets/src/menu.ts:1234

Generated using TypeDoc