Class Renderer

a modified implementation of the CommandPalette Renderer

Hierarchy

Renderer
- Renderer

Index

Constructors

constructor

Methods

Constructors

constructor

new Renderer(): Renderer

Returns Renderer

Methods

createIconClass

createIconClass(data: CommandPalette.IItemRenderData): string

- Defined in packages/ui-components/lib/icon/widgets/commandpalettesvg.d.ts:31
Create the class name for the command item icon.

Parameters
- data: CommandPalette.IItemRenderData
  
  The data to use for the class name.
Returns string

The full class name for the item icon.

createItemClass

createItemClass(data: IItemRenderData): string

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

createItemDataset

createItemDataset(data: IItemRenderData): ElementDataset

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

formatEmptyMessage

formatEmptyMessage(data: IEmptyMessageRenderData): h.Child

- Defined in node_modules/@lumino/widgets/types/commandpalette.d.ts:463
Create the render content for the empty message node.

Parameters
- data: IEmptyMessageRenderData
  
  The data to use for the empty message content.
Returns h.Child

The content to add to the empty message node.

formatHeader

formatHeader(data: IHeaderRenderData): h.Child

- Defined in node_modules/@lumino/widgets/types/commandpalette.d.ts:455
Create the render content for the header node.

Parameters
- data: IHeaderRenderData
  
  The data to use for the header content.
Returns h.Child

The content to add to the header node.

formatItemCaption

formatItemCaption(data: IItemRenderData): h.Child

- Defined in node_modules/@lumino/widgets/types/commandpalette.d.ts:487
Create the render content for the item caption node.

Parameters
- data: IItemRenderData
  
  The data to use for the caption content.
Returns h.Child

The content to add to the caption node.

formatItemLabel

formatItemLabel(data: IItemRenderData): h.Child

- Defined in node_modules/@lumino/widgets/types/commandpalette.d.ts:479
Create the render content for the item label node.

Parameters
- data: IItemRenderData
  
  The data to use for the label content.
Returns h.Child

The content to add to the label node.

formatItemShortcut

formatItemShortcut(data: IItemRenderData): h.Child

- Defined in node_modules/@lumino/widgets/types/commandpalette.d.ts:471
Create the render content for the item shortcut node.

Parameters
- data: IItemRenderData
  
  The data to use for the shortcut content.
Returns h.Child

The content to add to the shortcut node.

renderEmptyMessage

renderEmptyMessage(data: IEmptyMessageRenderData): VirtualElement

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

renderHeader

renderHeader(data: CommandPalette.IHeaderRenderData): VirtualElement

- Defined in packages/ui-components/lib/icon/widgets/commandpalettesvg.d.ts:15
Render the virtual element for a command palette header.

Parameters
- data: CommandPalette.IHeaderRenderData
  
  The data to use for rendering the header.
Returns VirtualElement

A virtual element representing the header.

renderItem

renderItem(data: IItemRenderData): VirtualElement

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

renderItemCaption

renderItemCaption(data: IItemRenderData): VirtualElement

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

renderItemContent

renderItemContent(data: IItemRenderData): VirtualElement

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

renderItemIcon

renderItemIcon(data: CommandPalette.IItemRenderData): VirtualElement

- Defined in packages/ui-components/lib/icon/widgets/commandpalettesvg.d.ts:23
Render the icon for a command palette item.

Parameters
- data: CommandPalette.IItemRenderData
  
  The data to use for rendering the icon.
Returns VirtualElement

A virtual element representing the icon.

renderItemLabel

renderItemLabel(data: IItemRenderData): VirtualElement

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

renderItemShortcut

renderItemShortcut(data: IItemRenderData): VirtualElement

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

Generated using TypeDoc