mirror of
https://github.com/microsoft/monaco-editor.git
synced 2025-12-23 00:22:56 +01:00
22 lines
No EOL
18 KiB
HTML
22 lines
No EOL
18 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IContentWidget | 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.editor.html">editor</a></li><li><a href="monaco.editor.IContentWidget.html">IContentWidget</a></li></ul><h1>Interface IContentWidget</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 content widget renders inline with the text and can be easily placed 'near' an editor position.</p>
|
|
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">IContentWidget</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.editor.IContentWidget.html#allowEditorOverflow" class="tsd-kind-icon">allow<wbr/>Editor<wbr/>Overflow</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="monaco.editor.IContentWidget.html#suppressMouseDown" class="tsd-kind-icon">suppress<wbr/>Mouse<wbr/>Down</a></li></ul></section><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.editor.IContentWidget.html#afterRender" class="tsd-kind-icon">after<wbr/>Render</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="monaco.editor.IContentWidget.html#beforeRender" class="tsd-kind-icon">before<wbr/>Render</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="monaco.editor.IContentWidget.html#getDomNode" class="tsd-kind-icon">get<wbr/>Dom<wbr/>Node</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="monaco.editor.IContentWidget.html#getId" class="tsd-kind-icon">get<wbr/>Id</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="monaco.editor.IContentWidget.html#getPosition" class="tsd-kind-icon">get<wbr/>Position</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="allowEditorOverflow" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> allow<wbr/>Editor<wbr/>Overflow<a href="#allowEditorOverflow" 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">allow<wbr/>Editor<wbr/>Overflow<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#L5027">website/typedoc/monaco.d.ts:5027</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Render this content widget in a location where it could overflow the editor's view dom node.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="suppressMouseDown" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> suppress<wbr/>Mouse<wbr/>Down<a href="#suppressMouseDown" 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">suppress<wbr/>Mouse<wbr/>Down<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#L5031">website/typedoc/monaco.d.ts:5031</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Call preventDefault() on mousedown events that target the content widget.</p>
|
|
</div></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="afterRender" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> after<wbr/>Render<a href="#afterRender" 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">after<wbr/>Render<span class="tsd-signature-symbol">(</span>position<span class="tsd-signature-symbol">: </span><a href="../enums/monaco.editor.ContentWidgetPositionPreference.html" class="tsd-signature-type" data-tsd-kind="Enumeration">ContentWidgetPositionPreference</a><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#L5056">website/typedoc/monaco.d.ts:5056</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Optional function that is invoked after rendering the content
|
|
widget. Is being invoked with the selected position preference
|
|
or <code>null</code> if not rendered.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>position: <a href="../enums/monaco.editor.ContentWidgetPositionPreference.html" class="tsd-signature-type" data-tsd-kind="Enumeration">ContentWidgetPositionPreference</a></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="beforeRender" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> before<wbr/>Render<a href="#beforeRender" 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">before<wbr/>Render<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="monaco.editor.IDimension.html" class="tsd-signature-type" data-tsd-kind="Interface">IDimension</a></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#L5050">website/typedoc/monaco.d.ts:5050</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Optional function that is invoked before rendering
|
|
the content widget. If a dimension is returned the editor will
|
|
attempt to use it.</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <a href="monaco.editor.IDimension.html" class="tsd-signature-type" data-tsd-kind="Interface">IDimension</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="getDomNode" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Dom<wbr/>Node<a href="#getDomNode" 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">get<wbr/>Dom<wbr/>Node<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLElement</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#L5039">website/typedoc/monaco.d.ts:5039</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Get the dom node of the content widget.</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">HTMLElement</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="getId" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Id<a href="#getId" 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">get<wbr/>Id<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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#L5035">website/typedoc/monaco.d.ts:5035</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Get a unique identifier of the content widget.</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="getPosition" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Position<a href="#getPosition" 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">get<wbr/>Position<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="monaco.editor.IContentWidgetPosition.html" class="tsd-signature-type" data-tsd-kind="Interface">IContentWidgetPosition</a></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#L5044">website/typedoc/monaco.d.ts:5044</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Get the placement of the content widget.
|
|
If null is returned, the content widget will be placed off screen.</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <a href="monaco.editor.IContentWidgetPosition.html" class="tsd-signature-type" data-tsd-kind="Interface">IContentWidgetPosition</a></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="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/monaco.editor.html">editor</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/monaco.languages.html">languages</a></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.editor.IContentWidget.html" class="tsd-kind-icon">IContent<wbr/>Widget</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="monaco.editor.IContentWidget.html#allowEditorOverflow" class="tsd-kind-icon">allow<wbr/>Editor<wbr/>Overflow</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="monaco.editor.IContentWidget.html#suppressMouseDown" class="tsd-kind-icon">suppress<wbr/>Mouse<wbr/>Down</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="monaco.editor.IContentWidget.html#afterRender" class="tsd-kind-icon">after<wbr/>Render</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="monaco.editor.IContentWidget.html#beforeRender" class="tsd-kind-icon">before<wbr/>Render</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="monaco.editor.IContentWidget.html#getDomNode" class="tsd-kind-icon">get<wbr/>Dom<wbr/>Node</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="monaco.editor.IContentWidget.html#getId" class="tsd-kind-icon">get<wbr/>Id</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="monaco.editor.IContentWidget.html#getPosition" class="tsd-kind-icon">get<wbr/>Position</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><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> |