Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentationbreadcrumb arrow Grafana documentationbreadcrumb arrow API Referencebreadcrumb arrow @grafana/uibreadcrumb arrow CompletionItem
Enterprise Open source

CompletionItem interface

Signature

typescript 
export interface CompletionItem

Import

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

Properties

PropertyTypeDescription
deleteBackwardsnumberDelete number of characters before the caret position, by default the letters from the beginning of the word.
detailstringA human-readable string with additional information about this item, like type or symbol information.
documentationstringA human-readable string, can be Markdown, that represents a doc-comment.
filterTextstringA string that should be used when filtering a set of completion items. When falsy the label is used.
insertTextstringA string or snippet that should be inserted in a document when selecting this completion. When falsy the label is used.
kindCompletionItemKind | stringThe kind of this completion item. An icon is chosen by the editor based on the kind.
labelstringThe label of this completion item. By default this is also the text that is inserted when selecting this completion.
movenumberNumber of steps to move after the insertion, can be negative.
sortTextstringA string that should be used when comparing this item with other items. When falsy the label is used.

deleteBackwards property

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

Signature

typescript 
deleteBackwards?: number;

detail property

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

Signature

typescript 
detail?: string;

documentation property

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

Signature

typescript 
documentation?: string;

filterText property

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

Signature

typescript 
filterText?: string;

insertText property

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

Signature

typescript 
insertText?: string;

kind property

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

Signature

typescript 
kind?: CompletionItemKind | string;

label property

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

Signature

typescript 
label: string;

move property

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

Signature

typescript 
move?: number;

sortText property

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

Signature

typescript 
sortText?: string;