SystemSh0cker/monaco-editor
1
0
Fork 0
mirror of https://github.com/microsoft/monaco-editor.git synced 2025-12-22 20:52:56 +01:00
Code Issues Projects Releases Packages Activity
monaco-editor/api/interfaces/monaco.languages.CompletionItem.html
Henning Dieterichs a0eed4888d Publish website
2023-02-10 12:26:04 +00:00

53 lines
No EOL
28 KiB
HTML
Raw Blame History

<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CompletionItem | Monaco Editor API</title><meta name="description" content="Documentation for Monaco Editor API"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">Monaco Editor 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">Monaco Editor API</a></li><li><a href="../modules/monaco.html">monaco</a></li><li><a href="../modules/monaco.languages.html">languages</a></li><li><a href="monaco.languages.CompletionItem.html">CompletionItem</a></li></ul><h1>Interface 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></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>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="monaco.languages.CompletionItem.html#additionalTextEdits" class="tsd-kind-icon">additional<wbr/>Text<wbr/>Edits</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="monaco.languages.CompletionItem.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="monaco.languages.CompletionItem.html#commitCharacters" class="tsd-kind-icon">commit<wbr/>Characters</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="monaco.languages.CompletionItem.html#detail" class="tsd-kind-icon">detail</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="monaco.languages.CompletionItem.html#documentation" class="tsd-kind-icon">documentation</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="monaco.languages.CompletionItem.html#filterText" class="tsd-kind-icon">filter<wbr/>Text</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="monaco.languages.CompletionItem.html#insertText" class="tsd-kind-icon">insert<wbr/>Text</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="monaco.languages.CompletionItem.html#insertTextRules" class="tsd-kind-icon">insert<wbr/>Text<wbr/>Rules</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="monaco.languages.CompletionItem.html#kind" class="tsd-kind-icon">kind</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="monaco.languages.CompletionItem.html#label" class="tsd-kind-icon">label</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="monaco.languages.CompletionItem.html#preselect" class="tsd-kind-icon">preselect</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="monaco.languages.CompletionItem.html#range" class="tsd-kind-icon">range</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="monaco.languages.CompletionItem.html#sortText" class="tsd-kind-icon">sort<wbr/>Text</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="monaco.languages.CompletionItem.html#tags" class="tsd-kind-icon">tags</a></li></ul></section></div></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-interface"><a id="additionalTextEdits" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> additional<wbr/>Text<wbr/>Edits<a href="#additionalTextEdits" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">additional<wbr/>Text<wbr/>Edits<span class="tsd-signature-symbol">?:</span> <a href="monaco.editor.ISingleEditOperation.html" class="tsd-signature-type" data-tsd-kind="Interface">ISingleEditOperation</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/monaco-editor/blob/08439de/website/typedoc/monaco.d.ts#L6595">website/typedoc/monaco.d.ts:6595</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>An optional array of additional text edits that are applied when
selecting this completion. Edits must not overlap with the main edit
nor with themselves.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="command" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> command<a href="#command" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">?:</span> <a href="monaco.languages.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/microsoft/monaco-editor/blob/08439de/website/typedoc/monaco.d.ts#L6599">website/typedoc/monaco.d.ts:6599</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>A command that should be run upon acceptance of this item.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="commitCharacters" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> commit<wbr/>Characters<a href="#commitCharacters" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/microsoft/monaco-editor/blob/08439de/website/typedoc/monaco.d.ts#L6589">website/typedoc/monaco.d.ts:6589</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-interface"><a id="detail" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> detail<a href="#detail" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/microsoft/monaco-editor/blob/08439de/website/typedoc/monaco.d.ts#L6541">website/typedoc/monaco.d.ts:6541</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-interface"><a id="documentation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> documentation<a href="#documentation" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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="monaco.IMarkdownString.html" class="tsd-signature-type" data-tsd-kind="Interface">IMarkdownString</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/monaco-editor/blob/08439de/website/typedoc/monaco.d.ts#L6545">website/typedoc/monaco.d.ts:6545</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-interface"><a id="filterText" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> filter<wbr/>Text<a href="#filterText" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/microsoft/monaco-editor/blob/08439de/website/typedoc/monaco.d.ts#L6557">website/typedoc/monaco.d.ts:6557</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="monaco.languages.CompletionItem.html#label">label</a>
is used.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="insertText" class="tsd-anchor"></a><h3 class="tsd-anchor-link">insert<wbr/>Text<a href="#insertText" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">insert<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/microsoft/monaco-editor/blob/08439de/website/typedoc/monaco.d.ts#L6568">website/typedoc/monaco.d.ts:6568</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.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="insertTextRules" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> insert<wbr/>Text<wbr/>Rules<a href="#insertTextRules" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">insert<wbr/>Text<wbr/>Rules<span class="tsd-signature-symbol">?:</span> <a href="../enums/monaco.languages.CompletionItemInsertTextRule.html" class="tsd-signature-type" data-tsd-kind="Enumeration">CompletionItemInsertTextRule</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/monaco-editor/blob/08439de/website/typedoc/monaco.d.ts#L6573">website/typedoc/monaco.d.ts:6573</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Additional rules (as bitmask) that should be applied when inserting
this completion.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="kind" class="tsd-anchor"></a><h3 class="tsd-anchor-link">kind<a href="#kind" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">kind<span class="tsd-signature-symbol">:</span> <a href="../enums/monaco.languages.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/microsoft/monaco-editor/blob/08439de/website/typedoc/monaco.d.ts#L6531">website/typedoc/monaco.d.ts:6531</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-interface"><a id="label" class="tsd-anchor"></a><h3 class="tsd-anchor-link">label<a href="#label" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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="monaco.languages.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/microsoft/monaco-editor/blob/08439de/website/typedoc/monaco.d.ts#L6526">website/typedoc/monaco.d.ts:6526</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-interface"><a id="preselect" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> preselect<a href="#preselect" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/microsoft/monaco-editor/blob/08439de/website/typedoc/monaco.d.ts#L6563">website/typedoc/monaco.d.ts:6563</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-interface"><a id="range" class="tsd-anchor"></a><h3 class="tsd-anchor-link">range<a href="#range" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">range<span class="tsd-signature-symbol">:</span> <a href="monaco.IRange.html" class="tsd-signature-type" data-tsd-kind="Interface">IRange</a><span class="tsd-signature-symbol"> | </span><a href="monaco.languages.CompletionItemRanges.html" class="tsd-signature-type" data-tsd-kind="Interface">CompletionItemRanges</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/monaco-editor/blob/08439de/website/typedoc/monaco.d.ts#L6583">website/typedoc/monaco.d.ts:6583</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>A range of text that should be replaced by this completion item.</p>
</div><div><p>Defaults to a range from the start of the {@link TextDocument.getWordRangeAtPosition current word} to the
current position.</p>
<p><em>Note:</em> The range must be a {@link Range.isSingleLine single line} and it must
{@link Range.contains contain} the position at which completion has been <a href="monaco.languages.CompletionItemProvider.html#provideCompletionItems">requested</a>.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="sortText" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> sort<wbr/>Text<a href="#sortText" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/microsoft/monaco-editor/blob/08439de/website/typedoc/monaco.d.ts#L6551">website/typedoc/monaco.d.ts:6551</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="monaco.languages.CompletionItem.html#label">label</a>
is used.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="tags" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> tags<a href="#tags" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/monaco.languages.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/microsoft/monaco-editor/blob/08439de/website/typedoc/monaco.d.ts#L6536">website/typedoc/monaco.d.ts:6536</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>A modifier to the <code>kind</code> which affect how the item
is rendered, e.g. Deprecated is rendered with a strikeout</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><li class="current tsd-kind-namespace"><a href="../modules/monaco.html">monaco</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/monaco.editor.html">editor</a></li><li class="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/monaco.languages.html">languages</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/monaco.languages.css.html">css</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/monaco.languages.html.html">html</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/monaco.languages.json.html">json</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/monaco.languages.typescript.html">typescript</a></li></ul></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/monaco.worker.html">worker</a></li></ul></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-namespace"><a href="monaco.languages.CompletionItem.html" class="tsd-kind-icon">Completion<wbr/>Item</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="monaco.languages.CompletionItem.html#additionalTextEdits" class="tsd-kind-icon">additional<wbr/>Text<wbr/>Edits</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="monaco.languages.CompletionItem.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="monaco.languages.CompletionItem.html#commitCharacters" class="tsd-kind-icon">commit<wbr/>Characters</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="monaco.languages.CompletionItem.html#detail" class="tsd-kind-icon">detail</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="monaco.languages.CompletionItem.html#documentation" class="tsd-kind-icon">documentation</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="monaco.languages.CompletionItem.html#filterText" class="tsd-kind-icon">filter<wbr/>Text</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="monaco.languages.CompletionItem.html#insertText" class="tsd-kind-icon">insert<wbr/>Text</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="monaco.languages.CompletionItem.html#insertTextRules" class="tsd-kind-icon">insert<wbr/>Text<wbr/>Rules</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="monaco.languages.CompletionItem.html#kind" class="tsd-kind-icon">kind</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="monaco.languages.CompletionItem.html#label" class="tsd-kind-icon">label</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="monaco.languages.CompletionItem.html#preselect" class="tsd-kind-icon">preselect</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="monaco.languages.CompletionItem.html#range" class="tsd-kind-icon">range</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="monaco.languages.CompletionItem.html#sortText" class="tsd-kind-icon">sort<wbr/>Text</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="monaco.languages.CompletionItem.html#tags" class="tsd-kind-icon">tags</a></li></ul></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
View git blame Copy permalink