grafana/docs/sources/packages_api/ui/completionitem.md

+++

-----------------------------------------------------------------------

Do not edit this file. It is automatically generated by API Documenter.

-----------------------------------------------------------------------

title = "CompletionItem" keywords = ["grafana","documentation","sdk","@grafana/ui"] type = "docs" +++

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.

deleteBackwards property

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

Signature

deleteBackwards?: number;

detail property

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

Signature

detail?: string;

documentation property

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

Signature

documentation?: string;

filterText property

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

Signature

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

insertText?: string;

kind property

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

Signature

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

label: string;

move property

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

Signature

move?: number;

sortText property

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

Signature

sortText?: string;