CompletionItem

CompletionItem interface

Signature

export interface CompletionItem

Import

import { CompletionItem } from '@grafana/ui';

Properties

Property	Type	Description
deleteBackwards	`number`	Delete number of characters before the caret position, by default the letters from the beginning of the word.
detail	`string`	A human-readable string with additional information about this item, like type or symbol information.
documentation	`string`	A human-readable string, can be Markdown, that represents a doc-comment.
filterText	`string`	A string that should be used when filtering a set of completion items. When `falsy` the `label` is used.
insertText	`string`	A string or snippet that should be inserted in a document when selecting this completion. When `falsy` the `label` is used.
kind	`CompletionItemKind \| string`	The kind of this completion item. An icon is chosen by the editor based on the kind.
label	`string`	The label of this completion item. By default this is also the text that is inserted when selecting this completion.
move	`number`	Number of steps to move after the insertion, can be negative.
sortText	`string`	A string that should be used when comparing this item with other items. When `falsy` the `label` is used.

Delete number of characters before the caret position, by default the letters from the beginning of the word.

Signature

deleteBackwards?: number;

A human-readable string with additional information about this item, like type or symbol information.

Signature

detail?: string;

A human-readable string, can be Markdown, that represents a doc-comment.

Signature

documentation?: string;

A string that should be used when filtering a set of completion items. When falsy the label is used.

Signature

filterText?: string;

A string or snippet that should be inserted in a document when selecting this completion. When falsy the label is used.

Signature

insertText?: string;

The kind of this completion item. An icon is chosen by the editor based on the kind.

Signature

kind?: CompletionItemKind | string;

The label of this completion item. By default this is also the text that is inserted when selecting this completion.

Signature

label: string;

Number of steps to move after the insertion, can be negative.

Signature

move?: number;

A string that should be used when comparing this item with other items. When falsy the label is used.

Signature

sortText?: string;