6bc369629d
* trying out api-extractor. * works with our setup of build. * wip. * changed the packages so it works better with the api-extractor. * Changes to make the api-extractor to work. * cleaned up the api-extractor config files. * added some more documentation. * added tsdoc-metadata to gitignore. * removed the generated docs (will do that in another PR). * added execute permission to script for generating dosc. * added so we will push generated docs to branch. * will clean packages_api on abort. * Fixed failing tests. * fixed formatting issue with typedoc comment. * temporarily disabled tslint rules about namespace until https://github.com/microsoft/rushstack/issues/1029 is resolved * temporary enabled bable namespaces. * updated build script. * updated script. * updated script with some colors. * changed to camelCase. * removed spacing. * Starting to add documentation guidelines. * added examples headline. * added menu options. * added parameters and return values. * Fixed merge error. * Added first version of auto-generated docs. * changed so we use the eslint ignore syntax. * changed to correct eslint ingnore comment. * fixed some spelling errors reported by codespell. * added script to generate docs in current folder. * updated api docs. * lerna bootstrap. * added eror to the ingore words list. * removed file that should be ignored. * updated locKFILE. * referenced the code comments guidelines. * updated packages. * updated deps. * updated the autogenerated dosc. * adding missing new line.
3.8 KiB
+++
-----------------------------------------------------------------------
Do not edit this file. It is automatically generated by API Documenter.
-----------------------------------------------------------------------
title = "CompletionItem" keywords = ["grafana","documentation","sdk","@grafana/ui"] type = "docs" draft = true +++
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;