Joplin
/
website
mirror of https://github.com/joplin/website.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
website/docs/api/references/plugin_api/interfaces/codemirrorcontrol.html

386 lines
19 KiB
HTML
Raw Blame History

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>CodeMirrorControl | Joplin Plugin API Documentation</title>
<meta name="description" content="Documentation for Joplin Plugin API Documentation">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</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="../classes/joplin.html" class="title">Joplin Plugin API Documentation</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>
</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="../globals.html">Globals</a>
</li>
-->
<li>
<a href="codemirrorcontrol.html">CodeMirrorControl</a>
</li>
</ul>
<h1><!-- Interface -->CodeMirrorControl</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<!--
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">CodeMirrorControl</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="codemirrorcontrol.html#cm6" class="tsd-kind-icon">cm6</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="codemirrorcontrol.html#editor" class="tsd-kind-icon">editor</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="codemirrorcontrol.html#joplinextensions" class="tsd-kind-icon">joplin<wbr>Extensions</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="codemirrorcontrol.html#addextension" class="tsd-kind-icon">add<wbr>Extension</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="codemirrorcontrol.html#execcommand" class="tsd-kind-icon">exec<wbr>Command</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="codemirrorcontrol.html#registercommand" class="tsd-kind-icon">register<wbr>Command</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="codemirrorcontrol.html#supportscommand" class="tsd-kind-icon">supports<wbr>Command</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 name="cm6" class="tsd-anchor"></a>
<h3>cm6</h3>
<div class="tsd-signature tsd-kind-icon">cm6<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="editor" class="tsd-anchor"></a>
<h3>editor</h3>
<div class="tsd-signature tsd-kind-icon">editor<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Points to a CodeMirror 6 EditorView instance.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="joplinextensions" class="tsd-anchor"></a>
<h3>joplin<wbr>Extensions</h3>
<div class="tsd-signature tsd-kind-icon">joplin<wbr>Extensions<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>enableLanguageDataAutocomplete<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>of<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>enabled<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>completionSource<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>enable<wbr>Language<wbr>Data<wbr>Autocomplete<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>of<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>enabled<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Creates an extension that enables or disables <a href="https://codemirror.net/docs/ref/#autocomplete.autocompletion%5Econfig.override"><code>languageData</code>-based autocompletion</a>.</p>
</div>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>of<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>enabled<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-variable">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>enabled<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>enabled: <span class="tsd-signature-type">boolean</span></h5>
</li>
</ul>
<!-- JOPLINCHANGE
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
-->
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="tsd-parameter">
<h5>completion<wbr>Source<span class="tsd-signature-symbol">: </span>function</h5>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal">
<li class="tsd-signature tsd-kind-icon">completion<wbr>Source<span class="tsd-signature-symbol">(</span>completionSource<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns a <a href="https://codemirror.net/docs/ref/#state.Extension">CodeMirror 6 extension</a> that
registers the given <a href="https://codemirror.net/docs/ref/#autocomplete.CompletionSource">CompletionSource</a>.</p>
</div>
<p>Use this extension rather than the built-in CodeMirror <a href="https://codemirror.net/docs/ref/#autocomplete.autocompletion"><code>autocompletion</code></a>
if you don&#39;t want to use <a href="https://codemirror.net/docs/ref/#autocomplete.autocompletion%5Econfig.override">languageData-based autocompletion</a>.</p>
<p>Using <code>autocompletion({ override: [ ... ]})</code> causes errors when done by multiple plugins.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>completionSource: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<!-- JOPLINCHANGE
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
-->
</li>
</ul>
</li>
</ul>
</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 name="addextension" class="tsd-anchor"></a>
<h3>add<wbr>Extension</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">add<wbr>Extension<span class="tsd-signature-symbol">(</span>extension<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">any</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">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p><code>extension</code> should be a <a href="https://codemirror.net/docs/ref/#state.Extension">CodeMirror 6 extension</a>.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>extension: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<!-- JOPLINCHANGE
<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 name="execcommand" class="tsd-anchor"></a>
<h3>exec<wbr>Command</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">exec<wbr>Command<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>name: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<!-- JOPLINCHANGE
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
-->
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="registercommand" class="tsd-anchor"></a>
<h3>register<wbr>Command</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">register<wbr>Command<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, callback<span class="tsd-signature-symbol">: </span><a href="../globals.html#editorcommandcallback" class="tsd-signature-type">EditorCommandCallback</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">
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>name: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>callback: <a href="../globals.html#editorcommandcallback" class="tsd-signature-type">EditorCommandCallback</a></h5>
</li>
</ul>
<!-- JOPLINCHANGE
<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 name="supportscommand" class="tsd-anchor"></a>
<h3>supports<wbr>Command</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">supports<wbr>Command<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>name: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<!-- JOPLINCHANGE
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</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="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
</ul>
</nav>
-->
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="codemirrorcontrol.html" class="tsd-kind-icon">CodeMirrorControl</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="codemirrorcontrol.html#cm6" class="tsd-kind-icon">cm6</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="codemirrorcontrol.html#editor" class="tsd-kind-icon">editor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="codemirrorcontrol.html#joplinextensions" class="tsd-kind-icon">joplin<wbr>Extensions</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="codemirrorcontrol.html#addextension" class="tsd-kind-icon">add<wbr>Extension</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="codemirrorcontrol.html#execcommand" class="tsd-kind-icon">exec<wbr>Command</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="codemirrorcontrol.html#registercommand" class="tsd-kind-icon">register<wbr>Command</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="codemirrorcontrol.html#supportscommand" class="tsd-kind-icon">supports<wbr>Command</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<!-- JOPLINCHANGE
<footer class="with-border-bottom">
<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>
<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-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
-->
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink