Interface IRenderer

A renderer for use with a command palette.

interface IRenderer {
    renderEmptyMessage(data: IEmptyMessageRenderData): VirtualElement;
    renderHeader(data: IHeaderRenderData): VirtualElement;
    renderItem(data: IItemRenderData): VirtualElement;
}

Implemented by

CommandPalette.Renderer

Index

Methods

renderEmptyMessage renderHeader renderItem

Methods

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.
- Defined in node_modules/@lumino/widgets/types/commandpalette.d.ts:362

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.
- Defined in node_modules/@lumino/widgets/types/commandpalette.d.ts:343

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.

Notes
The command palette will not render invisible items.
- Defined in node_modules/@lumino/widgets/types/commandpalette.d.ts:354