You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
549 lines
30 KiB
549 lines
30 KiB
<!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="Documentation for VS Code API 中文文档">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
<script async src="../assets/js/search.js" id="search-script"></script>
|
|
</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="../index.html">VS Code API 中文文档</a>
|
|
</li>
|
|
<li>
|
|
<a href="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="CompletionItem.html#label">label</a>. In that
|
|
case the completion item will replace the <a href="../interfaces/TextDocument.html#getWordRangeAtPosition">word</a>
|
|
until the cursor with the given label or <a href="CompletionItem.html#insertText">insertText</a>. Otherwise the
|
|
given <a href="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="CompletionItem.html#additionalTextEdits">additionalTextEdits</a> will be
|
|
applied as provided.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>see</dt>
|
|
<dd><p><a href="../interfaces/CompletionItemProvider.html#provideCompletionItems">CompletionItemProvider.provideCompletionItems</a></p>
|
|
</dd>
|
|
<dt>see</dt>
|
|
<dd><p><a href="../interfaces/CompletionItemProvider.html#resolveCompletionItem">CompletionItemProvider.resolveCompletionItem</a></p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</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</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="CompletionItem.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Properties</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="CompletionItem.html#label" class="tsd-kind-icon">label</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="CompletionItem.html#kind" class="tsd-kind-icon">kind</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="CompletionItem.html#tags" class="tsd-kind-icon">tags</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="CompletionItem.html#detail" class="tsd-kind-icon">detail</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="CompletionItem.html#documentation" class="tsd-kind-icon">documentation</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="CompletionItem.html#sortText" class="tsd-kind-icon">sort<wbr>Text</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="CompletionItem.html#filterText" class="tsd-kind-icon">filter<wbr>Text</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="CompletionItem.html#preselect" class="tsd-kind-icon">preselect</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="CompletionItem.html#insertText" class="tsd-kind-icon">insert<wbr>Text</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="CompletionItem.html#range" class="tsd-kind-icon">range</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="CompletionItem.html#commitCharacters" class="tsd-kind-icon">commit<wbr>Characters</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="CompletionItem.html#keepWhitespace" class="tsd-kind-icon">keep<wbr>Whitespace</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="CompletionItem.html#textEdit" class="tsd-kind-icon">text<wbr>Edit</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="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="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</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/CompletionItemLabel.html" class="tsd-signature-type" data-tsd-kind="Interface">CompletionItemLabel</a>, kind<span class="tsd-signature-symbol">?: </span><a href="../enums/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="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/843dcbe/vscode.d.ts#L4191">vscode.d.ts:4191</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="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/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/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/CompletionItemKind.html">kind</a> of the completion.</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="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</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/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/843dcbe/vscode.d.ts#L4067">vscode.d.ts:4067</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/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/843dcbe/vscode.d.ts#L4073">vscode.d.ts:4073</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/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/843dcbe/vscode.d.ts#L4078">vscode.d.ts:4078</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/843dcbe/vscode.d.ts#L4084">vscode.d.ts:4084</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="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/843dcbe/vscode.d.ts#L4089">vscode.d.ts:4089</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/843dcbe/vscode.d.ts#L4103">vscode.d.ts:4103</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="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="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/843dcbe/vscode.d.ts#L4113">vscode.d.ts:4113</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="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="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/843dcbe/vscode.d.ts#L4120">vscode.d.ts:4120</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="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/843dcbe/vscode.d.ts#L4127">vscode.d.ts:4127</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="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="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="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="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/843dcbe/vscode.d.ts#L4140">vscode.d.ts:4140</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/TextDocument.html#getWordRangeAtPosition">current word</a> is used as replace-range
|
|
and as insert-range the start of the <a href="../interfaces/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="Range.html#isSingleLine">single line</a> and it must
|
|
<a href="Range.html#contains">contain</a> the position at which completion has been <a href="../interfaces/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/843dcbe/vscode.d.ts#L4147">vscode.d.ts:4147</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/843dcbe/vscode.d.ts#L4154">vscode.d.ts:4154</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Keep whitespace of the <a href="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="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/843dcbe/vscode.d.ts#L4166">vscode.d.ts:4166</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="TextEdit.html">edit</a> which is applied to a document when selecting
|
|
this completion. When an edit is provided the value of
|
|
<a href="CompletionItem.html#insertText">insertText</a> is ignored.</p>
|
|
<p>The <a href="Range.html">Range</a> of the edit must be single-line and on the same
|
|
line completions were <a href="../interfaces/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="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/843dcbe/vscode.d.ts#L4173">vscode.d.ts:4173</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>An optional array of additional <a href="TextEdit.html">text edits</a> that are applied when
|
|
selecting this completion. Edits must not overlap with the main <a href="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/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/843dcbe/vscode.d.ts#L4180">vscode.d.ts:4180</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>An optional <a href="../interfaces/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="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="../index.html">Exports</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="current tsd-kind-class">
|
|
<a href="CompletionItem.html" class="tsd-kind-icon">Completion<wbr>Item</a>
|
|
<ul>
|
|
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
|
<a href="CompletionItem.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="CompletionItem.html#label" class="tsd-kind-icon">label</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="CompletionItem.html#kind" class="tsd-kind-icon">kind</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="CompletionItem.html#tags" class="tsd-kind-icon">tags</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="CompletionItem.html#detail" class="tsd-kind-icon">detail</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="CompletionItem.html#documentation" class="tsd-kind-icon">documentation</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="CompletionItem.html#sortText" class="tsd-kind-icon">sort<wbr>Text</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="CompletionItem.html#filterText" class="tsd-kind-icon">filter<wbr>Text</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="CompletionItem.html#preselect" class="tsd-kind-icon">preselect</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="CompletionItem.html#insertText" class="tsd-kind-icon">insert<wbr>Text</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="CompletionItem.html#range" class="tsd-kind-icon">range</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="CompletionItem.html#commitCharacters" class="tsd-kind-icon">commit<wbr>Characters</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="CompletionItem.html#keepWhitespace" class="tsd-kind-icon">keep<wbr>Whitespace</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="CompletionItem.html#textEdit" class="tsd-kind-icon">text<wbr>Edit</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="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="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>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
<div class="container tsd-generator">
|
|
<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>
|
|
</body>
|
|
</html> |