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.

Documentation Grafana documentation API Reference @grafana/ui CompletionItem

CompletionItem interface

Signature

typescript Copy

export interface CompletionItem 

Import

typescript Copy

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

Properties

deleteBackwards property

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

Signature

typescript Copy

deleteBackwards?: number;

detail property

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

Signature

typescript Copy

detail?: string;

documentation property

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

Signature

typescript Copy

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 Copy

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 Copy

insertText?: string;

kind property

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

Signature

typescript Copy

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 Copy

label: string;

move property

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

Signature

typescript Copy

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 Copy

sortText?: string;