Deployed 411b9a9a88 to master with MkDocs 1.2.3 and mike 1.1.2

This commit is contained in:
GitHub Action committed 2022-01-19 15:31:44 +00:00
1 parent cafbc64c83
commit aa19d970b7
18 files changed
+2191 -43

No files matched your search

@@ -1030,37 +1030,53 @@
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
<h3 id="apiversion">apiVersion<a class="headerlink" href="#apiversion" title="Permanent link">#</a></h3>
<p>• <code>Readonly</code> <code>Abstract</code> <strong>apiVersion</strong>: <code>string</code></p>
<p>The version of category that you are wanting to declare.</p>
<p>Currently supported values:</p>
<ul>
<li><code>"catalog.k8slens.dev/v1alpha1"</code></li>
</ul>
<hr />
<h3 id="filters">filters<a class="headerlink" href="#filters" title="Permanent link">#</a></h3>
<p>• <code>Protected</code> <strong>filters</strong>: <code>ObservableSet</code>&lt;<a href="../../modules/Common.Catalog/#addmenufilter"><code>AddMenuFilter</code></a>></p>
<p><strong><code>internal</code></strong></p>
<hr />
<h3 id="kind">kind<a class="headerlink" href="#kind" title="Permanent link">#</a></h3>
<p>• <code>Readonly</code> <code>Abstract</code> <strong>kind</strong>: <code>string</code></p>
<p>The kind of item you wish to declare.</p>
<p>Currently supported values:</p>
<ul>
<li><code>"CatalogCategory"</code></li>
</ul>
<hr />
<h3 id="metadata">metadata<a class="headerlink" href="#metadata" title="Permanent link">#</a></h3>
<p>• <code>Abstract</code> <strong>metadata</strong>: <code>Object</code></p>
<p>• <code>Readonly</code> <code>Abstract</code> <strong>metadata</strong>: <code>Object</code></p>
<p>The data about the category itself</p>
<h4 id="type-declaration">Type declaration<a class="headerlink" href="#type-declaration" 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>icon</code></td>
<td align="left"><code>string</code></td>
<td align="left">Either an <code>&lt;svg&gt;</code> or the name of an icon from <a href="../../interfaces/Renderer.Component.IconProps/">IconProps</a></td>
</tr>
<tr>
<td align="left"><code>name</code></td>
<td align="left"><code>string</code></td>
<td align="left">The name of your category. The category can be searched for by this value. This will also be used for the catalog menu.</td>
</tr>
</tbody>
</table>
<hr />
<h3 id="spec">spec<a class="headerlink" href="#spec" title="Permanent link">#</a></h3>
<p>• <code>Abstract</code> <strong>spec</strong>: <a href="../../interfaces/Common.Catalog.CatalogCategorySpec/"><code>CatalogCategorySpec</code></a></p>
<p>The most important part of a category, as it is where entity versions are declared.</p>
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
<h3 id="addlistener">addListener<a class="headerlink" href="#addlistener" title="Permanent link">#</a></h3>
<p>▸ <strong>addListener</strong>&lt;<code>E</code>>(<code>event</code>, <code>listener</code>): <a href="./"><code>CatalogCategory</code></a></p>
@@ -1201,6 +1217,7 @@
<hr />
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
<p>▸ <strong>getId</strong>(): <code>string</code></p>
<p>Get the ID of this category</p>
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
<p><code>string</code></p>
<hr />
@@ -1628,26 +1645,28 @@
<p>(EventEmitter as new () => TypedEmitter&lt;CatalogCategoryEvents>).setMaxListeners</p>
<hr />
<h3 id="parseid">parseId<a class="headerlink" href="#parseid" title="Permanent link">#</a></h3>
<p>▸ <code>Static</code> <strong>parseId</strong>(<code>id?</code>): <code>Object</code></p>
<p>▸ <code>Static</code> <strong>parseId</strong>(<code>id</code>): <code>Object</code></p>
<p>Parse a category ID into parts.</p>
<h4 id="parameters_15">Parameters<a class="headerlink" href="#parameters_15" title="Permanent link">#</a></h4>
<table>
<thead>
<tr>
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Default value</th>
<th align="left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>id</code></td>
<td align="left"><code>string</code></td>
<td align="left"><code>""</code></td>
<td align="left">The id of a category is parse</td>
</tr>
</tbody>
</table>
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
<p><code>Object</code></p>
<p>The group and kind parts of the ID</p>
<table>
<thead>
<tr>
@@ -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@45477</p>
<p>IpcRegistrar.__@IpcPrefix@45552</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></p>
@@ -1053,7 +1053,7 @@
<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@21134</p>
<p>LensExtension.__@Disposers@30890</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>
@@ -1134,7 +1134,7 @@
<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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
<p>LensExtension.__@setLensExtensionDependencies@21138</p>
<p>LensExtension.__@setLensExtensionDependencies@30893</p>
<hr />
<h3 id="activate">activate<a class="headerlink" href="#activate" title="Permanent link">#</a></h3>
<p>▸ <strong>activate</strong>(): <code>void</code> | <code>Promise</code>&lt;<code>void</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@45477</p>
<p>IpcRegistrar.__@IpcPrefix@45552</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></p>
@@ -792,6 +792,13 @@
[Disposers]
</a>
</li>
<li class="md-nav__item">
<a href="#additionalcategorycolumns" class="md-nav__link">
additionalCategoryColumns
</a>
</li>
<li class="md-nav__item">
@@ -1099,6 +1106,7 @@
<h3 id="properties">Properties<a class="headerlink" href="#properties" title="Permanent link">#</a></h3>
<ul>
<li><a href="./#[disposers]">[Disposers]</a></li>
<li><a href="./#additionalcategorycolumns">additionalCategoryColumns</a></li>
<li><a href="./#apppreferences">appPreferences</a></li>
<li><a href="./#catalogentitydetailitems">catalogEntityDetailItems</a></li>
<li><a href="./#clusterpagemenus">clusterPageMenus</a></li>
@@ -1165,7 +1173,10 @@
<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@21134</p>
<p>LensExtension.__@Disposers@30890</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>
<hr />
<h3 id="apppreferences">appPreferences<a class="headerlink" href="#apppreferences" title="Permanent link">#</a></h3>
<p>• <strong>appPreferences</strong>: <a href="../../interfaces/Common.Types.AppPreferenceRegistration/"><code>AppPreferenceRegistration</code></a>[] = <code>[]</code></p>
@@ -1285,7 +1296,7 @@
<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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
<p>LensExtension.__@setLensExtensionDependencies@21138</p>
<p>LensExtension.__@setLensExtensionDependencies@30893</p>
<hr />
<h3 id="activate">activate<a class="headerlink" href="#activate" title="Permanent link">#</a></h3>
<p>▸ <strong>activate</strong>(): <code>void</code> | <code>Promise</code>&lt;<code>void</code>></p>