Deployed c9cd1cd8e0 to master with MkDocs 1.4.2 and mike 1.1.2

This commit is contained in:
GitHub Action committed 2023-04-06 13:21:58 +00:00
1 parent 2b12f6338c
commit e678baedb2
11 files changed
+388 -435

No files matched your search

@@ -87,7 +87,7 @@
<div data-md-component="skip">
<a href="#class-lensextensiondependencies" class="md-skip">
<a href="#class-lensextension" class="md-skip">
Skip to content
</a>
@@ -125,7 +125,7 @@
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Class: LensExtension<Dependencies\>
Class: LensExtension
</span>
</div>
@@ -710,25 +710,11 @@
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#type-parameters" class="md-nav__link">
Type parameters
</a>
</li>
<li class="md-nav__item">
<a href="#hierarchy" class="md-nav__link">
Hierarchy
</a>
</li>
<li class="md-nav__item">
<a href="#implements" class="md-nav__link">
Implements
</a>
</li>
<li class="md-nav__item">
@@ -965,33 +951,14 @@
<h1 id="class-lensextensiondependencies">Class: LensExtension&lt;Dependencies><a class="headerlink" href="#class-lensextensiondependencies" title="Permanent link">#</a></h1>
<h1 id="class-lensextension">Class: LensExtension<a class="headerlink" href="#class-lensextension" title="Permanent link">#</a></h1>
<p><a href="../../modules/Common/">Common</a>.LensExtension</p>
<h2 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h2>
<table>
<thead>
<tr>
<th align="left">Name</th>
<th align="left">Type</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>Dependencies</code></td>
<td align="left">extends <code>LensExtensionDependencies</code> = <code>LensExtensionDependencies</code></td>
</tr>
</tbody>
</table>
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
<ul>
<li><strong><code>LensExtension</code></strong></li>
</ul>
<p>↳ <a href="../Main.LensExtension/"><code>LensExtension</code></a></p>
<p>↳ <a href="../Renderer.LensExtension/"><code>LensExtension</code></a></p>
<h2 id="implements">Implements<a class="headerlink" href="#implements" title="Permanent link">#</a></h2>
<ul>
<li><code>LegacyLensExtension</code></li>
</ul>
<h2 id="table-of-contents">Table of contents<a class="headerlink" href="#table-of-contents" title="Permanent link">#</a></h2>
<h3 id="constructors">Constructors<a class="headerlink" href="#constructors" title="Permanent link">#</a></h3>
<ul>
@@ -1025,22 +992,7 @@
</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>• <strong>new LensExtension</strong>&lt;<code>Dependencies</code>>(<code>«destructured»</code>)</p>
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-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>Dependencies</code></td>
<td align="left">extends <code>LensExtensionDependencies</code> = <code>LensExtensionDependencies</code></td>
</tr>
</tbody>
</table>
<p>• <strong>new LensExtension</strong>(<code>deps</code>, <code>«destructured»</code>)</p>
<h4 id="parameters">Parameters<a class="headerlink" href="#parameters" title="Permanent link">#</a></h4>
<table>
<thead>
@@ -1051,6 +1003,10 @@
</thead>
<tbody>
<tr>
<td align="left"><code>deps</code></td>
<td align="left"><code>LensExtensionDependencies</code></td>
</tr>
<tr>
<td align="left"><code>«destructured»</code></td>
<td align="left"><a href="../../modules/Common/#installedextension"><code>InstalledExtension</code></a></td>
</tr>
@@ -1059,23 +1015,15 @@
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
<h3 id="id">id<a class="headerlink" href="#id" title="Permanent link">#</a></h3>
<p>• <code>Readonly</code> <strong>id</strong>: <code>string</code></p>
<h4 id="implementation-of">Implementation of<a class="headerlink" href="#implementation-of" title="Permanent link">#</a></h4>
<p>LegacyLensExtension.id</p>
<hr />
<h3 id="isbundled">isBundled<a class="headerlink" href="#isbundled" title="Permanent link">#</a></h3>
<p>• <code>Readonly</code> <strong>isBundled</strong>: <code>boolean</code></p>
<h4 id="implementation-of_1">Implementation of<a class="headerlink" href="#implementation-of_1" title="Permanent link">#</a></h4>
<p>LegacyLensExtension.isBundled</p>
<hr />
<h3 id="manifest">manifest<a class="headerlink" href="#manifest" title="Permanent link">#</a></h3>
<p>• <code>Readonly</code> <strong>manifest</strong>: <a href="../../interfaces/Common.LensExtensionManifest/"><code>LensExtensionManifest</code></a></p>
<h4 id="implementation-of_2">Implementation of<a class="headerlink" href="#implementation-of_2" title="Permanent link">#</a></h4>
<p>LegacyLensExtension.manifest</p>
<hr />
<h3 id="manifestpath">manifestPath<a class="headerlink" href="#manifestpath" title="Permanent link">#</a></h3>
<p>• <code>Readonly</code> <strong>manifestPath</strong>: <code>string</code></p>
<h4 id="implementation-of_3">Implementation of<a class="headerlink" href="#implementation-of_3" title="Permanent link">#</a></h4>
<p>LegacyLensExtension.manifestPath</p>
<hr />
<h3 id="protocolhandlers">protocolHandlers<a class="headerlink" href="#protocolhandlers" title="Permanent link">#</a></h3>
<p>• <strong>protocolHandlers</strong>: <a href="../../interfaces/Common.Types.ProtocolHandlerRegistration/"><code>ProtocolHandlerRegistration</code></a>[]</p>
@@ -1084,8 +1032,6 @@
<p>• <code>get</code> <strong>description</strong>(): <code>undefined</code> | <code>string</code></p>
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
<p><code>undefined</code> | <code>string</code></p>
<h4 id="implementation-of_4">Implementation of<a class="headerlink" href="#implementation-of_4" title="Permanent link">#</a></h4>
<p>LegacyLensExtension.description</p>
<hr />
<h3 id="isenabled">isEnabled<a class="headerlink" href="#isenabled" title="Permanent link">#</a></h3>
<p>• <code>get</code> <strong>isEnabled</strong>(): <code>boolean</code></p>
@@ -1096,50 +1042,36 @@
<p>• <code>get</code> <strong>name</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="implementation-of_5">Implementation of<a class="headerlink" href="#implementation-of_5" title="Permanent link">#</a></h4>
<p>LegacyLensExtension.name</p>
<hr />
<h3 id="sanitizedextensionid">sanitizedExtensionId<a class="headerlink" href="#sanitizedextensionid" title="Permanent link">#</a></h3>
<p>• <code>get</code> <strong>sanitizedExtensionId</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="implementation-of_6">Implementation of<a class="headerlink" href="#implementation-of_6" title="Permanent link">#</a></h4>
<p>LegacyLensExtension.sanitizedExtensionId</p>
<hr />
<h3 id="storename">storeName<a class="headerlink" href="#storename" title="Permanent link">#</a></h3>
<p>• <code>get</code> <strong>storeName</strong>(): <code>string</code></p>
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
<p><code>string</code></p>
<h4 id="implementation-of_7">Implementation of<a class="headerlink" href="#implementation-of_7" title="Permanent link">#</a></h4>
<p>LegacyLensExtension.storeName</p>
<hr />
<h3 id="version">version<a class="headerlink" href="#version" title="Permanent link">#</a></h3>
<p>• <code>get</code> <strong>version</strong>(): <code>string</code></p>
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
<p><code>string</code></p>
<h4 id="implementation-of_8">Implementation of<a class="headerlink" href="#implementation-of_8" title="Permanent link">#</a></h4>
<p>LegacyLensExtension.version</p>
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
<h3 id="activate">activate<a class="headerlink" href="#activate" title="Permanent link">#</a></h3>
<p>▸ <strong>activate</strong>(): <code>Promise</code>&lt;<code>void</code>></p>
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
<p><code>Promise</code>&lt;<code>void</code>></p>
<h4 id="implementation-of_9">Implementation of<a class="headerlink" href="#implementation-of_9" title="Permanent link">#</a></h4>
<p>LegacyLensExtension.activate</p>
<hr />
<h3 id="disable">disable<a class="headerlink" href="#disable" title="Permanent link">#</a></h3>
<p>▸ <strong>disable</strong>(): <code>Promise</code>&lt;<code>void</code>></p>
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h4>
<p><code>Promise</code>&lt;<code>void</code>></p>
<h4 id="implementation-of_10">Implementation of<a class="headerlink" href="#implementation-of_10" title="Permanent link">#</a></h4>
<p>LegacyLensExtension.disable</p>
<hr />
<h3 id="enable">enable<a class="headerlink" href="#enable" title="Permanent link">#</a></h3>
<p>▸ <strong>enable</strong>(): <code>Promise</code>&lt;<code>void</code>></p>
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
<p><code>Promise</code>&lt;<code>void</code>></p>
<h4 id="implementation-of_11">Implementation of<a class="headerlink" href="#implementation-of_11" title="Permanent link">#</a></h4>
<p>LegacyLensExtension.enable</p>
<hr />
<h3 id="getextensionfilefolder">getExtensionFileFolder<a class="headerlink" href="#getextensionfilefolder" title="Permanent link">#</a></h3>
<p>▸ <strong>getExtensionFileFolder</strong>(): <code>Promise</code>&lt;<code>string</code>></p>
@@ -1149,8 +1081,6 @@ folder is for the sole use of this extension.</p>
folder name.</p>
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
<p><code>Promise</code>&lt;<code>string</code>></p>
<h4 id="implementation-of_12">Implementation of<a class="headerlink" href="#implementation-of_12" title="Permanent link">#</a></h4>
<p>LegacyLensExtension.getExtensionFileFolder</p>
<hr />
<h3 id="onactivate">onActivate<a class="headerlink" href="#onactivate" title="Permanent link">#</a></h3>
<p>▸ <code>Protected</code> <strong>onActivate</strong>(): <code>void</code> | <code>Promise</code>&lt;<code>void</code>></p>
@@ -963,7 +963,7 @@
</table>
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
<h3 id="extension">extension<a class="headerlink" href="#extension" title="Permanent link">#</a></h3>
<p>• <code>Protected</code> <code>Optional</code> <strong>extension</strong>: <a href="../Common.LensExtension/"><code>LensExtension</code></a>&lt;<code>LensExtensionDependencies</code>></p>
<p>• <code>Protected</code> <code>Optional</code> <strong>extension</strong>: <a href="../Common.LensExtension/"><code>LensExtension</code></a></p>
<hr />
<h3 id="persistentstorage">persistentStorage<a class="headerlink" href="#persistentstorage" title="Permanent link">#</a></h3>
<p>• <code>Protected</code> <code>Optional</code> <strong>persistentStorage</strong>: <code>PersistentStorage</code></p>
@@ -1016,7 +1016,7 @@
<tbody>
<tr>
<td align="left"><code>extension</code></td>
<td align="left"><a href="../Common.LensExtension/"><code>LensExtension</code></a>&lt;<code>LensExtensionDependencies</code>></td>
<td align="left"><a href="../Common.LensExtension/"><code>LensExtension</code></a></td>
</tr>
</tbody>
</table>
@@ -921,7 +921,7 @@
<p>IpcRegistrar.__@IpcPrefix@5718</p>
<hr />
<h3 id="extension">extension<a class="headerlink" href="#extension" title="Permanent link">#</a></h3>
<p>• <code>Protected</code> <code>Readonly</code> <strong>extension</strong>: <a href="../Common.LensExtension/"><code>LensExtension</code></a>&lt;<code>LensExtensionDependencies</code>></p>
<p>• <code>Protected</code> <code>Readonly</code> <strong>extension</strong>: <a href="../Common.LensExtension/"><code>LensExtension</code></a></p>
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
<p>IpcRegistrar.extension</p>
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
@@ -997,7 +997,7 @@
<p><a href="../../modules/Main/">Main</a>.LensExtension</p>
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
<ul>
<li><a href="../Common.LensExtension/"><code>LensExtension</code></a>&lt;<code>LensMainExtensionDependencies</code>></li>
<li><a href="../Common.LensExtension/"><code>LensExtension</code></a></li>
</ul>
<p>↳ <strong><code>LensExtension</code></strong></p>
<h2 id="table-of-contents">Table of contents<a class="headerlink" href="#table-of-contents" title="Permanent link">#</a></h2>
@@ -1039,7 +1039,7 @@
</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>• <strong>new LensExtension</strong>(<code>«destructured»</code>)</p>
<p>• <strong>new LensExtension</strong>(<code>extension</code>)</p>
<h4 id="parameters">Parameters<a class="headerlink" href="#parameters" title="Permanent link">#</a></h4>
<table>
<thead>
@@ -1050,12 +1050,12 @@
</thead>
<tbody>
<tr>
<td align="left"><code>«destructured»</code></td>
<td align="left"><code>extension</code></td>
<td align="left"><a href="../../modules/Common/#installedextension"><code>InstalledExtension</code></a></td>
</tr>
</tbody>
</table>
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
<p><a href="../Common.LensExtension/">LensExtension</a>.<a href="../Common.LensExtension/#constructor">constructor</a></p>
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
<h3 id="appmenus">appMenus<a class="headerlink" href="#appmenus" title="Permanent link">#</a></h3>
@@ -1063,27 +1063,27 @@
<hr />
<h3 id="id">id<a class="headerlink" href="#id" title="Permanent link">#</a></h3>
<p>• <code>Readonly</code> <strong>id</strong>: <code>string</code></p>
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
<p><a href="../Common.LensExtension/">LensExtension</a>.<a href="../Common.LensExtension/#id">id</a></p>
<hr />
<h3 id="isbundled">isBundled<a class="headerlink" href="#isbundled" title="Permanent link">#</a></h3>
<p>• <code>Readonly</code> <strong>isBundled</strong>: <code>boolean</code></p>
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
<p><a href="../Common.LensExtension/">LensExtension</a>.<a href="../Common.LensExtension/#isbundled">isBundled</a></p>
<hr />
<h3 id="manifest">manifest<a class="headerlink" href="#manifest" title="Permanent link">#</a></h3>
<p>• <code>Readonly</code> <strong>manifest</strong>: <a href="../../interfaces/Common.LensExtensionManifest/"><code>LensExtensionManifest</code></a></p>
<h4 id="inherited-from_3">Inherited from<a class="headerlink" href="#inherited-from_3" title="Permanent link">#</a></h4>
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
<p><a href="../Common.LensExtension/">LensExtension</a>.<a href="../Common.LensExtension/#manifest">manifest</a></p>
<hr />
<h3 id="manifestpath">manifestPath<a class="headerlink" href="#manifestpath" title="Permanent link">#</a></h3>
<p>• <code>Readonly</code> <strong>manifestPath</strong>: <code>string</code></p>
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" 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><a href="../Common.LensExtension/">LensExtension</a>.<a href="../Common.LensExtension/#manifestpath">manifestPath</a></p>
<hr />
<h3 id="protocolhandlers">protocolHandlers<a class="headerlink" href="#protocolhandlers" title="Permanent link">#</a></h3>
<p>• <strong>protocolHandlers</strong>: <a href="../../interfaces/Common.Types.ProtocolHandlerRegistration/"><code>ProtocolHandlerRegistration</code></a>[]</p>
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" 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><a href="../Common.LensExtension/">LensExtension</a>.<a href="../Common.LensExtension/#protocolhandlers">protocolHandlers</a></p>
<hr />
<h3 id="terminalshellenvmodifier">terminalShellEnvModifier<a class="headerlink" href="#terminalshellenvmodifier" title="Permanent link">#</a></h3>
@@ -1103,49 +1103,49 @@ cluster-specific information that can be made available in the shell environment
<p>• <code>get</code> <strong>description</strong>(): <code>undefined</code> | <code>string</code></p>
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
<p><code>undefined</code> | <code>string</code></p>
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
<p>LensExtension.description</p>
<hr />
<h3 id="isenabled">isEnabled<a class="headerlink" href="#isenabled" title="Permanent link">#</a></h3>
<p>• <code>get</code> <strong>isEnabled</strong>(): <code>boolean</code></p>
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
<p><code>boolean</code></p>
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
<p>LensExtension.isEnabled</p>
<hr />
<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_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
<p><code>string</code></p>
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
<p>LensExtension.name</p>
<hr />
<h3 id="sanitizedextensionid">sanitizedExtensionId<a class="headerlink" href="#sanitizedextensionid" title="Permanent link">#</a></h3>
<p>• <code>get</code> <strong>sanitizedExtensionId</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_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
<p>LensExtension.sanitizedExtensionId</p>
<hr />
<h3 id="storename">storeName<a class="headerlink" href="#storename" title="Permanent link">#</a></h3>
<p>• <code>get</code> <strong>storeName</strong>(): <code>string</code></p>
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
<p><code>string</code></p>
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
<p>LensExtension.storeName</p>
<hr />
<h3 id="version">version<a class="headerlink" href="#version" title="Permanent link">#</a></h3>
<p>• <code>get</code> <strong>version</strong>(): <code>string</code></p>
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
<p><code>string</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_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
<p>LensExtension.version</p>
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
<h3 id="activate">activate<a class="headerlink" href="#activate" title="Permanent link">#</a></h3>
<p>▸ <strong>activate</strong>(): <code>Promise</code>&lt;<code>void</code>></p>
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
<p><code>Promise</code>&lt;<code>void</code>></p>
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
<p><a href="../Common.LensExtension/">LensExtension</a>.<a href="../Common.LensExtension/#activate">activate</a></p>
<hr />
<h3 id="addcatalogsource">addCatalogSource<a class="headerlink" href="#addcatalogsource" title="Permanent link">#</a></h3>
@@ -1176,14 +1176,14 @@ cluster-specific information that can be made available in the shell environment
<p>▸ <strong>disable</strong>(): <code>Promise</code>&lt;<code>void</code>></p>
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
<p><code>Promise</code>&lt;<code>void</code>></p>
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
<p><a href="../Common.LensExtension/">LensExtension</a>.<a href="../Common.LensExtension/#disable">disable</a></p>
<hr />
<h3 id="enable">enable<a class="headerlink" href="#enable" title="Permanent link">#</a></h3>
<p>▸ <strong>enable</strong>(): <code>Promise</code>&lt;<code>void</code>></p>
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
<p><code>Promise</code>&lt;<code>void</code>></p>
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
<p><a href="../Common.LensExtension/">LensExtension</a>.<a href="../Common.LensExtension/#enable">enable</a></p>
<hr />
<h3 id="getextensionfilefolder">getExtensionFileFolder<a class="headerlink" href="#getextensionfilefolder" title="Permanent link">#</a></h3>
@@ -1194,7 +1194,7 @@ folder is for the sole use of this extension.</p>
folder name.</p>
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
<p><code>Promise</code>&lt;<code>string</code>></p>
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
<p><a href="../Common.LensExtension/">LensExtension</a>.<a href="../Common.LensExtension/#getextensionfilefolder">getExtensionFileFolder</a></p>
<hr />
<h3 id="navigate">navigate<a class="headerlink" href="#navigate" title="Permanent link">#</a></h3>
@@ -1229,14 +1229,14 @@ folder name.</p>
<p>▸ <code>Protected</code> <strong>onActivate</strong>(): <code>void</code> | <code>Promise</code>&lt;<code>void</code>></p>
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
<p><code>void</code> | <code>Promise</code>&lt;<code>void</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_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
<p><a href="../Common.LensExtension/">LensExtension</a>.<a href="../Common.LensExtension/#onactivate">onActivate</a></p>
<hr />
<h3 id="ondeactivate">onDeactivate<a class="headerlink" href="#ondeactivate" title="Permanent link">#</a></h3>
<p>▸ <code>Protected</code> <strong>onDeactivate</strong>(): <code>void</code> | <code>Promise</code>&lt;<code>void</code>></p>
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
<p><code>void</code> | <code>Promise</code>&lt;<code>void</code>></p>
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
<p><a href="../Common.LensExtension/">LensExtension</a>.<a href="../Common.LensExtension/#ondeactivate">onDeactivate</a></p>
<hr />
<h3 id="removecatalogsource">removeCatalogSource<a class="headerlink" href="#removecatalogsource" title="Permanent link">#</a></h3>
@@ -921,7 +921,7 @@
<p>IpcRegistrar.__@IpcPrefix@5718</p>
<hr />
<h3 id="extension">extension<a class="headerlink" href="#extension" title="Permanent link">#</a></h3>
<p>• <code>Protected</code> <code>Readonly</code> <strong>extension</strong>: <a href="../Common.LensExtension/"><code>LensExtension</code></a>&lt;<code>LensExtensionDependencies</code>></p>
<p>• <code>Protected</code> <code>Readonly</code> <strong>extension</strong>: <a href="../Common.LensExtension/"><code>LensExtension</code></a></p>
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
<p>IpcRegistrar.extension</p>
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
@@ -1123,7 +1123,7 @@
<p><a href="../../modules/Renderer/">Renderer</a>.LensExtension</p>
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
<ul>
<li><a href="../Common.LensExtension/"><code>LensExtension</code></a>&lt;<code>LensRendererExtensionDependencies</code>></li>
<li><a href="../Common.LensExtension/"><code>LensExtension</code></a></li>
</ul>
<p>↳ <strong><code>LensExtension</code></strong></p>
<h2 id="table-of-contents">Table of contents<a class="headerlink" href="#table-of-contents" title="Permanent link">#</a></h2>
@@ -1183,7 +1183,7 @@
</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>• <strong>new LensExtension</strong>(<code>«destructured»</code>)</p>
<p>• <strong>new LensExtension</strong>(<code>extension</code>)</p>
<h4 id="parameters">Parameters<a class="headerlink" href="#parameters" title="Permanent link">#</a></h4>
<table>
<thead>
@@ -1194,12 +1194,12 @@
</thead>
<tbody>
<tr>
<td align="left"><code>«destructured»</code></td>
<td align="left"><code>extension</code></td>
<td align="left"><a href="../../modules/Common/#installedextension"><code>InstalledExtension</code></a></td>
</tr>
</tbody>
</table>
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
<p><a href="../Common.LensExtension/">LensExtension</a>.<a href="../Common.LensExtension/#constructor">constructor</a></p>
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
<h3 id="additionalcategorycolumns">additionalCategoryColumns<a class="headerlink" href="#additionalcategorycolumns" title="Permanent link">#</a></h3>
@@ -1237,12 +1237,12 @@
<hr />
<h3 id="id">id<a class="headerlink" href="#id" title="Permanent link">#</a></h3>
<p>• <code>Readonly</code> <strong>id</strong>: <code>string</code></p>
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
<p><a href="../Common.LensExtension/">LensExtension</a>.<a href="../Common.LensExtension/#id">id</a></p>
<hr />
<h3 id="isbundled">isBundled<a class="headerlink" href="#isbundled" title="Permanent link">#</a></h3>
<p>• <code>Readonly</code> <strong>isBundled</strong>: <code>boolean</code></p>
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
<p><a href="../Common.LensExtension/">LensExtension</a>.<a href="../Common.LensExtension/#isbundled">isBundled</a></p>
<hr />
<h3 id="kubeobjectdetailitems">kubeObjectDetailItems<a class="headerlink" href="#kubeobjectdetailitems" title="Permanent link">#</a></h3>
@@ -1262,17 +1262,17 @@
<hr />
<h3 id="manifest">manifest<a class="headerlink" href="#manifest" title="Permanent link">#</a></h3>
<p>• <code>Readonly</code> <strong>manifest</strong>: <a href="../../interfaces/Common.LensExtensionManifest/"><code>LensExtensionManifest</code></a></p>
<h4 id="inherited-from_3">Inherited from<a class="headerlink" href="#inherited-from_3" title="Permanent link">#</a></h4>
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
<p><a href="../Common.LensExtension/">LensExtension</a>.<a href="../Common.LensExtension/#manifest">manifest</a></p>
<hr />
<h3 id="manifestpath">manifestPath<a class="headerlink" href="#manifestpath" title="Permanent link">#</a></h3>
<p>• <code>Readonly</code> <strong>manifestPath</strong>: <code>string</code></p>
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" 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><a href="../Common.LensExtension/">LensExtension</a>.<a href="../Common.LensExtension/#manifestpath">manifestPath</a></p>
<hr />
<h3 id="protocolhandlers">protocolHandlers<a class="headerlink" href="#protocolhandlers" title="Permanent link">#</a></h3>
<p>• <strong>protocolHandlers</strong>: <a href="../../interfaces/Common.Types.ProtocolHandlerRegistration/"><code>ProtocolHandlerRegistration</code></a>[]</p>
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" 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><a href="../Common.LensExtension/">LensExtension</a>.<a href="../Common.LensExtension/#protocolhandlers">protocolHandlers</a></p>
<hr />
<h3 id="statusbaritems">statusBarItems<a class="headerlink" href="#statusbaritems" title="Permanent link">#</a></h3>
@@ -1291,49 +1291,49 @@
<p>• <code>get</code> <strong>description</strong>(): <code>undefined</code> | <code>string</code></p>
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
<p><code>undefined</code> | <code>string</code></p>
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
<p>LensExtension.description</p>
<hr />
<h3 id="isenabled">isEnabled<a class="headerlink" href="#isenabled" title="Permanent link">#</a></h3>
<p>• <code>get</code> <strong>isEnabled</strong>(): <code>boolean</code></p>
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
<p><code>boolean</code></p>
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
<p>LensExtension.isEnabled</p>
<hr />
<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_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
<p><code>string</code></p>
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
<p>LensExtension.name</p>
<hr />
<h3 id="sanitizedextensionid">sanitizedExtensionId<a class="headerlink" href="#sanitizedextensionid" title="Permanent link">#</a></h3>
<p>• <code>get</code> <strong>sanitizedExtensionId</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_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
<p>LensExtension.sanitizedExtensionId</p>
<hr />
<h3 id="storename">storeName<a class="headerlink" href="#storename" title="Permanent link">#</a></h3>
<p>• <code>get</code> <strong>storeName</strong>(): <code>string</code></p>
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
<p><code>string</code></p>
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
<p>LensExtension.storeName</p>
<hr />
<h3 id="version">version<a class="headerlink" href="#version" title="Permanent link">#</a></h3>
<p>• <code>get</code> <strong>version</strong>(): <code>string</code></p>
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
<p><code>string</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_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
<p>LensExtension.version</p>
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
<h3 id="activate">activate<a class="headerlink" href="#activate" title="Permanent link">#</a></h3>
<p>▸ <strong>activate</strong>(): <code>Promise</code>&lt;<code>void</code>></p>
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
<p><code>Promise</code>&lt;<code>void</code>></p>
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
<p><a href="../Common.LensExtension/">LensExtension</a>.<a href="../Common.LensExtension/#activate">activate</a></p>
<hr />
<h3 id="addcatalogcategoryfilter">addCatalogCategoryFilter<a class="headerlink" href="#addcatalogcategoryfilter" title="Permanent link">#</a></h3>
@@ -1388,14 +1388,14 @@
<p>▸ <strong>disable</strong>(): <code>Promise</code>&lt;<code>void</code>></p>
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
<p><code>Promise</code>&lt;<code>void</code>></p>
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
<p><a href="../Common.LensExtension/">LensExtension</a>.<a href="../Common.LensExtension/#disable">disable</a></p>
<hr />
<h3 id="enable">enable<a class="headerlink" href="#enable" title="Permanent link">#</a></h3>
<p>▸ <strong>enable</strong>(): <code>Promise</code>&lt;<code>void</code>></p>
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
<p><code>Promise</code>&lt;<code>void</code>></p>
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
<p><a href="../Common.LensExtension/">LensExtension</a>.<a href="../Common.LensExtension/#enable">enable</a></p>
<hr />
<h3 id="getextensionfilefolder">getExtensionFileFolder<a class="headerlink" href="#getextensionfilefolder" title="Permanent link">#</a></h3>
@@ -1406,7 +1406,7 @@ folder is for the sole use of this extension.</p>
folder name.</p>
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
<p><code>Promise</code>&lt;<code>string</code>></p>
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
<p><a href="../Common.LensExtension/">LensExtension</a>.<a href="../Common.LensExtension/#getextensionfilefolder">getExtensionFileFolder</a></p>
<hr />
<h3 id="isenabledforcluster">isEnabledForCluster<a class="headerlink" href="#isenabledforcluster" title="Permanent link">#</a></h3>
@@ -1462,14 +1462,14 @@ called when the extension is created within a cluster frame.</p>
<p>▸ <code>Protected</code> <strong>onActivate</strong>(): <code>void</code> | <code>Promise</code>&lt;<code>void</code>></p>
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
<p><code>void</code> | <code>Promise</code>&lt;<code>void</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_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
<p><a href="../Common.LensExtension/">LensExtension</a>.<a href="../Common.LensExtension/#onactivate">onActivate</a></p>
<hr />
<h3 id="ondeactivate">onDeactivate<a class="headerlink" href="#ondeactivate" title="Permanent link">#</a></h3>
<p>▸ <code>Protected</code> <strong>onDeactivate</strong>(): <code>void</code> | <code>Promise</code>&lt;<code>void</code>></p>
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
<p><code>void</code> | <code>Promise</code>&lt;<code>void</code>></p>
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
<p><a href="../Common.LensExtension/">LensExtension</a>.<a href="../Common.LensExtension/#ondeactivate">onDeactivate</a></p>
@@ -743,6 +743,13 @@
className
</a>
</li>
<li class="md-nav__item">
<a href="#data-testid" class="md-nav__link">
data-testid
</a>
</li>
<li class="md-nav__item">
@@ -779,12 +786,16 @@
<h3 id="properties">Properties<a class="headerlink" href="#properties" title="Permanent link">#</a></h3>
<ul>
<li><a href="./#classname">className</a></li>
<li><a href="./#data-testid">data-testid</a></li>
<li><a href="./#title">title</a></li>
</ul>
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
<h3 id="classname">className<a class="headerlink" href="#classname" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>className</strong>: <code>string</code></p>
<hr />
<h3 id="data-testid">data-testid<a class="headerlink" href="#data-testid" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>data-testid</strong>: <code>string</code></p>
<hr />
<h3 id="title">title<a class="headerlink" href="#title" title="Permanent link">#</a></h3>
<p>• <strong>title</strong>: <code>string</code></p>
@@ -778,6 +778,13 @@
className
</a>
</li>
<li class="md-nav__item">
<a href="#data-testid" class="md-nav__link">
data-testid
</a>
</li>
<li class="md-nav__item">
@@ -876,6 +883,7 @@
<li><a href="./#_sorting">_sorting</a></li>
<li><a href="./#checkbox">checkbox</a></li>
<li><a href="./#classname">className</a></li>
<li><a href="./#data-testid">data-testid</a></li>
<li><a href="./#id">id</a></li>
<li><a href="./#ischecked">isChecked</a></li>
<li><a href="./#scrollable">scrollable</a></li>
@@ -903,6 +911,10 @@
<p>• <code>Optional</code> <strong>className</strong>: <code>string</code></p>
<p>Any css class names for this table cell. Only used if <code>title</code> is a "simple" react node</p>
<hr />
<h3 id="data-testid">data-testid<a class="headerlink" href="#data-testid" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>data-testid</strong>: <code>string</code></p>
<p>For passing in the testid</p>
<hr />
<h3 id="id">id<a class="headerlink" href="#id" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>id</strong>: <code>string</code></p>
<p>used for configuration visibility of columns</p>
+1 -1
View File
@@ -1 +1 @@
{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Lens Extension API","text":"<p>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.</p> <p>This documentation describes:</p> <ul> <li>How to build, run, test, and publish an extension.</li> <li>How to take full advantage of the Lens Extension API.</li> <li>Where to find guides and code samples to help get you started.</li> </ul>"},{"location":"#what-extensions-can-do","title":"What Extensions Can Do","text":"<p>Here are some examples of what you can achieve with the Extension API:</p> <ul> <li>Add custom components &amp; views in the UI - Extending the Lens Workbench</li> </ul> <p>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.</p>"},{"location":"#how-to-build-extensions","title":"How to Build Extensions","text":"<p>Here is what each section of the Lens Extension API docs can help you with:</p> <ul> <li>Getting Started teaches fundamental concepts for building extensions with the Hello World sample.</li> <li>Extension Capabilities dissects Lens's Extension API into smaller categories and points you to more detailed topics.</li> <li>Extension Guides includes guides and code samples that explain specific usages of Lens Extension API.</li> <li>Testing and Publishing includes in-depth guides on various extension development topics, such as testing and publishing extensions.</li> <li>API Reference contains exhaustive references for the Lens Extension API, Contribution Points, and many other topics.</li> </ul>"},{"location":"#whats-new","title":"What's New","text":"<p>Just like Lens itself, the extension API updates on a monthly cadence, rolling out new features with every release.</p> <p>Keep up with Lens and the Lens Extension API by reviewing the release notes.</p>"},{"location":"#important-changes-since-lens-v4","title":"Important changes since Lens v4","text":"<p>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.</p>"},{"location":"#looking-for-help","title":"Looking for Help","text":"<p>If you have questions for extension development, try asking on the Lens Forums. It's a public chatroom for Lens developers, where Lens team members chime in from time to time.</p> <p>To provide feedback on the documentation or issues with the Lens Extension API, create new issues at lensapp/lens. Please use the labels <code>area/documentation</code> and/or <code>area/extension</code>.</p>"},{"location":"#downloading-lens","title":"Downloading Lens","text":"<p>Download Lens for macOS, Windows, or Linux.</p>"},{"location":"architecture/decisions/","title":"Architecture Decision Records","text":""},{"location":"extensions/extension-migration/","title":"Lens v4 to v5 Extension Migration Notes","text":"<ul> <li>Lens v5 inspects the version of the extension to ensure it is compatible. The <code>package.json</code> for your extension must have an <code>\"engines\"</code> field specifying the lens version that your extension is targeted for, e.g: <pre><code> \"engines\": {\n \"lens\": \"^5.0.0-beta.7\"\n },\n</code></pre> Note that Lens v5 supports all the range semantics that semver provides.</li> <li>Types and components have been reorganized, many have been grouped by process (<code>Main</code> and <code>Renderer</code>) plus those not specific to a process (<code>Common</code>). For example the <code>LensMainExtension</code> class is now referred to by <code>Main.LensExtension</code>. See the API Reference for the new organization.</li> <li>The <code>globalPageMenus</code> field of the Renderer extension class (now <code>Renderer.LensExtension</code>) is removed. Global pages can still be made accessible via the application menus and the status bar, as well as from the newly added Welcome menu.</li> <li>The <code>clusterFeatures</code> field of the Renderer extension class (now <code>Renderer.LensExtension</code>) is removed. Cluster features can still be implemented but Lens no longer dictates how a feature's lifecycle (install/upgrade/uninstall) isLine truncated
{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Lens Extension API","text":"<p>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.</p> <p>This documentation describes:</p> <ul> <li>How to build, run, test, and publish an extension.</li> <li>How to take full advantage of the Lens Extension API.</li> <li>Where to find guides and code samples to help get you started.</li> </ul>"},{"location":"#what-extensions-can-do","title":"What Extensions Can Do","text":"<p>Here are some examples of what you can achieve with the Extension API:</p> <ul> <li>Add custom components &amp; views in the UI - Extending the Lens Workbench</li> </ul> <p>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.</p>"},{"location":"#how-to-build-extensions","title":"How to Build Extensions","text":"<p>Here is what each section of the Lens Extension API docs can help you with:</p> <ul> <li>Getting Started teaches fundamental concepts for building extensions with the Hello World sample.</li> <li>Extension Capabilities dissects Lens's Extension API into smaller categories and points you to more detailed topics.</li> <li>Extension Guides includes guides and code samples that explain specific usages of Lens Extension API.</li> <li>Testing and Publishing includes in-depth guides on various extension development topics, such as testing and publishing extensions.</li> <li>API Reference contains exhaustive references for the Lens Extension API, Contribution Points, and many other topics.</li> </ul>"},{"location":"#whats-new","title":"What's New","text":"<p>Just like Lens itself, the extension API updates on a monthly cadence, rolling out new features with every release.</p> <p>Keep up with Lens and the Lens Extension API by reviewing the release notes.</p>"},{"location":"#important-changes-since-lens-v4","title":"Important changes since Lens v4","text":"<p>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.</p>"},{"location":"#looking-for-help","title":"Looking for Help","text":"<p>If you have questions for extension development, try asking on the Lens Forums. It's a public chatroom for Lens developers, where Lens team members chime in from time to time.</p> <p>To provide feedback on the documentation or issues with the Lens Extension API, create new issues at lensapp/lens. Please use the labels <code>area/documentation</code> and/or <code>area/extension</code>.</p>"},{"location":"#downloading-lens","title":"Downloading Lens","text":"<p>Download Lens for macOS, Windows, or Linux.</p>"},{"location":"architecture/decisions/","title":"Architecture Decision Records","text":""},{"location":"extensions/extension-migration/","title":"Lens v4 to v5 Extension Migration Notes","text":"<ul> <li>Lens v5 inspects the version of the extension to ensure it is compatible. The <code>package.json</code> for your extension must have an <code>\"engines\"</code> field specifying the lens version that your extension is targeted for, e.g: <pre><code> \"engines\": {\n \"lens\": \"^5.0.0-beta.7\"\n },\n</code></pre> Note that Lens v5 supports all the range semantics that semver provides.</li> <li>Types and components have been reorganized, many have been grouped by process (<code>Main</code> and <code>Renderer</code>) plus those not specific to a process (<code>Common</code>). For example the <code>LensMainExtension</code> class is now referred to by <code>Main.LensExtension</code>. See the API Reference for the new organization.</li> <li>The <code>globalPageMenus</code> field of the Renderer extension class (now <code>Renderer.LensExtension</code>) is removed. Global pages can still be made accessible via the application menus and the status bar, as well as from the newly added Welcome menu.</li> <li>The <code>clusterFeatures</code> field of the Renderer extension class (now <code>Renderer.LensExtension</code>) is removed. Cluster features can still be implemented but Lens no longer dictates how a feature's lifecycle (install/upgrade/uninstall) isLine truncated
+310 -310
View File
File diff suppressed because it is too large. Load diff
Binary file not shown.