mirror of
https://github.com/microsoft/monaco-editor.git
synced 2025-12-22 23:13:02 +01:00
5 lines
No EOL
14 KiB
HTML
5 lines
No EOL
14 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>InlineCompletionsProvider | 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.InlineCompletionsProvider.html">InlineCompletionsProvider</a></li></ul><h1>Interface InlineCompletionsProvider<T></h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-type-parameters"><h3>Type parameters</h3><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="monaco.languages.InlineCompletions.html" class="tsd-signature-type" data-tsd-kind="Interface">InlineCompletions</a> = <a href="monaco.languages.InlineCompletions.html" class="tsd-signature-type" data-tsd-kind="Interface">InlineCompletions</a></h4></li></ul></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">InlineCompletionsProvider</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>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface"><a href="monaco.languages.InlineCompletionsProvider.html#freeInlineCompletions" class="tsd-kind-icon">free<wbr/>Inline<wbr/>Completions</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="monaco.languages.InlineCompletionsProvider.html#handleItemDidShow" class="tsd-kind-icon">handle<wbr/>Item<wbr/>Did<wbr/>Show</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="monaco.languages.InlineCompletionsProvider.html#provideInlineCompletions" class="tsd-kind-icon">provide<wbr/>Inline<wbr/>Completions</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="freeInlineCompletions" class="tsd-anchor"></a><h3 class="tsd-anchor-link">free<wbr/>Inline<wbr/>Completions<a href="#freeInlineCompletions" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">free<wbr/>Inline<wbr/>Completions<span class="tsd-signature-symbol">(</span>completions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/monaco-editor/blob/08439de/website/typedoc/monaco.d.ts#L6744">website/typedoc/monaco.d.ts:6744</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Will be called when a completions list is no longer in use and can be garbage-collected.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>completions: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="handleItemDidShow" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> handle<wbr/>Item<wbr/>Did<wbr/>Show<a href="#handleItemDidShow" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">handle<wbr/>Item<wbr/>Did<wbr/>Show<span class="tsd-signature-symbol">(</span>completions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span>, item<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"items"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/monaco-editor/blob/08439de/website/typedoc/monaco.d.ts#L6740">website/typedoc/monaco.d.ts:6740</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Will be called when an item is shown.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>completions: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5></li><li><h5>item: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"items"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="provideInlineCompletions" class="tsd-anchor"></a><h3 class="tsd-anchor-link">provide<wbr/>Inline<wbr/>Completions<a href="#provideInlineCompletions" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">provide<wbr/>Inline<wbr/>Completions<span class="tsd-signature-symbol">(</span>model<span class="tsd-signature-symbol">: </span><a href="monaco.editor.ITextModel.html" class="tsd-signature-type" data-tsd-kind="Interface">ITextModel</a>, position<span class="tsd-signature-symbol">: </span><a href="../classes/monaco.Position.html" class="tsd-signature-type" data-tsd-kind="Class">Position</a>, context<span class="tsd-signature-symbol">: </span><a href="monaco.languages.InlineCompletionContext.html" class="tsd-signature-type" data-tsd-kind="Interface">InlineCompletionContext</a>, token<span class="tsd-signature-symbol">: </span><a href="monaco.CancellationToken.html" class="tsd-signature-type" data-tsd-kind="Interface">CancellationToken</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/monaco.languages.html#ProviderResult" class="tsd-signature-type" data-tsd-kind="Type alias">ProviderResult</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/monaco-editor/blob/08439de/website/typedoc/monaco.d.ts#L6736">website/typedoc/monaco.d.ts:6736</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>model: <a href="monaco.editor.ITextModel.html" class="tsd-signature-type" data-tsd-kind="Interface">ITextModel</a></h5></li><li><h5>position: <a href="../classes/monaco.Position.html" class="tsd-signature-type" data-tsd-kind="Class">Position</a></h5></li><li><h5>context: <a href="monaco.languages.InlineCompletionContext.html" class="tsd-signature-type" data-tsd-kind="Interface">InlineCompletionContext</a></h5></li><li><h5>token: <a href="monaco.CancellationToken.html" class="tsd-signature-type" data-tsd-kind="Interface">CancellationToken</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules/monaco.languages.html#ProviderResult" class="tsd-signature-type" data-tsd-kind="Type alias">ProviderResult</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4></li></ul></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 tsd-has-type-parameter"><a href="monaco.languages.InlineCompletionsProvider.html" class="tsd-kind-icon">Inline<wbr/>Completions<wbr/>Provider</a><ul><li class="tsd-kind-method tsd-parent-kind-interface"><a href="monaco.languages.InlineCompletionsProvider.html#freeInlineCompletions" class="tsd-kind-icon">free<wbr/>Inline<wbr/>Completions</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="monaco.languages.InlineCompletionsProvider.html#handleItemDidShow" class="tsd-kind-icon">handle<wbr/>Item<wbr/>Did<wbr/>Show</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="monaco.languages.InlineCompletionsProvider.html#provideInlineCompletions" class="tsd-kind-icon">provide<wbr/>Inline<wbr/>Completions</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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</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> |