Class Renderer

The default implementation of an IRenderer.

Hierarchy

Renderer

Implements

Completer.IRenderer

Index

Constructors

Properties

_constructNode _createLabelNode _createWrapperNode sanitizer

Methods

createCompletionItemNode createDocumentationNode createLoadingDocsIndicator itemWidthHeuristic

Constructors

constructor

new Renderer(options?): Completer.Renderer
Parameters
- Optional options: Completer.Renderer.IOptions
Returns Completer.Renderer
- Defined in packages/completer/lib/widget.d.ts:422

Properties

`Private` _constructNode

_constructNode: any

Attaches type and match nodes to base node.

`Private` _createLabelNode

_createLabelNode: any

Create match node to highlight potential prefix match within result.

`Private` _createWrapperNode

_createWrapperNode: any

Create base node with the value to be inserted.

`Readonly` sanitizer

sanitizer: IRenderMime.ISanitizer

The sanitizer used to sanitize untrusted HTML inputs.

Methods

createCompletionItemNode

createCompletionItemNode(item, orderedTypes): HTMLLIElement
Create an item node from an ICompletionItem for a text completer menu.
Parameters
- item: ICompletionItem
- orderedTypes: string[]
Returns HTMLLIElement
Implementation of IRenderer.createCompletionItemNode
- Defined in packages/completer/lib/widget.d.ts:430

createDocumentationNode

createDocumentationNode(activeItem): HTMLElement
Create a documentation node for documentation panel.
Parameters
- activeItem: ICompletionItem
Returns HTMLElement
Implementation of IRenderer.createDocumentationNode
- Defined in packages/completer/lib/widget.d.ts:434

createLoadingDocsIndicator

createLoadingDocsIndicator(): HTMLElement
Create a loading bar for the documentation panel.

Returns HTMLElement
Implementation of IRenderer.createLoadingDocsIndicator
- Defined in packages/completer/lib/widget.d.ts:442

itemWidthHeuristic

itemWidthHeuristic(item): number
Get a heuristic for the width of an item.
Parameters
- item: ICompletionItem
Returns number
Implementation of IRenderer.itemWidthHeuristic
- Defined in packages/completer/lib/widget.d.ts:438

Generated using TypeDoc