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;
Related Grafana resources
Opening keynote: What's new in Grafana 9?
Raj Dutt, Myrle Krantz, and Torkel Ödegaard unveil what's new in Grafana 9. Watch the opening keynote presentation from GrafanaCONline 2022. On-demand.
Unify your data with Grafana plugins: Splunk, MongoDB, Datadog, and more
Show how Grafana can be used to take data from multiple different sources and unify it, without disrupting the investments that are working today.
Getting started with Grafana Enterprise and observability
Join the Grafana Labs team for a 30-minute demo of how to get started with the Grafana Stack, so you can go from zero to observability in just a few minutes.