Class Renderer

The default implementation of IRenderer.

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.
Parameters
- data: IItemRenderData
  The data to use for the class name.
Returns string
The full class name for the item icon.
- Defined in node_modules/@lumino/widgets/types/commandpalette.d.ts:455

createItemClass

createItemClass(data: IItemRenderData): string
Create the class name for the command palette item.
Parameters
- data: IItemRenderData
  The data to use for the class name.
Returns string
The full class name for the command palette item.
- Defined in node_modules/@lumino/widgets/types/commandpalette.d.ts:439

createItemDataset

createItemDataset(data: IItemRenderData): ElementDataset
Create the dataset for the command palette item.
Parameters
- data: IItemRenderData
  The data to use for creating the dataset.
Returns ElementDataset
The dataset for the command palette item.
- Defined in node_modules/@lumino/widgets/types/commandpalette.d.ts:447

formatEmptyMessage

formatEmptyMessage(data: IEmptyMessageRenderData): Child
Create the render content for the empty message node.
Parameters
- data: IEmptyMessageRenderData
  The data to use for the empty message content.
Returns Child
The content to add to the empty message node.
- Defined in node_modules/@lumino/widgets/types/commandpalette.d.ts:471

formatHeader

formatHeader(data: IHeaderRenderData): Child
Create the render content for the header node.
Parameters
- data: IHeaderRenderData
  The data to use for the header content.
Returns Child
The content to add to the header node.
- Defined in node_modules/@lumino/widgets/types/commandpalette.d.ts:463

formatItemCaption

formatItemCaption(data: IItemRenderData): Child
Create the render content for the item caption node.
Parameters
- data: IItemRenderData
  The data to use for the caption content.
Returns Child
The content to add to the caption node.
- Defined in node_modules/@lumino/widgets/types/commandpalette.d.ts:495

formatItemLabel

formatItemLabel(data: IItemRenderData): Child
Create the render content for the item label node.
Parameters
- data: IItemRenderData
  The data to use for the label content.
Returns Child
The content to add to the label node.
- Defined in node_modules/@lumino/widgets/types/commandpalette.d.ts:487

formatItemShortcut

formatItemShortcut(data: IItemRenderData): Child
Create the render content for the item shortcut node.
Parameters
- data: IItemRenderData
  The data to use for the shortcut content.
Returns Child
The content to add to the shortcut node.
- Defined in node_modules/@lumino/widgets/types/commandpalette.d.ts:479

renderEmptyMessage

renderEmptyMessage(data: IEmptyMessageRenderData): VirtualElement
Render the empty results message for a command palette.
Parameters
- data: IEmptyMessageRenderData
  The data to use for rendering the message.
Returns VirtualElement
A virtual element representing the message.
Implementation of IRenderer.renderEmptyMessage
- Defined in node_modules/@lumino/widgets/types/commandpalette.d.ts:391

renderHeader

renderHeader(data: IHeaderRenderData): VirtualElement
Render the virtual element for a command palette header.
Parameters
- data: IHeaderRenderData
  The data to use for rendering the header.
Returns VirtualElement
A virtual element representing the header.
Implementation of IRenderer.renderHeader
- Defined in node_modules/@lumino/widgets/types/commandpalette.d.ts:375

renderItem

renderItem(data: IItemRenderData): VirtualElement
Render the virtual element for a command palette item.
Parameters
- data: IItemRenderData
  The data to use for rendering the item.
Returns VirtualElement
A virtual element representing the item.
Implementation of IRenderer.renderItem
- Defined in node_modules/@lumino/widgets/types/commandpalette.d.ts:383

renderItemCaption

renderItemCaption(data: IItemRenderData): VirtualElement
Render the caption for a command palette item.
Parameters
- data: IItemRenderData
  The data to use for rendering the caption.
Returns VirtualElement
A virtual element representing the caption.
- Defined in node_modules/@lumino/widgets/types/commandpalette.d.ts:423

renderItemContent

renderItemContent(data: IItemRenderData): VirtualElement
Render the content for a command palette item.
Parameters
- data: IItemRenderData
  The data to use for rendering the content.
Returns VirtualElement
A virtual element representing the content.
- Defined in node_modules/@lumino/widgets/types/commandpalette.d.ts:407

renderItemIcon

renderItemIcon(data: IItemRenderData): VirtualElement
Render the icon for a command palette item.
Parameters
- data: IItemRenderData
  The data to use for rendering the icon.
Returns VirtualElement
A virtual element representing the icon.
- Defined in node_modules/@lumino/widgets/types/commandpalette.d.ts:399

renderItemLabel

renderItemLabel(data: IItemRenderData): VirtualElement
Render the label for a command palette item.
Parameters
- data: IItemRenderData
  The data to use for rendering the label.
Returns VirtualElement
A virtual element representing the label.
- Defined in node_modules/@lumino/widgets/types/commandpalette.d.ts:415

renderItemShortcut

renderItemShortcut(data: IItemRenderData): VirtualElement
Render the shortcut for a command palette item.
Parameters
- data: IItemRenderData
  The data to use for rendering the shortcut.
Returns VirtualElement
A virtual element representing the shortcut.
- Defined in node_modules/@lumino/widgets/types/commandpalette.d.ts:431