|
|
<!doctype html>
|
|
|
<html class="default no-js">
|
|
|
<head>
|
|
|
<meta charset="utf-8">
|
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
|
<title>CompletionItem | VS Code API 中文文档</title>
|
|
|
<meta name="description" content="VS Code API 是一系列你可以在 Visual Studio Code 扩展中调用的 JavaScript API。这个站点列出了扩展开发者可以使用的所有 vscode api 中文文档。">
|
|
|
<meta property="og:site_name" content="Vscode Api 中文文档">
|
|
|
<meta property="og:type" content="docs">
|
|
|
<meta property="og:url" content="https://vscode-api-cn.js.org/index.html">
|
|
|
<meta property="article:tag" content="vscode">
|
|
|
<meta property="article:tag" content="vscode api">
|
|
|
<meta property="article:tag" content="vscode api 中文文档">
|
|
|
<meta property="article:tag" content="vscode api 文档">
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
|
<link rel="shortcut icon" href="https://code.visualstudio.com/favicon.ico" sizes="128x128">
|
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
|
<script async src="../assets/js/search.js" id="search-script"></script>
|
|
|
<script async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-7962287588031867" crossorigin="anonymous"></script>
|
|
|
<meta name="monetag" content="eb1e3d5247d1754d0fd449f7b99b110d">
|
|
|
<meta name="a.validate.02" content="FfmmKD6EanKVetA49MTlFFi-untsfhnAgRiw" />
|
|
|
<script type="text/javascript">
|
|
|
(function (c, l, a, r, i, t, y) {
|
|
|
c[a] = c[a] || function () { (c[a].q = c[a].q || []).push(arguments) };
|
|
|
t = l.createElement(r); t.async = 1; t.src = "https://www.clarity.ms/tag/" + i;
|
|
|
y = l.getElementsByTagName(r)[0]; y.parentNode.insertBefore(t, y);
|
|
|
})(window, document, "clarity", "script", "g1cbw4nxoq");
|
|
|
</script>
|
|
|
<!-- Google tag (gtag.js) -->
|
|
|
<script async src="https://www.googletagmanager.com/gtag/js?id=G-T4TRRS1LB1"></script>
|
|
|
<script>
|
|
|
window.dataLayer = window.dataLayer || [];
|
|
|
function gtag(){dataLayer.push(arguments);}
|
|
|
gtag('js', new Date());
|
|
|
|
|
|
gtag('config', 'G-T4TRRS1LB1');
|
|
|
</script>
|
|
|
<style>
|
|
|
.github-corner svg {
|
|
|
z-index: 1;
|
|
|
}
|
|
|
.github-corner:hover .octo-arm {
|
|
|
animation:octocat-wave 560ms ease-in-out
|
|
|
}
|
|
|
@keyframes octocat-wave {
|
|
|
0%,100%{transform:rotate(0)}
|
|
|
20%,60%{transform:rotate(-25deg)}
|
|
|
40%,80%{transform:rotate(10deg)}
|
|
|
}
|
|
|
@media (max-width:500px) {
|
|
|
.github-corner:hover
|
|
|
.octo-arm{animation:none}
|
|
|
.github-corner .octo-arm{
|
|
|
animation:octocat-wave 560ms ease-in-out
|
|
|
}
|
|
|
}
|
|
|
.container-main {
|
|
|
padding-bottom: 50px;
|
|
|
}
|
|
|
</style>
|
|
|
</head>
|
|
|
<body>
|
|
|
<header>
|
|
|
<div class="tsd-page-toolbar">
|
|
|
<div class="container">
|
|
|
<div class="table-wrap">
|
|
|
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
|
|
<div class="field">
|
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
|
<input id="tsd-search-field" type="text" />
|
|
|
</div>
|
|
|
<ul class="results">
|
|
|
<li class="state loading">Preparing search index...</li>
|
|
|
<li class="state failure">The search index is not available</li>
|
|
|
</ul>
|
|
|
<a href="../index.html" class="title">VS Code API 中文文档</a>
|
|
|
</div>
|
|
|
<div class="table-cell" id="tsd-widgets">
|
|
|
<div id="tsd-filter">
|
|
|
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
|
<div class="tsd-filter-group">
|
|
|
<div class="tsd-select" id="tsd-filter-visibility">
|
|
|
<span class="tsd-select-label">All</span>
|
|
|
<ul class="tsd-select-list">
|
|
|
<li data-value="public">Public</li>
|
|
|
<li data-value="protected">Public/Protected</li>
|
|
|
<li data-value="private" class="selected">All</li>
|
|
|
</ul>
|
|
|
</div>
|
|
|
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
|
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
|
<input type="checkbox" id="tsd-filter-externals" checked />
|
|
|
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|
|
</div>
|
|
|
</div>
|
|
|
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
<div class="tsd-page-title">
|
|
|
<div class="container">
|
|
|
<ul class="tsd-breadcrumb">
|
|
|
<li>
|
|
|
<a href="../modules.html">VS Code API 中文文档</a>
|
|
|
</li>
|
|
|
<li>
|
|
|
<a href="../modules/vscode.html">vscode</a>
|
|
|
</li>
|
|
|
<li>
|
|
|
<a href="vscode.CompletionItem.html">CompletionItem</a>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h1>Class CompletionItem</h1>
|
|
|
</div>
|
|
|
</div>
|
|
|
</header>
|
|
|
<div class="container container-main">
|
|
|
<div class="row">
|
|
|
<div class="col-8 col-content">
|
|
|
<section class="tsd-panel tsd-comment">
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>A completion item represents a text snippet that is proposed to complete text that is being typed.</p>
|
|
|
</div>
|
|
|
<p>It is sufficient to create a completion item from just a <a href="vscode.CompletionItem.html#label">label</a>. In that
|
|
|
case the completion item will replace the <a href="../interfaces/vscode.TextDocument.html#getWordRangeAtPosition">word</a>
|
|
|
until the cursor with the given label or <a href="vscode.CompletionItem.html#insertText">insertText</a>. Otherwise the
|
|
|
given <a href="vscode.CompletionItem.html#textEdit">edit</a> is used.</p>
|
|
|
<p>When selecting a completion item in the editor its defined or synthesized text edit will be applied
|
|
|
to <em>all</em> cursors/selections whereas <a href="vscode.CompletionItem.html#additionalTextEdits">additionalTextEdits</a> will be
|
|
|
applied as provided.</p>
|
|
|
<dl class="tsd-comment-tags">
|
|
|
<dt>see</dt>
|
|
|
<dd><p><a href="../interfaces/vscode.CompletionItemProvider.html#provideCompletionItems">CompletionItemProvider.provideCompletionItems</a></p>
|
|
|
</dd>
|
|
|
<dt>see</dt>
|
|
|
<dd><p><a href="../interfaces/vscode.CompletionItemProvider.html#resolveCompletionItem">CompletionItemProvider.resolveCompletionItem</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
|
<h3>层级</h3>
|
|
|
<ul class="tsd-hierarchy">
|
|
|
<li>
|
|
|
<span class="target">CompletionItem</span>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel-group tsd-index-group">
|
|
|
<h2>索引</h2>
|
|
|
<section class="tsd-panel tsd-index-panel">
|
|
|
<div class="tsd-index-content">
|
|
|
<section class="tsd-index-section ">
|
|
|
<h3>Constructors（1）</h3>
|
|
|
<ul class="tsd-index-list">
|
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="vscode.CompletionItem.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-index-section ">
|
|
|
<h3>Properties（15）</h3>
|
|
|
<ul class="tsd-index-list">
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.CompletionItem.html#label" class="tsd-kind-icon">label</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.CompletionItem.html#kind" class="tsd-kind-icon">kind</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.CompletionItem.html#tags" class="tsd-kind-icon">tags</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.CompletionItem.html#detail" class="tsd-kind-icon">detail</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.CompletionItem.html#documentation" class="tsd-kind-icon">documentation</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.CompletionItem.html#sortText" class="tsd-kind-icon">sort<wbr>Text</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.CompletionItem.html#filterText" class="tsd-kind-icon">filter<wbr>Text</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.CompletionItem.html#preselect" class="tsd-kind-icon">preselect</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.CompletionItem.html#insertText" class="tsd-kind-icon">insert<wbr>Text</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.CompletionItem.html#range" class="tsd-kind-icon">range</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.CompletionItem.html#commitCharacters" class="tsd-kind-icon">commit<wbr>Characters</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.CompletionItem.html#keepWhitespace" class="tsd-kind-icon">keep<wbr>Whitespace</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.CompletionItem.html#textEdit" class="tsd-kind-icon">text<wbr>Edit</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.CompletionItem.html#additionalTextEdits" class="tsd-kind-icon">additional<wbr>Text<wbr>Edits</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.CompletionItem.html#command" class="tsd-kind-icon">command</a></li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
</div>
|
|
|
</section>
|
|
|
</section>
|
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
|
<h2>Constructors（1）</h2>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
|
|
<a name="constructor" class="tsd-anchor"></a>
|
|
|
<h3>constructor</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
|
|
<li class="tsd-signature tsd-kind-icon">new <wbr>Completion<wbr>Item<span class="tsd-signature-symbol">(</span>label<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/vscode.CompletionItemLabel.html" class="tsd-signature-type" data-tsd-kind="Interface">CompletionItemLabel</a>, kind<span class="tsd-signature-symbol">?: </span><a href="../enums/vscode.CompletionItemKind.html" class="tsd-signature-type" data-tsd-kind="Enumeration">CompletionItemKind</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="vscode.CompletionItem.html" class="tsd-signature-type" data-tsd-kind="Class">CompletionItem</a></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/5021d30/vscode.d.ts#L4187">vscode.d.ts:4187</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Creates a new completion item.</p>
|
|
|
</div>
|
|
|
<p>Completion items must have at least a <a href="vscode.CompletionItem.html#label">label</a> which then
|
|
|
will be used as insert text as well as for sorting and filtering.</p>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>label: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/vscode.CompletionItemLabel.html" class="tsd-signature-type" data-tsd-kind="Interface">CompletionItemLabel</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>The label of the completion.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> kind: <a href="../enums/vscode.CompletionItemKind.html" class="tsd-signature-type" data-tsd-kind="Enumeration">CompletionItemKind</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>The <a href="../enums/vscode.CompletionItemKind.html">kind</a> of the completion.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="vscode.CompletionItem.html" class="tsd-signature-type" data-tsd-kind="Class">CompletionItem</a></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
</section>
|
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
|
<h2>Properties（15）</h2>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="label" class="tsd-anchor"></a>
|
|
|
<h3>label</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">label<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/vscode.CompletionItemLabel.html" class="tsd-signature-type" data-tsd-kind="Interface">CompletionItemLabel</a></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/5021d30/vscode.d.ts#L4063">vscode.d.ts:4063</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>The label of this completion item. By default
|
|
|
this is also the text that is inserted when selecting
|
|
|
this completion.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="kind" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> kind</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">kind<span class="tsd-signature-symbol">:</span> <a href="../enums/vscode.CompletionItemKind.html" class="tsd-signature-type" data-tsd-kind="Enumeration">CompletionItemKind</a></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/5021d30/vscode.d.ts#L4069">vscode.d.ts:4069</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>The kind of this completion item. Based on the kind
|
|
|
an icon is chosen by the editor.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="tags" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> tags</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">tags<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">readonly </span><a href="../enums/vscode.CompletionItemTag.html#Deprecated" class="tsd-signature-type" data-tsd-kind="Enumeration member">Deprecated</a><span class="tsd-signature-symbol">[]</span></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/5021d30/vscode.d.ts#L4074">vscode.d.ts:4074</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Tags for this completion item.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="detail" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> detail</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">detail<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/5021d30/vscode.d.ts#L4080">vscode.d.ts:4080</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>A human-readable string with additional information
|
|
|
about this item, like type or symbol information.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="documentation" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> documentation</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">documentation<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="vscode.MarkdownString.html" class="tsd-signature-type" data-tsd-kind="Class">MarkdownString</a></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/5021d30/vscode.d.ts#L4085">vscode.d.ts:4085</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>A human-readable string that represents a doc-comment.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="sortText" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> sort<wbr>Text</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">sort<wbr>Text<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/5021d30/vscode.d.ts#L4099">vscode.d.ts:4099</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>A string that should be used when comparing this item
|
|
|
with other items. When <code>falsy</code> the <a href="vscode.CompletionItem.html#label">label</a>
|
|
|
is used.</p>
|
|
|
</div>
|
|
|
<p>Note that <code>sortText</code> is only used for the initial ordering of completion
|
|
|
items. When having a leading word (prefix) ordering is based on how
|
|
|
well completions match that prefix and the initial ordering is only used
|
|
|
when completions match equally well. The prefix is defined by the
|
|
|
<a href="vscode.CompletionItem.html#range"><code>range</code></a>-property and can therefore be different
|
|
|
for each completion.</p>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="filterText" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> filter<wbr>Text</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">filter<wbr>Text<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/5021d30/vscode.d.ts#L4109">vscode.d.ts:4109</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>A string that should be used when filtering a set of
|
|
|
completion items. When <code>falsy</code> the <a href="vscode.CompletionItem.html#label">label</a>
|
|
|
is used.</p>
|
|
|
</div>
|
|
|
<p>Note that the filter text is matched against the leading word (prefix) which is defined
|
|
|
by the <a href="vscode.CompletionItem.html#range"><code>range</code></a>-property.</p>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="preselect" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> preselect</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">preselect<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/5021d30/vscode.d.ts#L4116">vscode.d.ts:4116</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Select this item when showing. <em>Note</em> that only one completion item can be selected and
|
|
|
that the editor decides which item that is. The rule is that the <em>first</em> item of those
|
|
|
that match best is selected.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="insertText" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> insert<wbr>Text</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">insert<wbr>Text<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="vscode.SnippetString.html" class="tsd-signature-type" data-tsd-kind="Class">SnippetString</a></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/5021d30/vscode.d.ts#L4123">vscode.d.ts:4123</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>A string or snippet that should be inserted in a document when selecting
|
|
|
this completion. When <code>falsy</code> the <a href="vscode.CompletionItem.html#label">label</a>
|
|
|
is used.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="range" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> range</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">range<span class="tsd-signature-symbol">:</span> <a href="vscode.Range.html" class="tsd-signature-type" data-tsd-kind="Class">Range</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>inserting<span class="tsd-signature-symbol">: </span><a href="vscode.Range.html" class="tsd-signature-type" data-tsd-kind="Class">Range</a><span class="tsd-signature-symbol">; </span>replacing<span class="tsd-signature-symbol">: </span><a href="vscode.Range.html" class="tsd-signature-type" data-tsd-kind="Class">Range</a><span class="tsd-signature-symbol"> }</span></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/5021d30/vscode.d.ts#L4136">vscode.d.ts:4136</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>A range or a insert and replace range selecting the text that should be replaced by this completion item.</p>
|
|
|
</div>
|
|
|
<p>When omitted, the range of the <a href="../interfaces/vscode.TextDocument.html#getWordRangeAtPosition">current word</a> is used as replace-range
|
|
|
and as insert-range the start of the <a href="../interfaces/vscode.TextDocument.html#getWordRangeAtPosition">current word</a> to the
|
|
|
current position is used.</p>
|
|
|
<p><em>Note 1:</em> A range must be a <a href="vscode.Range.html#isSingleLine">single line</a> and it must
|
|
|
<a href="vscode.Range.html#contains">contain</a> the position at which completion has been <a href="../interfaces/vscode.CompletionItemProvider.html#provideCompletionItems">requested</a>.
|
|
|
<em>Note 2:</em> A insert range must be a prefix of a replace range, that means it must be contained and starting at the same position.</p>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="commitCharacters" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> commit<wbr>Characters</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">commit<wbr>Characters<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/5021d30/vscode.d.ts#L4143">vscode.d.ts:4143</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>An optional set of characters that when pressed while this completion is active will accept it first and
|
|
|
then type that character. <em>Note</em> that all commit characters should have <code>length=1</code> and that superfluous
|
|
|
characters will be ignored.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="keepWhitespace" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> keep<wbr>Whitespace</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">keep<wbr>Whitespace<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/5021d30/vscode.d.ts#L4150">vscode.d.ts:4150</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Keep whitespace of the <a href="vscode.CompletionItem.html#insertText">insertText</a> as is. By default, the editor adjusts leading
|
|
|
whitespace of new lines so that they match the indentation of the line for which the item is accepted - setting
|
|
|
this to <code>true</code> will prevent that.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="textEdit" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> text<wbr>Edit</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">text<wbr>Edit<span class="tsd-signature-symbol">:</span> <a href="vscode.TextEdit.html" class="tsd-signature-type" data-tsd-kind="Class">TextEdit</a></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/5021d30/vscode.d.ts#L4162">vscode.d.ts:4162</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<dl class="tsd-comment-tags">
|
|
|
<dt>deprecated</dt>
|
|
|
<dd><p>Use <code>CompletionItem.insertText</code> and <code>CompletionItem.range</code> instead.</p>
|
|
|
<p>An <a href="vscode.TextEdit.html">edit</a> which is applied to a document when selecting
|
|
|
this completion. When an edit is provided the value of
|
|
|
<a href="vscode.CompletionItem.html#insertText">insertText</a> is ignored.</p>
|
|
|
<p>The <a href="vscode.Range.html">Range</a> of the edit must be single-line and on the same
|
|
|
line completions were <a href="../interfaces/vscode.CompletionItemProvider.html#provideCompletionItems">requested</a> at.</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="additionalTextEdits" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> additional<wbr>Text<wbr>Edits</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">additional<wbr>Text<wbr>Edits<span class="tsd-signature-symbol">:</span> <a href="vscode.TextEdit.html" class="tsd-signature-type" data-tsd-kind="Class">TextEdit</a><span class="tsd-signature-symbol">[]</span></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/5021d30/vscode.d.ts#L4169">vscode.d.ts:4169</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>An optional array of additional <a href="vscode.TextEdit.html">text edits</a> that are applied when
|
|
|
selecting this completion. Edits must not overlap with the main <a href="vscode.CompletionItem.html#textEdit">edit</a>
|
|
|
nor with themselves.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="command" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> command</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <a href="../interfaces/vscode.Command.html" class="tsd-signature-type" data-tsd-kind="Interface">Command</a></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/5021d30/vscode.d.ts#L4176">vscode.d.ts:4176</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>An optional <a href="../interfaces/vscode.Command.html">Command</a> that is executed <em>after</em> inserting this completion. <em>Note</em> that
|
|
|
additional modifications to the current document should be described with the
|
|
|
<a href="vscode.CompletionItem.html#additionalTextEdits">additionalTextEdits</a>-property.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
</section>
|
|
|
</div>
|
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
|
<nav class="tsd-navigation primary">
|
|
|
<ul>
|
|
|
<li class=" ">
|
|
|
<a href="../modules.html">Exports</a>
|
|
|
</li>
|
|
|
<li class="current tsd-kind-namespace">
|
|
|
<a href="../modules/vscode.html">vscode</a>
|
|
|
<ul>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.authentication.html">authentication</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.commands.html">commands</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.comments.html">comments</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.debug.html">debug</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.env.html">env</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.extensions.html">extensions</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.languages.html">languages</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.notebooks.html">notebooks</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.scm.html">scm</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.tasks.html">tasks</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.tests.html">tests</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.window.html">window</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.workspace.html">workspace</a>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</nav>
|
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
|
<div style="width: 200px">
|
|
|
<script type="text/javascript" id="clstr_globe" src="//clustrmaps.com/globe.js?d=cMnk-gSDNcAzNMMm67U8rWRaHnjUc0Xb0giSGndepK4"></script>
|
|
|
</div>
|
|
|
<ul class="before-current">
|
|
|
</ul>
|
|
|
<ul class="current">
|
|
|
<li class="current tsd-kind-class tsd-parent-kind-namespace">
|
|
|
<a href="vscode.CompletionItem.html" class="tsd-kind-icon">Completion<wbr>Item</a>
|
|
|
<ul>
|
|
|
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
|
|
<a href="vscode.CompletionItem.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.CompletionItem.html#label" class="tsd-kind-icon">label</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.CompletionItem.html#kind" class="tsd-kind-icon">kind</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.CompletionItem.html#tags" class="tsd-kind-icon">tags</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.CompletionItem.html#detail" class="tsd-kind-icon">detail</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.CompletionItem.html#documentation" class="tsd-kind-icon">documentation</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.CompletionItem.html#sortText" class="tsd-kind-icon">sort<wbr>Text</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.CompletionItem.html#filterText" class="tsd-kind-icon">filter<wbr>Text</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.CompletionItem.html#preselect" class="tsd-kind-icon">preselect</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.CompletionItem.html#insertText" class="tsd-kind-icon">insert<wbr>Text</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.CompletionItem.html#range" class="tsd-kind-icon">range</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.CompletionItem.html#commitCharacters" class="tsd-kind-icon">commit<wbr>Characters</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.CompletionItem.html#keepWhitespace" class="tsd-kind-icon">keep<wbr>Whitespace</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.CompletionItem.html#textEdit" class="tsd-kind-icon">text<wbr>Edit</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.CompletionItem.html#additionalTextEdits" class="tsd-kind-icon">additional<wbr>Text<wbr>Edits</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.CompletionItem.html#command" class="tsd-kind-icon">command</a>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<ul class="after-current">
|
|
|
</ul>
|
|
|
</nav>
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
<footer class="with-border-bottom">
|
|
|
<div class="container">
|
|
|
<h2>图例</h2>
|
|
|
<div class="tsd-legend-group">
|
|
|
<ul class="tsd-legend">
|
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
|
|
</ul>
|
|
|
</div>
|
|
|
</div>
|
|
|
</footer>
|
|
|
<div class="container tsd-generator">
|
|
|
<p><a href="https://liiked.github.io/VS-Code-Extension-Doc-ZH/" target="_blank">VS Code 插件开发中文文档</a> | <a href="https://jeasonstudio.gitbooks.io/vscode-cn-doc/content/" target="_blank">VS Code 中文文档</a> | <a href="https://code.visualstudio.com/docs" target="_blank">VS Code 官网文档</a> | <a href="https://marketplace.visualstudio.com/" target="_blank">VS Code 扩展市场</a></p>
|
|
|
<p>Generated by <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
|
</div>
|
|
|
<div class="overlay"></div>
|
|
|
<script src="../assets/js/main.js"></script>
|
|
|
<a href="https://github.com/youngjuning/vscode-api-cn" target="_blank" class="github-corner" aria-label="View source on GitHub"><svg width="80" height="80" viewBox="0 0 250 250" style="fill:#151513; color:#fff; position: fixed; top: 0; border: 0; right: 0;" aria-hidden="true"><path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path><path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path><path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path></svg></a>
|
|
|
<script src="https://glimtors.net/pfe/current/tag.min.js?z=5772059" data-cfasync="false" async></script>
|
|
|
<script>(function (d, z, s) { s.src = 'https://' + d + '/400/' + z; try { (document.body || document.documentElement).appendChild(s) } catch (e) { } })('offfurreton.com', 5772070, document.createElement('script'))</script>
|
|
|
<script data-cfasync="false" type="text/javascript" data-adel="atag" src="//acacdn.com/script/atg.js" czid="nfn4dj4pi1"></script>
|
|
|
</body>
|
|
|
</html> |
