Class Renderer

The default implementation of IRenderer.

Hierarchy

Renderer

Implements

CommandPalette.IRenderer

Index

Constructors

Methods

createIconClass createItemClass createItemDataset formatEmptyMessage formatHeader formatItemCaption formatItemLabel formatItemShortcut renderEmptyMessage renderHeader renderItem renderItemCaption renderItemContent renderItemIcon renderItemLabel renderItemShortcut

Constructors

constructor

new Renderer(): CommandPalette.Renderer
Returns CommandPalette.Renderer

Methods

createIconClass

createIconClass(data: IItemRenderData): string
Create the class name for the command item icon.

Returns
The full class name for the item icon.
Parameters
- data: IItemRenderData
  
  The data to use for the class name.
Returns string
- Defined in packages/widgets/src/commandpalette.ts:933

createItemClass

createItemClass(data: IItemRenderData): string
Create the class name for the command palette item.

Returns
The full class name for the command palette item.
Parameters
- data: IItemRenderData
  
  The data to use for the class name.
Returns string
- Defined in packages/widgets/src/commandpalette.ts:890

createItemDataset

createItemDataset(data: IItemRenderData): ElementDataset
Create the dataset for the command palette item.

Returns
The dataset for the command palette item.
Parameters
- data: IItemRenderData
  
  The data to use for creating the dataset.
Returns ElementDataset
- Defined in packages/widgets/src/commandpalette.ts:922

formatEmptyMessage

formatEmptyMessage(data: IEmptyMessageRenderData): Child
Create the render content for the empty message node.

Returns
The content to add to the empty message node.
Parameters
- data: IEmptyMessageRenderData
  
  The data to use for the empty message content.
Returns Child
- Defined in packages/widgets/src/commandpalette.ts:960

formatHeader

formatHeader(data: IHeaderRenderData): Child
Create the render content for the header node.

Returns
The content to add to the header node.
Parameters
- data: IHeaderRenderData
  
  The data to use for the header content.
Returns Child
- Defined in packages/widgets/src/commandpalette.ts:946

formatItemCaption

formatItemCaption(data: IItemRenderData): Child
Create the render content for the item caption node.

Returns
The content to add to the caption node.
Parameters
- data: IItemRenderData
  
  The data to use for the caption content.
Returns Child
- Defined in packages/widgets/src/commandpalette.ts:997

formatItemLabel

formatItemLabel(data: IItemRenderData): Child
Create the render content for the item label node.

Returns
The content to add to the label node.
Parameters
- data: IItemRenderData
  
  The data to use for the label content.
Returns Child
- Defined in packages/widgets/src/commandpalette.ts:983

formatItemShortcut

formatItemShortcut(data: IItemRenderData): Child
Create the render content for the item shortcut node.

Returns
The content to add to the shortcut node.
Parameters
- data: IItemRenderData
  
  The data to use for the shortcut content.
Returns Child
- Defined in packages/widgets/src/commandpalette.ts:971

renderEmptyMessage

renderEmptyMessage(data: IEmptyMessageRenderData): VirtualElement
Render the empty results message for a command palette.

Returns
A virtual element representing the message.
Parameters
- data: IEmptyMessageRenderData
  
  The data to use for rendering the message.
Returns VirtualElement
Implementation of IRenderer.renderEmptyMessage
- Defined in packages/widgets/src/commandpalette.ts:813

renderHeader

renderHeader(data: IHeaderRenderData): VirtualElement
Render the virtual element for a command palette header.

Returns
A virtual element representing the header.
Parameters
- data: IHeaderRenderData
  
  The data to use for rendering the header.
Returns VirtualElement
Implementation of IRenderer.renderHeader
- Defined in packages/widgets/src/commandpalette.ts:766

renderItem

renderItem(data: IItemRenderData): VirtualElement
Render the virtual element for a command palette item.

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

renderItemCaption

renderItemCaption(data: IItemRenderData): VirtualElement
Render the caption for a command palette item.

Returns
A virtual element representing the caption.
Parameters
- data: IItemRenderData
  
  The data to use for rendering the caption.
Returns VirtualElement
- Defined in packages/widgets/src/commandpalette.ts:866

renderItemContent

renderItemContent(data: IItemRenderData): VirtualElement
Render the content for a command palette item.

Returns
A virtual element representing the content.
Parameters
- data: IItemRenderData
  
  The data to use for rendering the content.
Returns VirtualElement
- Defined in packages/widgets/src/commandpalette.ts:839

renderItemIcon

renderItemIcon(data: IItemRenderData): VirtualElement
Render the icon for a command palette item.

Returns
A virtual element representing the icon.
Parameters
- data: IItemRenderData
  
  The data to use for rendering the icon.
Returns VirtualElement
- Defined in packages/widgets/src/commandpalette.ts:825

renderItemLabel

renderItemLabel(data: IItemRenderData): VirtualElement
Render the label for a command palette item.

Returns
A virtual element representing the label.
Parameters
- data: IItemRenderData
  
  The data to use for rendering the label.
Returns VirtualElement
- Defined in packages/widgets/src/commandpalette.ts:854

renderItemShortcut

renderItemShortcut(data: IItemRenderData): VirtualElement
Render the shortcut for a command palette item.

Returns
A virtual element representing the shortcut.
Parameters
- data: IItemRenderData
  
  The data to use for rendering the shortcut.
Returns VirtualElement
- Defined in packages/widgets/src/commandpalette.ts:878

Generated using TypeDoc