mirror of
https://github.com/lensapp/lens.git
synced 2025-05-20 05:10:56 +00:00
Deployed 83d2b12cca to master with MkDocs 1.4.2 and mike 1.1.2
This commit is contained in:
1 parent
217ab84c57
commit
3cd3abd330
30 files changed
+144
-432
No files matched your search
@@ -745,13 +745,6 @@
|
||||
Properties
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#accessors" class="md-nav__link">
|
||||
Accessors
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -794,6 +787,13 @@
|
||||
<nav class="md-nav" aria-label="Properties">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dependencies" class="md-nav__link">
|
||||
dependencies
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#displayname" class="md-nav__link">
|
||||
displayName
|
||||
@@ -813,61 +813,6 @@
|
||||
params
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#storeconfig" class="md-nav__link">
|
||||
storeConfig
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#syncdisposers" class="md-nav__link">
|
||||
syncDisposers
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#accessors_1" class="md-nav__link">
|
||||
Accessors
|
||||
</a>
|
||||
|
||||
<nav class="md-nav" aria-label="Accessors">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#name" class="md-nav__link">
|
||||
name
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#path" class="md-nav__link">
|
||||
path
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#syncmainchannel" class="md-nav__link">
|
||||
syncMainChannel
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#syncrendererchannel" class="md-nav__link">
|
||||
syncRendererChannel
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
@@ -883,32 +828,11 @@
|
||||
<nav class="md-nav" aria-label="Methods">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#applywithoutsync" class="md-nav__link">
|
||||
applyWithoutSync
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#cwd" class="md-nav__link">
|
||||
cwd
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#disablesync" class="md-nav__link">
|
||||
disableSync
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#enablesync" class="md-nav__link">
|
||||
enableSync
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -930,34 +854,6 @@
|
||||
loadExtension
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#onmodelchange" class="md-nav__link">
|
||||
onModelChange
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#onsync" class="md-nav__link">
|
||||
onSync
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#onsyncfrommain" class="md-nav__link">
|
||||
onSyncFromMain
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#savetofile" class="md-nav__link">
|
||||
saveToFile
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -965,13 +861,6 @@
|
||||
toJSON
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#unregisteripclistener" class="md-nav__link">
|
||||
unregisterIpcListener
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -1043,41 +932,25 @@
|
||||
</ul>
|
||||
<h3 id="properties">Properties<a class="headerlink" href="#properties" title="Permanent link">#</a></h3>
|
||||
<ul>
|
||||
<li><a href="./#dependencies">dependencies</a></li>
|
||||
<li><a href="./#displayname">displayName</a></li>
|
||||
<li><a href="./#extension">extension</a></li>
|
||||
<li><a href="./#params">params</a></li>
|
||||
<li><a href="./#storeconfig">storeConfig</a></li>
|
||||
<li><a href="./#syncdisposers">syncDisposers</a></li>
|
||||
</ul>
|
||||
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
||||
<ul>
|
||||
<li><a href="./#name">name</a></li>
|
||||
<li><a href="./#path">path</a></li>
|
||||
<li><a href="./#syncmainchannel">syncMainChannel</a></li>
|
||||
<li><a href="./#syncrendererchannel">syncRendererChannel</a></li>
|
||||
</ul>
|
||||
<h3 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">#</a></h3>
|
||||
<ul>
|
||||
<li><a href="./#applywithoutsync">applyWithoutSync</a></li>
|
||||
<li><a href="./#cwd">cwd</a></li>
|
||||
<li><a href="./#disablesync">disableSync</a></li>
|
||||
<li><a href="./#enablesync">enableSync</a></li>
|
||||
<li><a href="./#fromstore">fromStore</a></li>
|
||||
<li><a href="./#load">load</a></li>
|
||||
<li><a href="./#loadextension">loadExtension</a></li>
|
||||
<li><a href="./#onmodelchange">onModelChange</a></li>
|
||||
<li><a href="./#onsync">onSync</a></li>
|
||||
<li><a href="./#onsyncfrommain">onSyncFromMain</a></li>
|
||||
<li><a href="./#savetofile">saveToFile</a></li>
|
||||
<li><a href="./#tojson">toJSON</a></li>
|
||||
<li><a href="./#unregisteripclistener">unregisterIpcListener</a></li>
|
||||
<li><a href="./#createinstance">createInstance</a></li>
|
||||
<li><a href="./#getinstance">getInstance</a></li>
|
||||
<li><a href="./#resetinstance">resetInstance</a></li>
|
||||
</ul>
|
||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Protected</code> <strong>new ExtensionStore</strong><<code>T</code>>(<code>params</code>)</p>
|
||||
<p>• <strong>new ExtensionStore</strong><<code>T</code>>(<code>__namedParameters</code>)</p>
|
||||
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1103,114 +976,45 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>params</code></td>
|
||||
<td align="left"><code>BaseStoreParams</code><<code>T</code>></td>
|
||||
<td align="left"><code>__namedParameters</code></td>
|
||||
<td align="left"><code>ExtensionStoreParams</code><<code>T</code>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore<T>.constructor</p>
|
||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="displayname">displayName<a class="headerlink" href="#displayname" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Readonly</code> <strong>displayName</strong>: <code>"ExtensionStore<T>"</code></p>
|
||||
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore<T\>.constructor</p>
|
||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="dependencies">dependencies<a class="headerlink" href="#dependencies" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Protected</code> <code>Readonly</code> <strong>dependencies</strong>: <code>BaseStoreDependencies</code></p>
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.dependencies</p>
|
||||
<hr />
|
||||
<h3 id="displayname">displayName<a class="headerlink" href="#displayname" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Readonly</code> <strong>displayName</strong>: <code>string</code></p>
|
||||
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.displayName</p>
|
||||
<hr />
|
||||
<h3 id="extension">extension<a class="headerlink" href="#extension" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Protected</code> <code>Optional</code> <strong>extension</strong>: <code>LensExtension</code><<code>LensExtensionDependencies</code>></p>
|
||||
<hr />
|
||||
<h3 id="params">params<a class="headerlink" href="#params" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Protected</code> <strong>params</strong>: <code>BaseStoreParams</code><<code>T</code>></p>
|
||||
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.params</p>
|
||||
<hr />
|
||||
<h3 id="storeconfig">storeConfig<a class="headerlink" href="#storeconfig" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Protected</code> <code>Optional</code> <strong>storeConfig</strong>: <code>Conf</code><<code>T</code>></p>
|
||||
<p>• <code>Protected</code> <code>Readonly</code> <strong>params</strong>: <code>BaseStoreParams</code><<code>T</code>></p>
|
||||
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.storeConfig</p>
|
||||
<hr />
|
||||
<h3 id="syncdisposers">syncDisposers<a class="headerlink" href="#syncdisposers" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Protected</code> <strong>syncDisposers</strong>: <code>Disposer</code>[] = <code>[]</code></p>
|
||||
<h4 id="inherited-from_3">Inherited from<a class="headerlink" href="#inherited-from_3" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.syncDisposers</p>
|
||||
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="name">name<a class="headerlink" href="#name" title="Permanent link">#</a></h3>
|
||||
<p>• <code>get</code> <strong>name</strong>(): <code>string</code></p>
|
||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.name</p>
|
||||
<hr />
|
||||
<h3 id="path">path<a class="headerlink" href="#path" title="Permanent link">#</a></h3>
|
||||
<p>• <code>get</code> <strong>path</strong>(): <code>string</code></p>
|
||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.path</p>
|
||||
<hr />
|
||||
<h3 id="syncmainchannel">syncMainChannel<a class="headerlink" href="#syncmainchannel" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Protected</code> <code>get</code> <strong>syncMainChannel</strong>(): <code>string</code></p>
|
||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.syncMainChannel</p>
|
||||
<hr />
|
||||
<h3 id="syncrendererchannel">syncRendererChannel<a class="headerlink" href="#syncrendererchannel" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Protected</code> <code>get</code> <strong>syncRendererChannel</strong>(): <code>string</code></p>
|
||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.syncRendererChannel</p>
|
||||
<p>BaseStore.params</p>
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="applywithoutsync">applyWithoutSync<a class="headerlink" href="#applywithoutsync" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>applyWithoutSync</strong>(<code>callback</code>): <code>void</code></p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>callback</code></td>
|
||||
<td align="left">() => <code>void</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.applyWithoutSync</p>
|
||||
<hr />
|
||||
<h3 id="cwd">cwd<a class="headerlink" href="#cwd" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>cwd</strong>(): <code>string</code></p>
|
||||
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.cwd</p>
|
||||
<hr />
|
||||
<h3 id="disablesync">disableSync<a class="headerlink" href="#disablesync" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>disableSync</strong>(): <code>void</code></p>
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.disableSync</p>
|
||||
<hr />
|
||||
<h3 id="enablesync">enableSync<a class="headerlink" href="#enablesync" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>enableSync</strong>(): <code>void</code></p>
|
||||
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.enableSync</p>
|
||||
<hr />
|
||||
<h3 id="fromstore">fromStore<a class="headerlink" href="#fromstore" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <code>Abstract</code> <strong>fromStore</strong>(<code>data</code>): <code>void</code></p>
|
||||
<p>fromStore is called internally when a child class syncs with the file
|
||||
system.</p>
|
||||
<p>Note: This function <strong>must</strong> be synchronous.</p>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1227,21 +1031,21 @@ system.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_3">Inherited from<a class="headerlink" href="#inherited-from_3" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.fromStore</p>
|
||||
<hr />
|
||||
<h3 id="load">load<a class="headerlink" href="#load" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>load</strong>(): <code>void</code></p>
|
||||
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.load</p>
|
||||
<hr />
|
||||
<h3 id="loadextension">loadExtension<a class="headerlink" href="#loadextension" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>loadExtension</strong>(<code>extension</code>): <code>void</code></p>
|
||||
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1256,122 +1060,24 @@ system.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<hr />
|
||||
<h3 id="onmodelchange">onModelChange<a class="headerlink" href="#onmodelchange" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>onModelChange</strong>(<code>model</code>): <code>void</code></p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>model</code></td>
|
||||
<td align="left"><code>T</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.onModelChange</p>
|
||||
<hr />
|
||||
<h3 id="onsync">onSync<a class="headerlink" href="#onsync" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>onSync</strong>(<code>model</code>): <code>void</code></p>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>model</code></td>
|
||||
<td align="left"><code>T</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.onSync</p>
|
||||
<hr />
|
||||
<h3 id="onsyncfrommain">onSyncFromMain<a class="headerlink" href="#onsyncfrommain" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>onSyncFromMain</strong>(<code>model</code>): <code>void</code></p>
|
||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>model</code></td>
|
||||
<td align="left"><code>T</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.onSyncFromMain</p>
|
||||
<hr />
|
||||
<h3 id="savetofile">saveToFile<a class="headerlink" href="#savetofile" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>saveToFile</strong>(<code>model</code>): <code>void</code></p>
|
||||
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>model</code></td>
|
||||
<td align="left"><code>T</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.saveToFile</p>
|
||||
<hr />
|
||||
<h3 id="tojson">toJSON<a class="headerlink" href="#tojson" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Abstract</code> <strong>toJSON</strong>(): <code>T</code></p>
|
||||
<p>toJSON is called when syncing the store to the filesystem. It should
|
||||
produce a JSON serializable object representation of the current state.</p>
|
||||
<p>It is recommended that a round trip is valid. Namely, calling
|
||||
<code>this.fromStore(this.toJSON())</code> shouldn't change the state.</p>
|
||||
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
||||
<p><code>T</code></p>
|
||||
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.toJSON</p>
|
||||
<hr />
|
||||
<h3 id="unregisteripclistener">unregisterIpcListener<a class="headerlink" href="#unregisteripclistener" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>unregisterIpcListener</strong>(): <code>void</code></p>
|
||||
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.unregisterIpcListener</p>
|
||||
<hr />
|
||||
<h3 id="createinstance">createInstance<a class="headerlink" href="#createinstance" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Static</code> <strong>createInstance</strong><<code>T</code>, <code>R</code>>(<code>this</code>, ...<code>args</code>): <code>T</code></p>
|
||||
<p>Creates the single instance of the child class if one was not already created.</p>
|
||||
<p>Multiple calls will return the same instance.
|
||||
Essentially throwing away the arguments to the subsequent calls.</p>
|
||||
<p>Note: this is a racy function, if two (or more) calls are racing to call this function
|
||||
only the first's arguments will be used.</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This is a form of global shared state. Just call <code>new Store(...)</code></p>
|
||||
<h4 id="type-parameters_2">Type parameters<a class="headerlink" href="#type-parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1383,7 +1089,7 @@ only the first's arguments will be used.</p>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>T</code></td>
|
||||
<td align="left">extends <code>Singleton</code><<code>T</code>></td>
|
||||
<td align="left">extends <a href="./"><code>ExtensionStore</code></a><<code>object</code>, <code>T</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>R</code></td>
|
||||
@@ -1391,37 +1097,32 @@ only the first's arguments will be used.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th align="left">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>this</code></td>
|
||||
<td align="left"><code>StaticThis</code><<code>T</code>, <code>R</code>></td>
|
||||
<td align="left">Implicit argument that is the child class type</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>...args</code></td>
|
||||
<td align="left"><code>R</code></td>
|
||||
<td align="left">The constructor arguments for the child class</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
||||
<p><code>T</code></p>
|
||||
<p>An instance of the child class</p>
|
||||
<h4 id="inherited-from_18">Inherited from<a class="headerlink" href="#inherited-from_18" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.createInstance</p>
|
||||
<hr />
|
||||
<h3 id="getinstance">getInstance<a class="headerlink" href="#getinstance" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Static</code> <strong>getInstance</strong><<code>T</code>, <code>R</code>>(<code>this</code>, <code>strict?</code>): <code>T</code></p>
|
||||
<p>Get the instance of the child class that was previously created.</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This is a form of global shared state. Just call <code>new Store(...)</code></p>
|
||||
<h4 id="type-parameters_3">Type parameters<a class="headerlink" href="#type-parameters_3" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1441,33 +1142,27 @@ only the first's arguments will be used.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th align="left">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>this</code></td>
|
||||
<td align="left"><code>StaticThis</code><<code>T</code>, <code>R</code>></td>
|
||||
<td align="left">Implicit argument that is the child class type</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>strict?</code></td>
|
||||
<td align="left"><code>true</code></td>
|
||||
<td align="left">If false will return <code>undefined</code> instead of throwing when an instance doesn't exist. Default: <code>true</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<p><code>T</code></p>
|
||||
<p>An instance of the child class</p>
|
||||
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.getInstance</p>
|
||||
<p>▸ <code>Static</code> <strong>getInstance</strong><<code>T</code>, <code>R</code>>(<code>this</code>, <code>strict</code>): <code>undefined</code> | <code>T</code></p>
|
||||
<h4 id="type-parameters_4">Type parameters<a class="headerlink" href="#type-parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
@@ -1488,7 +1183,7 @@ only the first's arguments will be used.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1507,20 +1202,15 @@ only the first's arguments will be used.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h4>
|
||||
<p><code>undefined</code> | <code>T</code></p>
|
||||
<h4 id="inherited-from_20">Inherited from<a class="headerlink" href="#inherited-from_20" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.getInstance</p>
|
||||
<hr />
|
||||
<h3 id="resetinstance">resetInstance<a class="headerlink" href="#resetinstance" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Static</code> <strong>resetInstance</strong>(): <code>void</code></p>
|
||||
<p>Delete the instance of the child class.</p>
|
||||
<p>Note: this doesn't prevent callers of <code>getInstance</code> from storing the result in a global.</p>
|
||||
<p>There is <em>no</em> way in JS or TS to prevent globals like that.</p>
|
||||
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This is a form of global shared state. Just call <code>new Store(...)</code></p>
|
||||
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_21">Inherited from<a class="headerlink" href="#inherited-from_21" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.resetInstance</p>
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -918,7 +918,7 @@
|
||||
<h3 id="ipcprefix">[IpcPrefix]<a class="headerlink" href="#ipcprefix" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Readonly</code> <strong>[IpcPrefix]</strong>: <code>string</code></p>
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p>IpcRegistrar.__@IpcPrefix@74178</p>
|
||||
<p>IpcRegistrar.__@IpcPrefix@73316</p>
|
||||
<hr />
|
||||
<h3 id="extension">extension<a class="headerlink" href="#extension" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Protected</code> <strong>extension</strong>: <code>LensExtension</code><<code>LensExtensionDependencies</code>></p>
|
||||
|
||||
@@ -1069,12 +1069,12 @@
|
||||
<h3 id="disposers">[Disposers]<a class="headerlink" href="#disposers" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>[Disposers]</strong>: <code>ExtendableDisposer</code></p>
|
||||
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||
<p>LensExtension.__@Disposers@30928</p>
|
||||
<p>LensExtension.__@Disposers@32588</p>
|
||||
<hr />
|
||||
<h3 id="lensextensiondependencies">[lensExtensionDependencies]<a class="headerlink" href="#lensextensiondependencies" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Readonly</code> <strong>[lensExtensionDependencies]</strong>: <code>LensMainExtensionDependencies</code></p>
|
||||
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||
<p>LensExtension.__@lensExtensionDependencies@30931</p>
|
||||
<p>LensExtension.__@lensExtensionDependencies@32591</p>
|
||||
<hr />
|
||||
<h3 id="appmenus">appMenus<a class="headerlink" href="#appmenus" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>appMenus</strong>: <code>MenuRegistration</code>[] = <code>[]</code></p>
|
||||
|
||||
@@ -918,7 +918,7 @@
|
||||
<h3 id="ipcprefix">[IpcPrefix]<a class="headerlink" href="#ipcprefix" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Readonly</code> <strong>[IpcPrefix]</strong>: <code>string</code></p>
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p>IpcRegistrar.__@IpcPrefix@74178</p>
|
||||
<p>IpcRegistrar.__@IpcPrefix@73316</p>
|
||||
<hr />
|
||||
<h3 id="extension">extension<a class="headerlink" href="#extension" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Protected</code> <strong>extension</strong>: <code>LensExtension</code><<code>LensExtensionDependencies</code>></p>
|
||||
|
||||
@@ -1737,7 +1737,7 @@
|
||||
<p><a href="../Renderer.K8sApi.KubeObjectStore/">KubeObjectStore</a>.<a href="../Renderer.K8sApi.KubeObjectStore/#getbyname">getByName</a></p>
|
||||
<hr />
|
||||
<h3 id="getbyobject">getByObject<a class="headerlink" href="#getbyobject" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getByObject</strong>(<code>obj</code>): <code>undefined</code> | <code>null</code> | <a href="../Renderer.K8sApi.CustomResourceDefinition/"><code>CustomResourceDefinition</code></a></p>
|
||||
<p>▸ <strong>getByObject</strong>(<code>obj</code>): <code>undefined</code> | <a href="../Renderer.K8sApi.CustomResourceDefinition/"><code>CustomResourceDefinition</code></a></p>
|
||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1754,7 +1754,7 @@
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
||||
<p><code>undefined</code> | <code>null</code> | <a href="../Renderer.K8sApi.CustomResourceDefinition/"><code>CustomResourceDefinition</code></a></p>
|
||||
<p><code>undefined</code> | <a href="../Renderer.K8sApi.CustomResourceDefinition/"><code>CustomResourceDefinition</code></a></p>
|
||||
<hr />
|
||||
<h3 id="getbypath">getByPath<a class="headerlink" href="#getbypath" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getByPath</strong>(<code>path</code>): <code>undefined</code> | <a href="../Renderer.K8sApi.CustomResourceDefinition/"><code>CustomResourceDefinition</code></a></p>
|
||||
|
||||
@@ -1355,7 +1355,7 @@
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>dependencies</code></td>
|
||||
<td align="left"><code>EventStoreDependencies</code></td>
|
||||
<td align="left"><code>Dependencies</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>api</code></td>
|
||||
@@ -1381,7 +1381,7 @@
|
||||
<p><a href="../Renderer.K8sApi.KubeObjectStore/">KubeObjectStore</a>.<a href="../Renderer.K8sApi.KubeObjectStore/#buffersize">bufferSize</a></p>
|
||||
<hr />
|
||||
<h3 id="dependencies">dependencies<a class="headerlink" href="#dependencies" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Protected</code> <code>Readonly</code> <strong>dependencies</strong>: <code>EventStoreDependencies</code></p>
|
||||
<p>• <code>Protected</code> <code>Readonly</code> <strong>dependencies</strong>: <code>Dependencies</code></p>
|
||||
<hr />
|
||||
<h3 id="eventsbuffer">eventsBuffer<a class="headerlink" href="#eventsbuffer" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Protected</code> <strong>eventsBuffer</strong>: <code>IObservableArray</code><<code>IKubeWatchEvent</code><<code>KubeEventData</code>>></p>
|
||||
|
||||
@@ -1521,7 +1521,7 @@
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<p><code>Generator</code><<code>K</code>, <code>void</code>, <code>undefined</code>></p>
|
||||
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||
<p>ItemStore.__@iterator@476</p>
|
||||
<p>ItemStore.__@iterator@475</p>
|
||||
<hr />
|
||||
<h3 id="bindwatcheventsupdater">bindWatchEventsUpdater<a class="headerlink" href="#bindwatcheventsupdater" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>bindWatchEventsUpdater</strong>(<code>delay?</code>): <code>void</code></p>
|
||||
|
||||
@@ -1355,7 +1355,7 @@
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>dependencies</code></td>
|
||||
<td align="left"><code>ReplicaSetStoreDependencies</code></td>
|
||||
<td align="left"><code>Dependencies</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>api</code></td>
|
||||
@@ -1381,7 +1381,7 @@
|
||||
<p><a href="../Renderer.K8sApi.KubeObjectStore/">KubeObjectStore</a>.<a href="../Renderer.K8sApi.KubeObjectStore/#buffersize">bufferSize</a></p>
|
||||
<hr />
|
||||
<h3 id="dependencies">dependencies<a class="headerlink" href="#dependencies" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Protected</code> <code>Readonly</code> <strong>dependencies</strong>: <code>ReplicaSetStoreDependencies</code></p>
|
||||
<p>• <code>Protected</code> <code>Readonly</code> <strong>dependencies</strong>: <code>Dependencies</code></p>
|
||||
<hr />
|
||||
<h3 id="eventsbuffer">eventsBuffer<a class="headerlink" href="#eventsbuffer" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Protected</code> <strong>eventsBuffer</strong>: <code>IObservableArray</code><<code>IKubeWatchEvent</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#namespacescopedmetadata"><code>NamespaceScopedMetadata</code></a>, <code>ReplicaSetStatus</code>, <code>ReplicaSetSpec</code>>>></p>
|
||||
|
||||
@@ -1213,12 +1213,12 @@
|
||||
<h3 id="disposers">[Disposers]<a class="headerlink" href="#disposers" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>[Disposers]</strong>: <code>ExtendableDisposer</code></p>
|
||||
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||
<p>LensExtension.__@Disposers@30928</p>
|
||||
<p>LensExtension.__@Disposers@32588</p>
|
||||
<hr />
|
||||
<h3 id="lensextensiondependencies">[lensExtensionDependencies]<a class="headerlink" href="#lensextensiondependencies" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Readonly</code> <strong>[lensExtensionDependencies]</strong>: <code>LensRendererExtensionDependencies</code></p>
|
||||
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||
<p>LensExtension.__@lensExtensionDependencies@30931</p>
|
||||
<p>LensExtension.__@lensExtensionDependencies@32591</p>
|
||||
<hr />
|
||||
<h3 id="additionalcategorycolumns">additionalCategoryColumns<a class="headerlink" href="#additionalcategorycolumns" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>additionalCategoryColumns</strong>: <a href="../../interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/"><code>AdditionalCategoryColumnRegistration</code></a>[] = <code>[]</code></p>
|
||||
|
||||
@@ -2880,7 +2880,7 @@
|
||||
<p>React.HTMLAttributes.aria-atomic</p>
|
||||
<hr />
|
||||
<h3 id="aria-autocomplete">aria-autocomplete<a class="headerlink" href="#aria-autocomplete" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-autocomplete</strong>: <code>"none"</code> | <code>"list"</code> | <code>"inline"</code> | <code>"both"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-autocomplete</strong>: <code>"none"</code> | <code>"inline"</code> | <code>"list"</code> | <code>"both"</code></p>
|
||||
<p>Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
|
||||
presented if they are made.</p>
|
||||
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||
@@ -2942,7 +2942,7 @@ presented if they are made.</p>
|
||||
<p>React.HTMLAttributes.aria-controls</p>
|
||||
<hr />
|
||||
<h3 id="aria-current">aria-current<a class="headerlink" href="#aria-current" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-current</strong>: <code>boolean</code> | <code>"date"</code> | <code>"time"</code> | <code>"true"</code> | <code>"false"</code> | <code>"page"</code> | <code>"step"</code> | <code>"location"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-current</strong>: <code>boolean</code> | <code>"date"</code> | <code>"time"</code> | <code>"location"</code> | <code>"true"</code> | <code>"false"</code> | <code>"page"</code> | <code>"step"</code></p>
|
||||
<p>Indicates the element that represents the current item within a container or set of related elements.</p>
|
||||
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||
<p>React.HTMLAttributes.aria-current</p>
|
||||
@@ -3015,7 +3015,7 @@ allows assistive technology to override the general default of reading in docume
|
||||
<p>React.HTMLAttributes.aria-grabbed</p>
|
||||
<hr />
|
||||
<h3 id="aria-haspopup">aria-haspopup<a class="headerlink" href="#aria-haspopup" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-haspopup</strong>: <code>boolean</code> | <code>"dialog"</code> | <code>"menu"</code> | <code>"grid"</code> | <code>"listbox"</code> | <code>"tree"</code> | <code>"true"</code> | <code>"false"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-haspopup</strong>: <code>boolean</code> | <code>"dialog"</code> | <code>"menu"</code> | <code>"tree"</code> | <code>"true"</code> | <code>"grid"</code> | <code>"listbox"</code> | <code>"false"</code></p>
|
||||
<p>Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.</p>
|
||||
<h4 id="inherited-from_20">Inherited from<a class="headerlink" href="#inherited-from_20" title="Permanent link">#</a></h4>
|
||||
<p>React.HTMLAttributes.aria-haspopup</p>
|
||||
@@ -3348,7 +3348,7 @@ A hint could be a sample value or a brief description of the expected format.</p
|
||||
<p>React.HTMLAttributes.inlist</p>
|
||||
<hr />
|
||||
<h3 id="inputmode">inputMode<a class="headerlink" href="#inputmode" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>inputMode</strong>: <code>"search"</code> | <code>"none"</code> | <code>"url"</code> | <code>"text"</code> | <code>"tel"</code> | <code>"email"</code> | <code>"numeric"</code> | <code>"decimal"</code></p>
|
||||
<p>• <code>Optional</code> <strong>inputMode</strong>: <code>"search"</code> | <code>"none"</code> | <code>"text"</code> | <code>"tel"</code> | <code>"url"</code> | <code>"email"</code> | <code>"numeric"</code> | <code>"decimal"</code></p>
|
||||
<p>Hints at the type of data that might be entered by the user while editing the element or its contents</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute</p>
|
||||
|
||||
@@ -3022,7 +3022,7 @@
|
||||
<p>ButtonHTMLAttributes.aria-atomic</p>
|
||||
<hr />
|
||||
<h3 id="aria-autocomplete">aria-autocomplete<a class="headerlink" href="#aria-autocomplete" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-autocomplete</strong>: <code>"none"</code> | <code>"list"</code> | <code>"inline"</code> | <code>"both"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-autocomplete</strong>: <code>"none"</code> | <code>"inline"</code> | <code>"list"</code> | <code>"both"</code></p>
|
||||
<p>Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
|
||||
presented if they are made.</p>
|
||||
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||
@@ -3084,7 +3084,7 @@ presented if they are made.</p>
|
||||
<p>ButtonHTMLAttributes.aria-controls</p>
|
||||
<hr />
|
||||
<h3 id="aria-current">aria-current<a class="headerlink" href="#aria-current" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-current</strong>: <code>boolean</code> | <code>"date"</code> | <code>"time"</code> | <code>"true"</code> | <code>"false"</code> | <code>"page"</code> | <code>"step"</code> | <code>"location"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-current</strong>: <code>boolean</code> | <code>"date"</code> | <code>"time"</code> | <code>"location"</code> | <code>"true"</code> | <code>"false"</code> | <code>"page"</code> | <code>"step"</code></p>
|
||||
<p>Indicates the element that represents the current item within a container or set of related elements.</p>
|
||||
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||
<p>ButtonHTMLAttributes.aria-current</p>
|
||||
@@ -3157,7 +3157,7 @@ allows assistive technology to override the general default of reading in docume
|
||||
<p>ButtonHTMLAttributes.aria-grabbed</p>
|
||||
<hr />
|
||||
<h3 id="aria-haspopup">aria-haspopup<a class="headerlink" href="#aria-haspopup" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-haspopup</strong>: <code>boolean</code> | <code>"dialog"</code> | <code>"menu"</code> | <code>"grid"</code> | <code>"listbox"</code> | <code>"tree"</code> | <code>"true"</code> | <code>"false"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-haspopup</strong>: <code>boolean</code> | <code>"dialog"</code> | <code>"menu"</code> | <code>"tree"</code> | <code>"true"</code> | <code>"grid"</code> | <code>"listbox"</code> | <code>"false"</code></p>
|
||||
<p>Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.</p>
|
||||
<h4 id="inherited-from_20">Inherited from<a class="headerlink" href="#inherited-from_20" title="Permanent link">#</a></h4>
|
||||
<p>ButtonHTMLAttributes.aria-haspopup</p>
|
||||
@@ -3527,7 +3527,7 @@ A hint could be a sample value or a brief description of the expected format.</p
|
||||
<p>ButtonHTMLAttributes.inlist</p>
|
||||
<hr />
|
||||
<h3 id="inputmode">inputMode<a class="headerlink" href="#inputmode" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>inputMode</strong>: <code>"search"</code> | <code>"none"</code> | <code>"url"</code> | <code>"text"</code> | <code>"tel"</code> | <code>"email"</code> | <code>"numeric"</code> | <code>"decimal"</code></p>
|
||||
<p>• <code>Optional</code> <strong>inputMode</strong>: <code>"search"</code> | <code>"none"</code> | <code>"text"</code> | <code>"tel"</code> | <code>"url"</code> | <code>"email"</code> | <code>"numeric"</code> | <code>"decimal"</code></p>
|
||||
<p>Hints at the type of data that might be entered by the user while editing the element or its contents</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute</p>
|
||||
@@ -4481,7 +4481,7 @@ A hint could be a sample value or a brief description of the expected format.</p
|
||||
<p>ButtonHTMLAttributes.translate</p>
|
||||
<hr />
|
||||
<h3 id="type">type<a class="headerlink" href="#type" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>type</strong>: <code>"button"</code> | <code>"reset"</code> | <code>"submit"</code></p>
|
||||
<p>• <code>Optional</code> <strong>type</strong>: <code>"reset"</code> | <code>"button"</code> | <code>"submit"</code></p>
|
||||
<h4 id="inherited-from_259">Inherited from<a class="headerlink" href="#inherited-from_259" title="Permanent link">#</a></h4>
|
||||
<p>ButtonHTMLAttributes.type</p>
|
||||
<hr />
|
||||
|
||||
+4
-4
@@ -2864,7 +2864,7 @@
|
||||
<p><a href="../Renderer.Component.DrawerItemProps/">DrawerItemProps</a>.<a href="../Renderer.Component.DrawerItemProps/#aria-atomic">aria-atomic</a></p>
|
||||
<hr />
|
||||
<h3 id="aria-autocomplete">aria-autocomplete<a class="headerlink" href="#aria-autocomplete" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-autocomplete</strong>: <code>"none"</code> | <code>"list"</code> | <code>"inline"</code> | <code>"both"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-autocomplete</strong>: <code>"none"</code> | <code>"inline"</code> | <code>"list"</code> | <code>"both"</code></p>
|
||||
<p>Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
|
||||
presented if they are made.</p>
|
||||
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||
@@ -2926,7 +2926,7 @@ presented if they are made.</p>
|
||||
<p><a href="../Renderer.Component.DrawerItemProps/">DrawerItemProps</a>.<a href="../Renderer.Component.DrawerItemProps/#aria-controls">aria-controls</a></p>
|
||||
<hr />
|
||||
<h3 id="aria-current">aria-current<a class="headerlink" href="#aria-current" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-current</strong>: <code>boolean</code> | <code>"date"</code> | <code>"time"</code> | <code>"true"</code> | <code>"false"</code> | <code>"page"</code> | <code>"step"</code> | <code>"location"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-current</strong>: <code>boolean</code> | <code>"date"</code> | <code>"time"</code> | <code>"location"</code> | <code>"true"</code> | <code>"false"</code> | <code>"page"</code> | <code>"step"</code></p>
|
||||
<p>Indicates the element that represents the current item within a container or set of related elements.</p>
|
||||
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.Component.DrawerItemProps/">DrawerItemProps</a>.<a href="../Renderer.Component.DrawerItemProps/#aria-current">aria-current</a></p>
|
||||
@@ -2999,7 +2999,7 @@ allows assistive technology to override the general default of reading in docume
|
||||
<p><a href="../Renderer.Component.DrawerItemProps/">DrawerItemProps</a>.<a href="../Renderer.Component.DrawerItemProps/#aria-grabbed">aria-grabbed</a></p>
|
||||
<hr />
|
||||
<h3 id="aria-haspopup">aria-haspopup<a class="headerlink" href="#aria-haspopup" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-haspopup</strong>: <code>boolean</code> | <code>"dialog"</code> | <code>"menu"</code> | <code>"grid"</code> | <code>"listbox"</code> | <code>"tree"</code> | <code>"true"</code> | <code>"false"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-haspopup</strong>: <code>boolean</code> | <code>"dialog"</code> | <code>"menu"</code> | <code>"tree"</code> | <code>"true"</code> | <code>"grid"</code> | <code>"listbox"</code> | <code>"false"</code></p>
|
||||
<p>Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.</p>
|
||||
<h4 id="inherited-from_20">Inherited from<a class="headerlink" href="#inherited-from_20" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.Component.DrawerItemProps/">DrawerItemProps</a>.<a href="../Renderer.Component.DrawerItemProps/#aria-haspopup">aria-haspopup</a></p>
|
||||
@@ -3323,7 +3323,7 @@ A hint could be a sample value or a brief description of the expected format.</p
|
||||
<p><a href="../Renderer.Component.DrawerItemProps/">DrawerItemProps</a>.<a href="../Renderer.Component.DrawerItemProps/#inlist">inlist</a></p>
|
||||
<hr />
|
||||
<h3 id="inputmode">inputMode<a class="headerlink" href="#inputmode" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>inputMode</strong>: <code>"search"</code> | <code>"none"</code> | <code>"url"</code> | <code>"text"</code> | <code>"tel"</code> | <code>"email"</code> | <code>"numeric"</code> | <code>"decimal"</code></p>
|
||||
<p>• <code>Optional</code> <strong>inputMode</strong>: <code>"search"</code> | <code>"none"</code> | <code>"text"</code> | <code>"tel"</code> | <code>"url"</code> | <code>"email"</code> | <code>"numeric"</code> | <code>"decimal"</code></p>
|
||||
<p>Hints at the type of data that might be entered by the user while editing the element or its contents</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute</p>
|
||||
|
||||
@@ -2857,7 +2857,7 @@
|
||||
<p>React.HTMLAttributes.aria-atomic</p>
|
||||
<hr />
|
||||
<h3 id="aria-autocomplete">aria-autocomplete<a class="headerlink" href="#aria-autocomplete" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-autocomplete</strong>: <code>"none"</code> | <code>"list"</code> | <code>"inline"</code> | <code>"both"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-autocomplete</strong>: <code>"none"</code> | <code>"inline"</code> | <code>"list"</code> | <code>"both"</code></p>
|
||||
<p>Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
|
||||
presented if they are made.</p>
|
||||
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||
@@ -2919,7 +2919,7 @@ presented if they are made.</p>
|
||||
<p>React.HTMLAttributes.aria-controls</p>
|
||||
<hr />
|
||||
<h3 id="aria-current">aria-current<a class="headerlink" href="#aria-current" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-current</strong>: <code>boolean</code> | <code>"date"</code> | <code>"time"</code> | <code>"true"</code> | <code>"false"</code> | <code>"page"</code> | <code>"step"</code> | <code>"location"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-current</strong>: <code>boolean</code> | <code>"date"</code> | <code>"time"</code> | <code>"location"</code> | <code>"true"</code> | <code>"false"</code> | <code>"page"</code> | <code>"step"</code></p>
|
||||
<p>Indicates the element that represents the current item within a container or set of related elements.</p>
|
||||
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||
<p>React.HTMLAttributes.aria-current</p>
|
||||
@@ -2992,7 +2992,7 @@ allows assistive technology to override the general default of reading in docume
|
||||
<p>React.HTMLAttributes.aria-grabbed</p>
|
||||
<hr />
|
||||
<h3 id="aria-haspopup">aria-haspopup<a class="headerlink" href="#aria-haspopup" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-haspopup</strong>: <code>boolean</code> | <code>"dialog"</code> | <code>"menu"</code> | <code>"grid"</code> | <code>"listbox"</code> | <code>"tree"</code> | <code>"true"</code> | <code>"false"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-haspopup</strong>: <code>boolean</code> | <code>"dialog"</code> | <code>"menu"</code> | <code>"tree"</code> | <code>"true"</code> | <code>"grid"</code> | <code>"listbox"</code> | <code>"false"</code></p>
|
||||
<p>Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.</p>
|
||||
<h4 id="inherited-from_20">Inherited from<a class="headerlink" href="#inherited-from_20" title="Permanent link">#</a></h4>
|
||||
<p>React.HTMLAttributes.aria-haspopup</p>
|
||||
@@ -3316,7 +3316,7 @@ A hint could be a sample value or a brief description of the expected format.</p
|
||||
<p>React.HTMLAttributes.inlist</p>
|
||||
<hr />
|
||||
<h3 id="inputmode">inputMode<a class="headerlink" href="#inputmode" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>inputMode</strong>: <code>"search"</code> | <code>"none"</code> | <code>"url"</code> | <code>"text"</code> | <code>"tel"</code> | <code>"email"</code> | <code>"numeric"</code> | <code>"decimal"</code></p>
|
||||
<p>• <code>Optional</code> <strong>inputMode</strong>: <code>"search"</code> | <code>"none"</code> | <code>"text"</code> | <code>"tel"</code> | <code>"url"</code> | <code>"email"</code> | <code>"numeric"</code> | <code>"decimal"</code></p>
|
||||
<p>Hints at the type of data that might be entered by the user while editing the element or its contents</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute</p>
|
||||
|
||||
@@ -2955,7 +2955,7 @@
|
||||
<p>React.HTMLAttributes.aria-atomic</p>
|
||||
<hr />
|
||||
<h3 id="aria-autocomplete">aria-autocomplete<a class="headerlink" href="#aria-autocomplete" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-autocomplete</strong>: <code>"none"</code> | <code>"list"</code> | <code>"inline"</code> | <code>"both"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-autocomplete</strong>: <code>"none"</code> | <code>"inline"</code> | <code>"list"</code> | <code>"both"</code></p>
|
||||
<p>Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
|
||||
presented if they are made.</p>
|
||||
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
||||
@@ -3017,7 +3017,7 @@ presented if they are made.</p>
|
||||
<p>React.HTMLAttributes.aria-controls</p>
|
||||
<hr />
|
||||
<h3 id="aria-current">aria-current<a class="headerlink" href="#aria-current" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-current</strong>: <code>boolean</code> | <code>"date"</code> | <code>"time"</code> | <code>"true"</code> | <code>"false"</code> | <code>"page"</code> | <code>"step"</code> | <code>"location"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-current</strong>: <code>boolean</code> | <code>"date"</code> | <code>"time"</code> | <code>"location"</code> | <code>"true"</code> | <code>"false"</code> | <code>"page"</code> | <code>"step"</code></p>
|
||||
<p>Indicates the element that represents the current item within a container or set of related elements.</p>
|
||||
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||
<p>React.HTMLAttributes.aria-current</p>
|
||||
@@ -3090,7 +3090,7 @@ allows assistive technology to override the general default of reading in docume
|
||||
<p>React.HTMLAttributes.aria-grabbed</p>
|
||||
<hr />
|
||||
<h3 id="aria-haspopup">aria-haspopup<a class="headerlink" href="#aria-haspopup" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-haspopup</strong>: <code>boolean</code> | <code>"dialog"</code> | <code>"menu"</code> | <code>"grid"</code> | <code>"listbox"</code> | <code>"tree"</code> | <code>"true"</code> | <code>"false"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-haspopup</strong>: <code>boolean</code> | <code>"dialog"</code> | <code>"menu"</code> | <code>"tree"</code> | <code>"true"</code> | <code>"grid"</code> | <code>"listbox"</code> | <code>"false"</code></p>
|
||||
<p>Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.</p>
|
||||
<h4 id="inherited-from_21">Inherited from<a class="headerlink" href="#inherited-from_21" title="Permanent link">#</a></h4>
|
||||
<p>React.HTMLAttributes.aria-haspopup</p>
|
||||
@@ -3444,7 +3444,7 @@ A hint could be a sample value or a brief description of the expected format.</p
|
||||
<p>React.HTMLAttributes.inlist</p>
|
||||
<hr />
|
||||
<h3 id="inputmode">inputMode<a class="headerlink" href="#inputmode" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>inputMode</strong>: <code>"search"</code> | <code>"none"</code> | <code>"url"</code> | <code>"text"</code> | <code>"tel"</code> | <code>"email"</code> | <code>"numeric"</code> | <code>"decimal"</code></p>
|
||||
<p>• <code>Optional</code> <strong>inputMode</strong>: <code>"search"</code> | <code>"none"</code> | <code>"text"</code> | <code>"tel"</code> | <code>"url"</code> | <code>"email"</code> | <code>"numeric"</code> | <code>"decimal"</code></p>
|
||||
<p>Hints at the type of data that might be entered by the user while editing the element or its contents</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute</p>
|
||||
|
||||
@@ -3726,7 +3726,7 @@
|
||||
<p>React.HTMLProps.aria-atomic</p>
|
||||
<hr />
|
||||
<h3 id="aria-autocomplete">aria-autocomplete<a class="headerlink" href="#aria-autocomplete" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-autocomplete</strong>: <code>"none"</code> | <code>"list"</code> | <code>"inline"</code> | <code>"both"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-autocomplete</strong>: <code>"none"</code> | <code>"inline"</code> | <code>"list"</code> | <code>"both"</code></p>
|
||||
<p>Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
|
||||
presented if they are made.</p>
|
||||
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
||||
@@ -3788,7 +3788,7 @@ presented if they are made.</p>
|
||||
<p>React.HTMLProps.aria-controls</p>
|
||||
<hr />
|
||||
<h3 id="aria-current">aria-current<a class="headerlink" href="#aria-current" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-current</strong>: <code>boolean</code> | <code>"date"</code> | <code>"time"</code> | <code>"true"</code> | <code>"false"</code> | <code>"page"</code> | <code>"step"</code> | <code>"location"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-current</strong>: <code>boolean</code> | <code>"date"</code> | <code>"time"</code> | <code>"location"</code> | <code>"true"</code> | <code>"false"</code> | <code>"page"</code> | <code>"step"</code></p>
|
||||
<p>Indicates the element that represents the current item within a container or set of related elements.</p>
|
||||
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||
<p>React.HTMLProps.aria-current</p>
|
||||
@@ -3861,7 +3861,7 @@ allows assistive technology to override the general default of reading in docume
|
||||
<p>React.HTMLProps.aria-grabbed</p>
|
||||
<hr />
|
||||
<h3 id="aria-haspopup">aria-haspopup<a class="headerlink" href="#aria-haspopup" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-haspopup</strong>: <code>boolean</code> | <code>"dialog"</code> | <code>"menu"</code> | <code>"grid"</code> | <code>"listbox"</code> | <code>"tree"</code> | <code>"true"</code> | <code>"false"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-haspopup</strong>: <code>boolean</code> | <code>"dialog"</code> | <code>"menu"</code> | <code>"tree"</code> | <code>"true"</code> | <code>"grid"</code> | <code>"listbox"</code> | <code>"false"</code></p>
|
||||
<p>Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.</p>
|
||||
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||
<p>React.HTMLProps.aria-haspopup</p>
|
||||
@@ -4385,7 +4385,7 @@ A hint could be a sample value or a brief description of the expected format.</p
|
||||
<p>React.HTMLProps.inlist</p>
|
||||
<hr />
|
||||
<h3 id="inputmode">inputMode<a class="headerlink" href="#inputmode" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>inputMode</strong>: <code>"search"</code> | <code>"none"</code> | <code>"url"</code> | <code>"text"</code> | <code>"tel"</code> | <code>"email"</code> | <code>"numeric"</code> | <code>"decimal"</code></p>
|
||||
<p>• <code>Optional</code> <strong>inputMode</strong>: <code>"search"</code> | <code>"none"</code> | <code>"text"</code> | <code>"tel"</code> | <code>"url"</code> | <code>"email"</code> | <code>"numeric"</code> | <code>"decimal"</code></p>
|
||||
<p>Hints at the type of data that might be entered by the user while editing the element or its contents</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute</p>
|
||||
|
||||
@@ -3745,7 +3745,7 @@
|
||||
<p>React.HTMLProps.aria-atomic</p>
|
||||
<hr />
|
||||
<h3 id="aria-autocomplete">aria-autocomplete<a class="headerlink" href="#aria-autocomplete" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-autocomplete</strong>: <code>"none"</code> | <code>"list"</code> | <code>"inline"</code> | <code>"both"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-autocomplete</strong>: <code>"none"</code> | <code>"inline"</code> | <code>"list"</code> | <code>"both"</code></p>
|
||||
<p>Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
|
||||
presented if they are made.</p>
|
||||
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
||||
@@ -3807,7 +3807,7 @@ presented if they are made.</p>
|
||||
<p>React.HTMLProps.aria-controls</p>
|
||||
<hr />
|
||||
<h3 id="aria-current">aria-current<a class="headerlink" href="#aria-current" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-current</strong>: <code>boolean</code> | <code>"date"</code> | <code>"time"</code> | <code>"true"</code> | <code>"false"</code> | <code>"page"</code> | <code>"step"</code> | <code>"location"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-current</strong>: <code>boolean</code> | <code>"date"</code> | <code>"time"</code> | <code>"location"</code> | <code>"true"</code> | <code>"false"</code> | <code>"page"</code> | <code>"step"</code></p>
|
||||
<p>Indicates the element that represents the current item within a container or set of related elements.</p>
|
||||
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||
<p>React.HTMLProps.aria-current</p>
|
||||
@@ -3880,7 +3880,7 @@ allows assistive technology to override the general default of reading in docume
|
||||
<p>React.HTMLProps.aria-grabbed</p>
|
||||
<hr />
|
||||
<h3 id="aria-haspopup">aria-haspopup<a class="headerlink" href="#aria-haspopup" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-haspopup</strong>: <code>boolean</code> | <code>"dialog"</code> | <code>"menu"</code> | <code>"grid"</code> | <code>"listbox"</code> | <code>"tree"</code> | <code>"true"</code> | <code>"false"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-haspopup</strong>: <code>boolean</code> | <code>"dialog"</code> | <code>"menu"</code> | <code>"tree"</code> | <code>"true"</code> | <code>"grid"</code> | <code>"listbox"</code> | <code>"false"</code></p>
|
||||
<p>Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.</p>
|
||||
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||
<p>React.HTMLProps.aria-haspopup</p>
|
||||
@@ -4407,7 +4407,7 @@ A hint could be a sample value or a brief description of the expected format.</p
|
||||
<p>React.HTMLProps.inlist</p>
|
||||
<hr />
|
||||
<h3 id="inputmode">inputMode<a class="headerlink" href="#inputmode" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>inputMode</strong>: <code>"search"</code> | <code>"none"</code> | <code>"url"</code> | <code>"text"</code> | <code>"tel"</code> | <code>"email"</code> | <code>"numeric"</code> | <code>"decimal"</code></p>
|
||||
<p>• <code>Optional</code> <strong>inputMode</strong>: <code>"search"</code> | <code>"none"</code> | <code>"text"</code> | <code>"tel"</code> | <code>"url"</code> | <code>"email"</code> | <code>"numeric"</code> | <code>"decimal"</code></p>
|
||||
<p>Hints at the type of data that might be entered by the user while editing the element or its contents</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute</p>
|
||||
|
||||
@@ -921,7 +921,7 @@
|
||||
<p>• <code>Optional</code> <strong>innerRef</strong>: <code>ForwardedRef</code><<code>MonacoEditorRef</code>></p>
|
||||
<hr />
|
||||
<h3 id="language">language<a class="headerlink" href="#language" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>language</strong>: <code>"json"</code> | <code>"yaml"</code></p>
|
||||
<p>• <code>Optional</code> <strong>language</strong>: <code>"yaml"</code> | <code>"json"</code></p>
|
||||
<hr />
|
||||
<h3 id="options">options<a class="headerlink" href="#options" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>options</strong>: <code>Partial</code><<code>IStandaloneEditorConstructionOptions</code>></p>
|
||||
|
||||
@@ -2170,7 +2170,7 @@ when there isn't enough space below the control.</p>
|
||||
<p>Omit.theme</p>
|
||||
<hr />
|
||||
<h3 id="themename">themeName<a class="headerlink" href="#themename" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>themeName</strong>: <code>"dark"</code> | <code>"light"</code> | <code>"lens"</code> | <code>"outlined"</code></p>
|
||||
<p>• <code>Optional</code> <strong>themeName</strong>: <code>"lens"</code> | <code>"dark"</code> | <code>"light"</code> | <code>"outlined"</code></p>
|
||||
<h4 id="inherited-from_74">Inherited from<a class="headerlink" href="#inherited-from_74" title="Permanent link">#</a></h4>
|
||||
<p>Omit.themeName</p>
|
||||
<hr />
|
||||
|
||||
@@ -3289,7 +3289,7 @@
|
||||
<p>InputProps.aria-atomic</p>
|
||||
<hr />
|
||||
<h3 id="aria-autocomplete">aria-autocomplete<a class="headerlink" href="#aria-autocomplete" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-autocomplete</strong>: <code>"none"</code> | <code>"list"</code> | <code>"inline"</code> | <code>"both"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-autocomplete</strong>: <code>"none"</code> | <code>"inline"</code> | <code>"list"</code> | <code>"both"</code></p>
|
||||
<p>Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
|
||||
presented if they are made.</p>
|
||||
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||
@@ -3351,7 +3351,7 @@ presented if they are made.</p>
|
||||
<p>InputProps.aria-controls</p>
|
||||
<hr />
|
||||
<h3 id="aria-current">aria-current<a class="headerlink" href="#aria-current" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-current</strong>: <code>boolean</code> | <code>"date"</code> | <code>"time"</code> | <code>"true"</code> | <code>"false"</code> | <code>"page"</code> | <code>"step"</code> | <code>"location"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-current</strong>: <code>boolean</code> | <code>"date"</code> | <code>"time"</code> | <code>"location"</code> | <code>"true"</code> | <code>"false"</code> | <code>"page"</code> | <code>"step"</code></p>
|
||||
<p>Indicates the element that represents the current item within a container or set of related elements.</p>
|
||||
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||
<p>InputProps.aria-current</p>
|
||||
@@ -3424,7 +3424,7 @@ allows assistive technology to override the general default of reading in docume
|
||||
<p>InputProps.aria-grabbed</p>
|
||||
<hr />
|
||||
<h3 id="aria-haspopup">aria-haspopup<a class="headerlink" href="#aria-haspopup" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-haspopup</strong>: <code>boolean</code> | <code>"dialog"</code> | <code>"menu"</code> | <code>"grid"</code> | <code>"listbox"</code> | <code>"tree"</code> | <code>"true"</code> | <code>"false"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-haspopup</strong>: <code>boolean</code> | <code>"dialog"</code> | <code>"menu"</code> | <code>"tree"</code> | <code>"true"</code> | <code>"grid"</code> | <code>"listbox"</code> | <code>"false"</code></p>
|
||||
<p>Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.</p>
|
||||
<h4 id="inherited-from_22">Inherited from<a class="headerlink" href="#inherited-from_22" title="Permanent link">#</a></h4>
|
||||
<p>InputProps.aria-haspopup</p>
|
||||
@@ -3799,7 +3799,7 @@ A hint could be a sample value or a brief description of the expected format.</p
|
||||
<p>InputProps.draggable</p>
|
||||
<hr />
|
||||
<h3 id="enterkeyhint">enterKeyHint<a class="headerlink" href="#enterkeyhint" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>enterKeyHint</strong>: <code>"search"</code> | <code>"done"</code> | <code>"enter"</code> | <code>"previous"</code> | <code>"send"</code> | <code>"go"</code> | <code>"next"</code></p>
|
||||
<p>• <code>Optional</code> <strong>enterKeyHint</strong>: <code>"search"</code> | <code>"done"</code> | <code>"enter"</code> | <code>"previous"</code> | <code>"send"</code> | <code>"next"</code> | <code>"go"</code></p>
|
||||
<h4 id="inherited-from_78">Inherited from<a class="headerlink" href="#inherited-from_78" title="Permanent link">#</a></h4>
|
||||
<p>InputProps.enterKeyHint</p>
|
||||
<hr />
|
||||
@@ -3864,7 +3864,7 @@ A hint could be a sample value or a brief description of the expected format.</p
|
||||
<p>InputProps.inlist</p>
|
||||
<hr />
|
||||
<h3 id="inputmode">inputMode<a class="headerlink" href="#inputmode" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>inputMode</strong>: <code>"search"</code> | <code>"none"</code> | <code>"url"</code> | <code>"text"</code> | <code>"tel"</code> | <code>"email"</code> | <code>"numeric"</code> | <code>"decimal"</code></p>
|
||||
<p>• <code>Optional</code> <strong>inputMode</strong>: <code>"search"</code> | <code>"none"</code> | <code>"text"</code> | <code>"tel"</code> | <code>"url"</code> | <code>"email"</code> | <code>"numeric"</code> | <code>"decimal"</code></p>
|
||||
<p>Hints at the type of data that might be entered by the user while editing the element or its contents</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute</p>
|
||||
|
||||
@@ -2141,7 +2141,7 @@ when there isn't enough space below the control.</p>
|
||||
<p>Omit.theme</p>
|
||||
<hr />
|
||||
<h3 id="themename">themeName<a class="headerlink" href="#themename" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>themeName</strong>: <code>"dark"</code> | <code>"light"</code> | <code>"lens"</code> | <code>"outlined"</code></p>
|
||||
<p>• <code>Optional</code> <strong>themeName</strong>: <code>"lens"</code> | <code>"dark"</code> | <code>"light"</code> | <code>"outlined"</code></p>
|
||||
<hr />
|
||||
<h3 id="unstyled">unstyled<a class="headerlink" href="#unstyled" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>unstyled</strong>: <code>boolean</code></p>
|
||||
|
||||
@@ -3033,7 +3033,7 @@
|
||||
<p>Omit.aria-atomic</p>
|
||||
<hr />
|
||||
<h3 id="aria-autocomplete">aria-autocomplete<a class="headerlink" href="#aria-autocomplete" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-autocomplete</strong>: <code>"none"</code> | <code>"list"</code> | <code>"inline"</code> | <code>"both"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-autocomplete</strong>: <code>"none"</code> | <code>"inline"</code> | <code>"list"</code> | <code>"both"</code></p>
|
||||
<p>Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
|
||||
presented if they are made.</p>
|
||||
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||
@@ -3095,7 +3095,7 @@ presented if they are made.</p>
|
||||
<p>Omit.aria-controls</p>
|
||||
<hr />
|
||||
<h3 id="aria-current">aria-current<a class="headerlink" href="#aria-current" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-current</strong>: <code>boolean</code> | <code>"date"</code> | <code>"time"</code> | <code>"true"</code> | <code>"false"</code> | <code>"page"</code> | <code>"step"</code> | <code>"location"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-current</strong>: <code>boolean</code> | <code>"date"</code> | <code>"time"</code> | <code>"location"</code> | <code>"true"</code> | <code>"false"</code> | <code>"page"</code> | <code>"step"</code></p>
|
||||
<p>Indicates the element that represents the current item within a container or set of related elements.</p>
|
||||
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||
<p>Omit.aria-current</p>
|
||||
@@ -3168,7 +3168,7 @@ allows assistive technology to override the general default of reading in docume
|
||||
<p>Omit.aria-grabbed</p>
|
||||
<hr />
|
||||
<h3 id="aria-haspopup">aria-haspopup<a class="headerlink" href="#aria-haspopup" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-haspopup</strong>: <code>boolean</code> | <code>"dialog"</code> | <code>"menu"</code> | <code>"grid"</code> | <code>"listbox"</code> | <code>"tree"</code> | <code>"true"</code> | <code>"false"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-haspopup</strong>: <code>boolean</code> | <code>"dialog"</code> | <code>"menu"</code> | <code>"tree"</code> | <code>"true"</code> | <code>"grid"</code> | <code>"listbox"</code> | <code>"false"</code></p>
|
||||
<p>Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.</p>
|
||||
<h4 id="inherited-from_22">Inherited from<a class="headerlink" href="#inherited-from_22" title="Permanent link">#</a></h4>
|
||||
<p>Omit.aria-haspopup</p>
|
||||
@@ -3560,7 +3560,7 @@ A hint could be a sample value or a brief description of the expected format.</p
|
||||
<p>Omit.innerRef</p>
|
||||
<hr />
|
||||
<h3 id="inputmode">inputMode<a class="headerlink" href="#inputmode" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>inputMode</strong>: <code>"search"</code> | <code>"none"</code> | <code>"url"</code> | <code>"text"</code> | <code>"tel"</code> | <code>"email"</code> | <code>"numeric"</code> | <code>"decimal"</code></p>
|
||||
<p>• <code>Optional</code> <strong>inputMode</strong>: <code>"search"</code> | <code>"none"</code> | <code>"text"</code> | <code>"tel"</code> | <code>"url"</code> | <code>"email"</code> | <code>"numeric"</code> | <code>"decimal"</code></p>
|
||||
<p>Hints at the type of data that might be entered by the user while editing the element or its contents</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute</p>
|
||||
|
||||
@@ -3734,7 +3734,7 @@
|
||||
<p>React.HTMLProps.aria-atomic</p>
|
||||
<hr />
|
||||
<h3 id="aria-autocomplete">aria-autocomplete<a class="headerlink" href="#aria-autocomplete" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-autocomplete</strong>: <code>"none"</code> | <code>"list"</code> | <code>"inline"</code> | <code>"both"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-autocomplete</strong>: <code>"none"</code> | <code>"inline"</code> | <code>"list"</code> | <code>"both"</code></p>
|
||||
<p>Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
|
||||
presented if they are made.</p>
|
||||
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
||||
@@ -3796,7 +3796,7 @@ presented if they are made.</p>
|
||||
<p>React.HTMLProps.aria-controls</p>
|
||||
<hr />
|
||||
<h3 id="aria-current">aria-current<a class="headerlink" href="#aria-current" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-current</strong>: <code>boolean</code> | <code>"date"</code> | <code>"time"</code> | <code>"true"</code> | <code>"false"</code> | <code>"page"</code> | <code>"step"</code> | <code>"location"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-current</strong>: <code>boolean</code> | <code>"date"</code> | <code>"time"</code> | <code>"location"</code> | <code>"true"</code> | <code>"false"</code> | <code>"page"</code> | <code>"step"</code></p>
|
||||
<p>Indicates the element that represents the current item within a container or set of related elements.</p>
|
||||
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||
<p>React.HTMLProps.aria-current</p>
|
||||
@@ -3869,7 +3869,7 @@ allows assistive technology to override the general default of reading in docume
|
||||
<p>React.HTMLProps.aria-grabbed</p>
|
||||
<hr />
|
||||
<h3 id="aria-haspopup">aria-haspopup<a class="headerlink" href="#aria-haspopup" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-haspopup</strong>: <code>boolean</code> | <code>"dialog"</code> | <code>"menu"</code> | <code>"grid"</code> | <code>"listbox"</code> | <code>"tree"</code> | <code>"true"</code> | <code>"false"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-haspopup</strong>: <code>boolean</code> | <code>"dialog"</code> | <code>"menu"</code> | <code>"tree"</code> | <code>"true"</code> | <code>"grid"</code> | <code>"listbox"</code> | <code>"false"</code></p>
|
||||
<p>Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.</p>
|
||||
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||
<p>React.HTMLProps.aria-haspopup</p>
|
||||
@@ -4396,7 +4396,7 @@ A hint could be a sample value or a brief description of the expected format.</p
|
||||
<p>React.HTMLProps.inlist</p>
|
||||
<hr />
|
||||
<h3 id="inputmode">inputMode<a class="headerlink" href="#inputmode" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>inputMode</strong>: <code>"search"</code> | <code>"none"</code> | <code>"url"</code> | <code>"text"</code> | <code>"tel"</code> | <code>"email"</code> | <code>"numeric"</code> | <code>"decimal"</code></p>
|
||||
<p>• <code>Optional</code> <strong>inputMode</strong>: <code>"search"</code> | <code>"none"</code> | <code>"text"</code> | <code>"tel"</code> | <code>"url"</code> | <code>"email"</code> | <code>"numeric"</code> | <code>"decimal"</code></p>
|
||||
<p>Hints at the type of data that might be entered by the user while editing the element or its contents</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute</p>
|
||||
|
||||
@@ -2832,7 +2832,7 @@
|
||||
<p>React.HTMLAttributes.aria-atomic</p>
|
||||
<hr />
|
||||
<h3 id="aria-autocomplete">aria-autocomplete<a class="headerlink" href="#aria-autocomplete" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-autocomplete</strong>: <code>"none"</code> | <code>"list"</code> | <code>"inline"</code> | <code>"both"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-autocomplete</strong>: <code>"none"</code> | <code>"inline"</code> | <code>"list"</code> | <code>"both"</code></p>
|
||||
<p>Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
|
||||
presented if they are made.</p>
|
||||
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||
@@ -2894,7 +2894,7 @@ presented if they are made.</p>
|
||||
<p>React.HTMLAttributes.aria-controls</p>
|
||||
<hr />
|
||||
<h3 id="aria-current">aria-current<a class="headerlink" href="#aria-current" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-current</strong>: <code>boolean</code> | <code>"date"</code> | <code>"time"</code> | <code>"true"</code> | <code>"false"</code> | <code>"page"</code> | <code>"step"</code> | <code>"location"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-current</strong>: <code>boolean</code> | <code>"date"</code> | <code>"time"</code> | <code>"location"</code> | <code>"true"</code> | <code>"false"</code> | <code>"page"</code> | <code>"step"</code></p>
|
||||
<p>Indicates the element that represents the current item within a container or set of related elements.</p>
|
||||
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||
<p>React.HTMLAttributes.aria-current</p>
|
||||
@@ -2967,7 +2967,7 @@ allows assistive technology to override the general default of reading in docume
|
||||
<p>React.HTMLAttributes.aria-grabbed</p>
|
||||
<hr />
|
||||
<h3 id="aria-haspopup">aria-haspopup<a class="headerlink" href="#aria-haspopup" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-haspopup</strong>: <code>boolean</code> | <code>"dialog"</code> | <code>"menu"</code> | <code>"grid"</code> | <code>"listbox"</code> | <code>"tree"</code> | <code>"true"</code> | <code>"false"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-haspopup</strong>: <code>boolean</code> | <code>"dialog"</code> | <code>"menu"</code> | <code>"tree"</code> | <code>"true"</code> | <code>"grid"</code> | <code>"listbox"</code> | <code>"false"</code></p>
|
||||
<p>Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.</p>
|
||||
<h4 id="inherited-from_20">Inherited from<a class="headerlink" href="#inherited-from_20" title="Permanent link">#</a></h4>
|
||||
<p>React.HTMLAttributes.aria-haspopup</p>
|
||||
@@ -3291,7 +3291,7 @@ A hint could be a sample value or a brief description of the expected format.</p
|
||||
<p>React.HTMLAttributes.inlist</p>
|
||||
<hr />
|
||||
<h3 id="inputmode">inputMode<a class="headerlink" href="#inputmode" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>inputMode</strong>: <code>"search"</code> | <code>"none"</code> | <code>"url"</code> | <code>"text"</code> | <code>"tel"</code> | <code>"email"</code> | <code>"numeric"</code> | <code>"decimal"</code></p>
|
||||
<p>• <code>Optional</code> <strong>inputMode</strong>: <code>"search"</code> | <code>"none"</code> | <code>"text"</code> | <code>"tel"</code> | <code>"url"</code> | <code>"email"</code> | <code>"numeric"</code> | <code>"decimal"</code></p>
|
||||
<p>Hints at the type of data that might be entered by the user while editing the element or its contents</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute</p>
|
||||
|
||||
@@ -3726,7 +3726,7 @@
|
||||
<p>React.HTMLProps.aria-atomic</p>
|
||||
<hr />
|
||||
<h3 id="aria-autocomplete">aria-autocomplete<a class="headerlink" href="#aria-autocomplete" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-autocomplete</strong>: <code>"none"</code> | <code>"list"</code> | <code>"inline"</code> | <code>"both"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-autocomplete</strong>: <code>"none"</code> | <code>"inline"</code> | <code>"list"</code> | <code>"both"</code></p>
|
||||
<p>Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
|
||||
presented if they are made.</p>
|
||||
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
||||
@@ -3788,7 +3788,7 @@ presented if they are made.</p>
|
||||
<p>React.HTMLProps.aria-controls</p>
|
||||
<hr />
|
||||
<h3 id="aria-current">aria-current<a class="headerlink" href="#aria-current" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-current</strong>: <code>boolean</code> | <code>"date"</code> | <code>"time"</code> | <code>"true"</code> | <code>"false"</code> | <code>"page"</code> | <code>"step"</code> | <code>"location"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-current</strong>: <code>boolean</code> | <code>"date"</code> | <code>"time"</code> | <code>"location"</code> | <code>"true"</code> | <code>"false"</code> | <code>"page"</code> | <code>"step"</code></p>
|
||||
<p>Indicates the element that represents the current item within a container or set of related elements.</p>
|
||||
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||
<p>React.HTMLProps.aria-current</p>
|
||||
@@ -3861,7 +3861,7 @@ allows assistive technology to override the general default of reading in docume
|
||||
<p>React.HTMLProps.aria-grabbed</p>
|
||||
<hr />
|
||||
<h3 id="aria-haspopup">aria-haspopup<a class="headerlink" href="#aria-haspopup" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-haspopup</strong>: <code>boolean</code> | <code>"dialog"</code> | <code>"menu"</code> | <code>"grid"</code> | <code>"listbox"</code> | <code>"tree"</code> | <code>"true"</code> | <code>"false"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-haspopup</strong>: <code>boolean</code> | <code>"dialog"</code> | <code>"menu"</code> | <code>"tree"</code> | <code>"true"</code> | <code>"grid"</code> | <code>"listbox"</code> | <code>"false"</code></p>
|
||||
<p>Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.</p>
|
||||
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||
<p>React.HTMLProps.aria-haspopup</p>
|
||||
@@ -4385,7 +4385,7 @@ A hint could be a sample value or a brief description of the expected format.</p
|
||||
<p>React.HTMLProps.inlist</p>
|
||||
<hr />
|
||||
<h3 id="inputmode">inputMode<a class="headerlink" href="#inputmode" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>inputMode</strong>: <code>"search"</code> | <code>"none"</code> | <code>"url"</code> | <code>"text"</code> | <code>"tel"</code> | <code>"email"</code> | <code>"numeric"</code> | <code>"decimal"</code></p>
|
||||
<p>• <code>Optional</code> <strong>inputMode</strong>: <code>"search"</code> | <code>"none"</code> | <code>"text"</code> | <code>"tel"</code> | <code>"url"</code> | <code>"email"</code> | <code>"numeric"</code> | <code>"decimal"</code></p>
|
||||
<p>Hints at the type of data that might be entered by the user while editing the element or its contents</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute</p>
|
||||
|
||||
@@ -3718,7 +3718,7 @@
|
||||
<p>Omit.aria-atomic</p>
|
||||
<hr />
|
||||
<h3 id="aria-autocomplete">aria-autocomplete<a class="headerlink" href="#aria-autocomplete" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-autocomplete</strong>: <code>"none"</code> | <code>"list"</code> | <code>"inline"</code> | <code>"both"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-autocomplete</strong>: <code>"none"</code> | <code>"inline"</code> | <code>"list"</code> | <code>"both"</code></p>
|
||||
<p>Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
|
||||
presented if they are made.</p>
|
||||
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
||||
@@ -3780,7 +3780,7 @@ presented if they are made.</p>
|
||||
<p>Omit.aria-controls</p>
|
||||
<hr />
|
||||
<h3 id="aria-current">aria-current<a class="headerlink" href="#aria-current" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-current</strong>: <code>boolean</code> | <code>"date"</code> | <code>"time"</code> | <code>"true"</code> | <code>"false"</code> | <code>"page"</code> | <code>"step"</code> | <code>"location"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-current</strong>: <code>boolean</code> | <code>"date"</code> | <code>"time"</code> | <code>"location"</code> | <code>"true"</code> | <code>"false"</code> | <code>"page"</code> | <code>"step"</code></p>
|
||||
<p>Indicates the element that represents the current item within a container or set of related elements.</p>
|
||||
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||
<p>Omit.aria-current</p>
|
||||
@@ -3853,7 +3853,7 @@ allows assistive technology to override the general default of reading in docume
|
||||
<p>Omit.aria-grabbed</p>
|
||||
<hr />
|
||||
<h3 id="aria-haspopup">aria-haspopup<a class="headerlink" href="#aria-haspopup" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>aria-haspopup</strong>: <code>boolean</code> | <code>"dialog"</code> | <code>"menu"</code> | <code>"grid"</code> | <code>"listbox"</code> | <code>"tree"</code> | <code>"true"</code> | <code>"false"</code></p>
|
||||
<p>• <code>Optional</code> <strong>aria-haspopup</strong>: <code>boolean</code> | <code>"dialog"</code> | <code>"menu"</code> | <code>"tree"</code> | <code>"true"</code> | <code>"grid"</code> | <code>"listbox"</code> | <code>"false"</code></p>
|
||||
<p>Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.</p>
|
||||
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||
<p>Omit.aria-haspopup</p>
|
||||
@@ -4377,7 +4377,7 @@ A hint could be a sample value or a brief description of the expected format.</p
|
||||
<p>Omit.inlist</p>
|
||||
<hr />
|
||||
<h3 id="inputmode">inputMode<a class="headerlink" href="#inputmode" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>inputMode</strong>: <code>"search"</code> | <code>"none"</code> | <code>"url"</code> | <code>"text"</code> | <code>"tel"</code> | <code>"email"</code> | <code>"numeric"</code> | <code>"decimal"</code></p>
|
||||
<p>• <code>Optional</code> <strong>inputMode</strong>: <code>"search"</code> | <code>"none"</code> | <code>"text"</code> | <code>"tel"</code> | <code>"url"</code> | <code>"email"</code> | <code>"numeric"</code> | <code>"decimal"</code></p>
|
||||
<p>Hints at the type of data that might be entered by the user while editing the element or its contents</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute</p>
|
||||
|
||||
@@ -758,6 +758,13 @@
|
||||
description
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#isdefault" class="md-nav__link">
|
||||
isDefault
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -772,6 +779,13 @@
|
||||
name
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#terminalcolors" class="md-nav__link">
|
||||
terminalColors
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -808,8 +822,10 @@
|
||||
<li><a href="./#author">author</a></li>
|
||||
<li><a href="./#colors">colors</a></li>
|
||||
<li><a href="./#description">description</a></li>
|
||||
<li><a href="./#isdefault">isDefault</a></li>
|
||||
<li><a href="./#monacotheme">monacoTheme</a></li>
|
||||
<li><a href="./#name">name</a></li>
|
||||
<li><a href="./#terminalcolors">terminalColors</a></li>
|
||||
<li><a href="./#type">type</a></li>
|
||||
</ul>
|
||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||
@@ -817,17 +833,23 @@
|
||||
<p>• <strong>author</strong>: <code>string</code></p>
|
||||
<hr />
|
||||
<h3 id="colors">colors<a class="headerlink" href="#colors" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>colors</strong>: <code>Record</code><<code>string</code>, <code>string</code>></p>
|
||||
<p>• <strong>colors</strong>: <code>Record</code><<code>LensColorName</code>, <code>string</code>></p>
|
||||
<hr />
|
||||
<h3 id="description">description<a class="headerlink" href="#description" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>description</strong>: <code>string</code></p>
|
||||
<hr />
|
||||
<h3 id="isdefault">isDefault<a class="headerlink" href="#isdefault" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>isDefault</strong>: <code>boolean</code></p>
|
||||
<hr />
|
||||
<h3 id="monacotheme">monacoTheme<a class="headerlink" href="#monacotheme" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>monacoTheme</strong>: <a href="../../modules/Renderer.Component/#monacotheme"><code>MonacoTheme</code></a></p>
|
||||
<hr />
|
||||
<h3 id="name">name<a class="headerlink" href="#name" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>name</strong>: <code>string</code></p>
|
||||
<hr />
|
||||
<h3 id="terminalcolors">terminalColors<a class="headerlink" href="#terminalcolors" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>terminalColors</strong>: <code>Partial</code><<code>Record</code><<code>TerminalColorName</code>, <code>string</code>>></p>
|
||||
<hr />
|
||||
<h3 id="type">type<a class="headerlink" href="#type" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>type</strong>: <code>LensThemeType</code></p>
|
||||
|
||||
|
||||
@@ -3066,7 +3066,7 @@ valid if one of the input validators matches the input</p>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>Target</code></td>
|
||||
<td align="left"><code>TargetProps</code> extends <code>Pick</code><<a href="../../interfaces/Renderer.Component.TooltipDecoratorProps/"><code>TooltipDecoratorProps</code></a>, <code>"children"</code> | <code>"id"</code>> ? <code>FunctionComponent</code><<code>TargetProps</code>> : <code>never</code></td>
|
||||
<td align="left"><code>TargetProps</code> extends <code>Pick</code><<a href="../../interfaces/Renderer.Component.TooltipDecoratorProps/"><code>TooltipDecoratorProps</code></a>, <code>"id"</code> | <code>"children"</code>> ? <code>FunctionComponent</code><<code>TargetProps</code>> : <code>never</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
@@ -816,14 +816,14 @@
|
||||
</ul>
|
||||
<h2 id="variables_1">Variables<a class="headerlink" href="#variables_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="activetheme">activeTheme<a class="headerlink" href="#activetheme" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Const</code> <strong>activeTheme</strong>: <code>IComputedValue</code><<a href="../../interfaces/Renderer.Theme.LensTheme/"><code>LensTheme</code></a>></p>
|
||||
<p>• <code>Const</code> <strong>activeTheme</strong>: <code>IComputedValue</code><<code>ReadonlyObjectDeep</code><<a href="../../interfaces/Renderer.Theme.LensTheme/"><code>LensTheme</code></a>>></p>
|
||||
<h2 id="functions_1">Functions<a class="headerlink" href="#functions_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="getactivetheme">getActiveTheme<a class="headerlink" href="#getactivetheme" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getActiveTheme</strong>(): <a href="../../interfaces/Renderer.Theme.LensTheme/"><code>LensTheme</code></a></p>
|
||||
<p>▸ <strong>getActiveTheme</strong>(): <code>ReadonlyObjectDeep</code><<a href="../../interfaces/Renderer.Theme.LensTheme/"><code>LensTheme</code></a>></p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This hides the reactivity of active theme, use <a href="./#activetheme">activeTheme</a> instead</p>
|
||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||
<p><a href="../../interfaces/Renderer.Theme.LensTheme/"><code>LensTheme</code></a></p>
|
||||
<p><code>ReadonlyObjectDeep</code><<a href="../../interfaces/Renderer.Theme.LensTheme/"><code>LensTheme</code></a>></p>
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1 +1 @@
|
||||
{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Lens Extension API # Customize and enhance the Lens experience with the Lens Extension API. Use the extension API to create menus or page content. The same extension API was used to create many of Lens's core features. To install your first extension you should goto the extension page in lens. This documentation describes: How to build, run, test, and publish an extension. How to take full advantage of the Lens Extension API. Where to find guides and code samples to help get you started. What Extensions Can Do # Here are some examples of what you can achieve with the Extension API: Add custom components & views in the UI - Extending the Lens Workbench For an overview of the Lens Extension API, refer to the Common Capabilities page. Extension Guides Overview also includes a list of code samples and guides that illustrate various ways of using the Lens Extension API. How to Build Extensions # Here is what each section of the Lens Extension API docs can help you with: Getting Started teaches fundamental concepts for building extensions with the Hello World sample. Extension Capabilities dissects Lens's Extension API into smaller categories and points you to more detailed topics. Extension Guides includes guides and code samples that explain specific usages of Lens Extension API. Testing and Publishing includes in-depth guides on various extension development topics, such as testing and publishing extensions. API Reference contains exhaustive references for the Lens Extension API, Contribution Points, and many other topics. What's New # Just like Lens itself, the extension API updates on a monthly cadence, rolling out new features with every release. Keep up with Lens and the Lens Extension API by reviewing the release notes . Important changes since Lens v4 # Lens has undergone major design improvements in v5, which have resulted in several large changes to the extension API. Workspaces are gone, and the catalog is introduced for containing clusters, as well as other items, including custom entities. Lens has migrated from using mobx 5 to mobx 6 for internal state management, and this may have ramifications for extension implementations. Although the API retains many components from v4, given these changes, extensions written for Lens v4 are not compatible with the Lens v5 extension API. See the Lens v4 to v5 extension migration notes on getting old extensions working in Lens v5. Looking for Help # If you have questions for extension development, try asking on the Lens Dev Slack . It's a public chatroom for Lens developers, where Lens team members chime in from time to time. To provide feedback on the documentation or issues with the Lens Extension API, create new issues at lensapp/lens . Please use the labels area/documentation and/or area/extension . Downloading Lens # Download Lens for macOS, Windows, or Linux.","title":"Overview"},{"location":"#lens-extension-api","text":"Customize and enhance the Lens experience with the Lens Extension API. Use the extension API to create menus or page content. The same extension API was used to create many of Lens's core features. To install your first extension you should goto the extension page in lens. This documentation describes: How to build, run, test, and publish an extension. How to take full advantage of the Lens Extension API. Where to find guides and code samples to help get you started.","title":"Lens Extension API"},{"location":"#what-extensions-can-do","text":"Here are some examples of what you can achieve with the Extension API: Add custom components & views in the UI - Extending the Lens Workbench For an overview of the Lens Extension API, refer to the Common Capabilities page. Extension Guides Overview also includes a list of code samples and guides that illustrate various ways of using the Lens Extension API.","title":"What Extensions Can Do"},{"location":"#how-to-build-extensions","text":"Here is what each section of the Lens Extension API docs can help you with: Getting Started teaches fundamental concepts for building extensions with the Hello World sample. Extension Capabilities dissects Lens's Extension API into smaller categories and points you to more detailed topics. Extension Guides includes guides and code samples that explain specific usages of Lens Extension API. Testing and Publishing includes in-depth guides on various extension development topics, such as testing and publishing extensions. API Reference contains exhaustive references for the Lens Extension API, Contribution Points, and many other topics.","title":"How to Build Extensions"},{"location":"#whats-new","text":"Just like Lens itself, the extension API updates on a monthly cadence, rolling out new features with every release. Keep up with Lens and the Lens Extension API by reviewing the release notes .","title":"What's New"},{"locationLine truncated
|
||||
{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Lens Extension API # Customize and enhance the Lens experience with the Lens Extension API. Use the extension API to create menus or page content. The same extension API was used to create many of Lens's core features. To install your first extension you should goto the extension page in lens. This documentation describes: How to build, run, test, and publish an extension. How to take full advantage of the Lens Extension API. Where to find guides and code samples to help get you started. What Extensions Can Do # Here are some examples of what you can achieve with the Extension API: Add custom components & views in the UI - Extending the Lens Workbench For an overview of the Lens Extension API, refer to the Common Capabilities page. Extension Guides Overview also includes a list of code samples and guides that illustrate various ways of using the Lens Extension API. How to Build Extensions # Here is what each section of the Lens Extension API docs can help you with: Getting Started teaches fundamental concepts for building extensions with the Hello World sample. Extension Capabilities dissects Lens's Extension API into smaller categories and points you to more detailed topics. Extension Guides includes guides and code samples that explain specific usages of Lens Extension API. Testing and Publishing includes in-depth guides on various extension development topics, such as testing and publishing extensions. API Reference contains exhaustive references for the Lens Extension API, Contribution Points, and many other topics. What's New # Just like Lens itself, the extension API updates on a monthly cadence, rolling out new features with every release. Keep up with Lens and the Lens Extension API by reviewing the release notes . Important changes since Lens v4 # Lens has undergone major design improvements in v5, which have resulted in several large changes to the extension API. Workspaces are gone, and the catalog is introduced for containing clusters, as well as other items, including custom entities. Lens has migrated from using mobx 5 to mobx 6 for internal state management, and this may have ramifications for extension implementations. Although the API retains many components from v4, given these changes, extensions written for Lens v4 are not compatible with the Lens v5 extension API. See the Lens v4 to v5 extension migration notes on getting old extensions working in Lens v5. Looking for Help # If you have questions for extension development, try asking on the Lens Dev Slack . It's a public chatroom for Lens developers, where Lens team members chime in from time to time. To provide feedback on the documentation or issues with the Lens Extension API, create new issues at lensapp/lens . Please use the labels area/documentation and/or area/extension . Downloading Lens # Download Lens for macOS, Windows, or Linux.","title":"Overview"},{"location":"#lens-extension-api","text":"Customize and enhance the Lens experience with the Lens Extension API. Use the extension API to create menus or page content. The same extension API was used to create many of Lens's core features. To install your first extension you should goto the extension page in lens. This documentation describes: How to build, run, test, and publish an extension. How to take full advantage of the Lens Extension API. Where to find guides and code samples to help get you started.","title":"Lens Extension API"},{"location":"#what-extensions-can-do","text":"Here are some examples of what you can achieve with the Extension API: Add custom components & views in the UI - Extending the Lens Workbench For an overview of the Lens Extension API, refer to the Common Capabilities page. Extension Guides Overview also includes a list of code samples and guides that illustrate various ways of using the Lens Extension API.","title":"What Extensions Can Do"},{"location":"#how-to-build-extensions","text":"Here is what each section of the Lens Extension API docs can help you with: Getting Started teaches fundamental concepts for building extensions with the Hello World sample. Extension Capabilities dissects Lens's Extension API into smaller categories and points you to more detailed topics. Extension Guides includes guides and code samples that explain specific usages of Lens Extension API. Testing and Publishing includes in-depth guides on various extension development topics, such as testing and publishing extensions. API Reference contains exhaustive references for the Lens Extension API, Contribution Points, and many other topics.","title":"How to Build Extensions"},{"location":"#whats-new","text":"Just like Lens itself, the extension API updates on a monthly cadence, rolling out new features with every release. Keep up with Lens and the Lens Extension API by reviewing the release notes .","title":"What's New"},{"locationLine truncated
|
||||
Binary file not shown.
Reference in new issue
Block a user