hendrik/lens
1
0
Fork 0
mirror of https://github.com/lensapp/lens.git synced 2025-05-20 05:10:56 +00:00
Code Issues Projects Releases Wiki Activity

Deployed 411b9a9a88 to master with MkDocs 1.2.3 and mike 1.1.2

Browse Source
This commit is contained in:
GitHub Action 2022-01-19 15:31:44 +00:00
parent cafbc64c83
commit aa19d970b7
18 changed files with 2191 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
master/extensions/api/classes/Common.Catalog.CatalogCategory/index.html
View File

@ -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>

2
master/extensions/api/classes/Main.Ipc/index.html
View File

@ -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>

4
master/extensions/api/classes/Main.LensExtension/index.html
View File

@ -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>

2
master/extensions/api/classes/Renderer.Ipc/index.html
View File

@ -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>

15
master/extensions/api/classes/Renderer.LensExtension/index.html
View File

@ -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>

6
master/extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/index.html
View File

@ -791,6 +791,8 @@
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
<h3 id="catalogaddmenu">catalogAddMenu<a class="headerlink" href="#catalogaddmenu" title="Permanent link">#</a></h3>
<p>▸ <strong>catalogAddMenu</strong>(<code>context</code>): <code>void</code></p>
<p>This event will be emitted when the catalog add menu is opened and is the
way to added entries to that menu.</p>
<h4 id="parameters">Parameters<a class="headerlink" href="#parameters" title="Permanent link">#</a></h4>
<table>
<thead>
@ -811,6 +813,8 @@
<hr />
<h3 id="contextmenuopen">contextMenuOpen<a class="headerlink" href="#contextmenuopen" title="Permanent link">#</a></h3>
<p>▸ <strong>contextMenuOpen</strong>(<code>entity</code>, <code>context</code>): <code>void</code></p>
<p>This event will be emitted when the context menu for an entity is declared
by this category is opened.</p>
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
<table>
<thead>
@ -835,6 +839,8 @@
<hr />
<h3 id="load">load<a class="headerlink" href="#load" title="Permanent link">#</a></h3>
<p>▸ <strong>load</strong>(): <code>void</code></p>
<p>This event will be emitted when the category is loaded in the catalog
view.</p>
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
<p><code>void</code></p>

18
master/extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/index.html
View File

@ -739,6 +739,13 @@
<nav class="md-nav" aria-label="Properties">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#displaycolumns" class="md-nav__link">
displayColumns
</a>
</li>
<li class="md-nav__item">
<a href="#group" class="md-nav__link">
group
@ -784,17 +791,28 @@
<h2 id="table-of-contents">Table of contents<a class="headerlink" href="#table-of-contents" title="Permanent link">#</a></h2>
<h3 id="properties">Properties<a class="headerlink" href="#properties" title="Permanent link">#</a></h3>
<ul>
<li><a href="./#displaycolumns">displayColumns</a></li>
<li><a href="./#group">group</a></li>
<li><a href="./#names">names</a></li>
<li><a href="./#versions">versions</a></li>
</ul>
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
<h3 id="displaycolumns">displayColumns<a class="headerlink" href="#displaycolumns" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>displayColumns</strong>: <a href="../Renderer.Component.CategoryColumnRegistration/"><code>CategoryColumnRegistration</code></a>[]</p>
<p>These are the columns used for displaying entities when in the catalog.</p>
<p>If this is not provided then some default columns will be used, similar in
scope to the columns in the "Browse" view.</p>
<p>Even if you provide columns, a "Name" column will be provided as well with
<code>priority: 0</code>.</p>
<p>These columns will not be used in the "Browse" view.</p>
<hr />
<h3 id="group">group<a class="headerlink" href="#group" title="Permanent link">#</a></h3>
<p>• <strong>group</strong>: <code>string</code></p>
<p>The grouping for for the category. This MUST be a DNS label.</p>
<hr />
<h3 id="names">names<a class="headerlink" href="#names" title="Permanent link">#</a></h3>
<p>• <strong>names</strong>: <code>Object</code></p>
<p>This is the concerning the category</p>
<h4 id="type-declaration">Type declaration<a class="headerlink" href="#type-declaration" title="Permanent link">#</a></h4>
<table>
<thead>

1043
master/extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/index.html Normal file
View File

File diff suppressed because it is too large Load Diff

1002
master/extensions/api/interfaces/Renderer.Component.CategoryColumnRegistration/index.html Normal file
View File

File diff suppressed because it is too large Load Diff

13
master/extensions/api/interfaces/Renderer.Component.TableCellProps/index.html
View File

@ -2194,12 +2194,16 @@
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
<h3 id="_nowrap">_nowrap<a class="headerlink" href="#_nowrap" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>_nowrap</strong>: <code>boolean</code></p>
<p><strong><code>internal</code></strong>
indicator, might come from parent <TableHead>, don't use this prop outside (!)</p>
<hr />
<h3 id="_sorting">_sorting<a class="headerlink" href="#_sorting" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>_sorting</strong>: <code>Partial</code>&lt;<a href="../../modules/Renderer.Component/#tablesortparams"><code>TableSortParams</code></a>></p>
<p><strong><code>internal</code></strong></p>
<hr />
<h3 id="checkbox">checkbox<a class="headerlink" href="#checkbox" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>checkbox</strong>: <code>boolean</code></p>
<p>render cell with a checkbox</p>
<hr />
<h3 id="children">children<a class="headerlink" href="#children" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>children</strong>: <code>ReactNode</code></p>
@ -2208,6 +2212,7 @@
<hr />
<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>
<p>Any css class names for this table cell. Only used if <code>title</code> is a "simple" react node</p>
<hr />
<h3 id="dangerouslysetinnerhtml">dangerouslySetInnerHTML<a class="headerlink" href="#dangerouslysetinnerhtml" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>dangerouslySetInnerHTML</strong>: <code>Object</code></p>
@ -2231,9 +2236,11 @@
<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>
<hr />
<h3 id="ischecked">isChecked<a class="headerlink" href="#ischecked" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>isChecked</strong>: <code>boolean</code></p>
<p>mark checkbox as checked or not</p>
<hr />
<h3 id="onabort">onAbort<a class="headerlink" href="#onabort" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>onAbort</strong>: <code>ReactEventHandler</code>&lt;<code>HTMLDivElement</code>></p>
@ -3037,21 +3044,27 @@
<hr />
<h3 id="renderboolean">renderBoolean<a class="headerlink" href="#renderboolean" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>renderBoolean</strong>: <code>boolean</code></p>
<p>show "true" or "false" for all of the children elements are "typeof boolean"</p>
<hr />
<h3 id="scrollable">scrollable<a class="headerlink" href="#scrollable" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>scrollable</strong>: <code>boolean</code></p>
<p>content inside could be scrolled</p>
<hr />
<h3 id="showwithcolumn">showWithColumn<a class="headerlink" href="#showwithcolumn" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>showWithColumn</strong>: <code>string</code></p>
<p>id of the column which follow same visibility rules</p>
<hr />
<h3 id="sortby">sortBy<a class="headerlink" href="#sortby" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>sortBy</strong>: <code>string</code></p>
<p>column name, must be same as key in sortable object <Table sortable={}/></p>
<hr />
<h3 id="title">title<a class="headerlink" href="#title" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>title</strong>: <code>ReactNode</code></p>
<p>The actual value of the cell</p>
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
<h3 id="_sort">_sort<a class="headerlink" href="#_sort" title="Permanent link">#</a></h3>
<p>▸ <code>Optional</code> <strong>_sort</strong>(<code>sortBy</code>): <code>void</code></p>
<p><strong><code>internal</code></strong></p>
<h4 id="parameters">Parameters<a class="headerlink" href="#parameters" title="Permanent link">#</a></h4>
<table>
<thead>

2
master/extensions/api/modules/Common.Catalog/index.html
View File

@ -892,7 +892,7 @@
<p>Ƭ <strong>AddMenuFilter</strong>: (<code>menu</code>: <a href="../../interfaces/Common.Catalog.CatalogEntityAddMenu/"><code>CatalogEntityAddMenu</code></a>) =&gt; <code>any</code></p>
<h4 id="type-declaration">Type declaration<a class="headerlink" href="#type-declaration" title="Permanent link">#</a></h4>
<p>▸ (<code>menu</code>): <code>any</code></p>
<p>If the filter returns true, the menu item is displayed</p>
<p>If the filter return a thruthy value, the menu item is displayed</p>
<h5 id="parameters">Parameters<a class="headerlink" href="#parameters" title="Permanent link">#</a></h5>
<table>
<thead>

2
master/extensions/api/modules/Renderer.Component/index.html
View File

@ -1209,8 +1209,10 @@
</ul>
<h3 id="interfaces">Interfaces<a class="headerlink" href="#interfaces" title="Permanent link">#</a></h3>
<ul>
<li><a href="../../interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/">AdditionalCategoryColumnRegistration</a></li>
<li><a href="../../interfaces/Renderer.Component.BadgeProps/">BadgeProps</a></li>
<li><a href="../../interfaces/Renderer.Component.ButtonProps/">ButtonProps</a></li>
<li><a href="../../interfaces/Renderer.Component.CategoryColumnRegistration/">CategoryColumnRegistration</a></li>
<li><a href="../../interfaces/Renderer.Component.CheckboxProps/">CheckboxProps</a></li>
<li><a href="../../interfaces/Renderer.Component.ConfirmDialogBooleanParams/">ConfirmDialogBooleanParams</a></li>
<li><a href="../../interfaces/Renderer.Component.ConfirmDialogParams/">ConfirmDialogParams</a></li>

36
master/extensions/guides/catalog/index.html
View File

@ -546,15 +546,15 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#catalogcategoryregistry" class="md-nav__link">
CatalogCategoryRegistry
<a href="#categories" class="md-nav__link">
Categories
</a>
</li>
<li class="md-nav__item">
<a href="#catalogentityregistry" class="md-nav__link">
CatalogEntityRegistry
<a href="#entities" class="md-nav__link">
Entities
</a>
</li>
@ -761,15 +761,15 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#catalogcategoryregistry" class="md-nav__link">
CatalogCategoryRegistry
<a href="#categories" class="md-nav__link">
Categories
</a>
</li>
<li class="md-nav__item">
<a href="#catalogentityregistry" class="md-nav__link">
CatalogEntityRegistry
<a href="#entities" class="md-nav__link">
Entities
</a>
</li>
@ -789,8 +789,24 @@
<h1 id="catalog-wip">Catalog (WIP)<a class="headerlink" href="#catalog-wip" title="Permanent link">#</a></h1>
<h2 id="catalogcategoryregistry">CatalogCategoryRegistry<a class="headerlink" href="#catalogcategoryregistry" title="Permanent link">#</a></h2>
<h2 id="catalogentityregistry">CatalogEntityRegistry<a class="headerlink" href="#catalogentityregistry" title="Permanent link">#</a></h2>
<p>This guide is a brief overview about how the catalog works within Lens.
The catalog should be thought of as the single source of truth about data within Lens.</p>
<p>The data flow is unidirectional, it only flows from the main side to the renderer side.
All data is public within the catalog.</p>
<h2 id="categories">Categories<a class="headerlink" href="#categories" title="Permanent link">#</a></h2>
<p>A category is the declaration to the catalog of a specific kind of entity.
It declares the currently supported versions of that kind of entity but providing the constructors for the entity classes.</p>
<p>To declare a new category class you must create a new class that extends <a href="../../api/classes/Common.Catalog.CatalogCategory/">Common.Catalog.CatalogCategory</a> and implement all of the abstract fields.</p>
<p>The categories provided by Lens itself have the following names:</p>
<ul>
<li><code>KubernetesClusters</code></li>
<li><code>WebLinks</code></li>
<li><code>General</code></li>
</ul>
<p>To register a category, call the <code>Main.Catalog.catalogCategories.add()</code> and <code>Renderer.Catalog.catalogCategories.add()</code> with instances of your class.</p>
<h2 id="entities">Entities<a class="headerlink" href="#entities" title="Permanent link">#</a></h2>
<p>An entity is the data within the catalog.
All entities are typed and the class instances will be recreated on the renderer side by the catalog and the category registrations.</p>

4
master/extensions/guides/index.html
View File

@ -853,6 +853,10 @@ For introductory information about the Lens Extension API, please see <a href=".
<td><a href="ipc/">Sending Data between main and renderer</a></td>
<td></td>
</tr>
<tr>
<td><a href="catalog/">Catalog Entities and Categories</a></td>
<td></td>
</tr>
</tbody>
</table>
<h2 id="samples">Samples<a class="headerlink" href="#samples" title="Permanent link">#</a></h2>

46
master/extensions/guides/main-extension/index.html
View File

@ -854,11 +854,11 @@ It also provides convenient methods for navigating to built-in Lens pages and ex
<span class="k">export</span> <span class="k">default</span> <span class="kd">class</span> <span class="nx">ExampleExtensionMain</span> <span class="k">extends</span> <span class="nx">Main</span><span class="p">.</span><span class="nx">LensExtension</span> <span class="p">{</span>
<span class="nx">onActivate</span><span class="p">()</span> <span class="p">{</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s1">&#39;custom main process extension code started&#39;</span><span class="p">);</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s2">&quot;custom main process extension code started&quot;</span><span class="p">);</span>
<span class="p">}</span>
<span class="nx">onDeactivate</span><span class="p">()</span> <span class="p">{</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s1">&#39;custom main process extension de-activated&#39;</span><span class="p">);</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s2">&quot;custom main process extension de-activated&quot;</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">}</span>
</code></pre></div>
@ -869,13 +869,13 @@ Implementing <code>onDeactivate()</code> gives you the opportunity to clean up a
<p>Disable extensions from the Lens Extensions page:</p>
<ol>
<li>Navigate to <strong>File</strong> &gt; <strong>Extensions</strong> in the top menu bar.
(On Mac, it is <strong>Lens</strong> &gt; <strong>Extensions</strong>.)</li>
(On Mac, it is <strong>Lens</strong> &gt; <strong>Extensions</strong>.)</li>
<li>Click <strong>Disable</strong> on the extension you want to disable.</li>
</ol>
<p>The example above logs messages when the extension is enabled and disabled.
To see standard output from the main process there must be a console connected to it.
Achieve this by starting Lens from the command prompt.</p>
<p>For more details on accessing Lens state data, please see the <a href="../stores">Stores</a> guide.</p>
<p>For more details on accessing Lens state data, please see the <a href="../stores/">Stores</a> guide.</p>
<h3 id="appmenus"><code>appMenus</code><a class="headerlink" href="#appmenus" title="Permanent link">#</a></h3>
<p>The Main Extension API allows you to customize the UI application menu.
The following example demonstrates adding an item to the <strong>Help</strong> menu.</p>
@ -888,9 +888,9 @@ The following example demonstrates adding an item to the <strong>Help</strong> m
<span class="nx">label</span><span class="o">:</span> <span class="s2">&quot;Sample&quot;</span><span class="p">,</span>
<span class="nx">click</span><span class="p">()</span> <span class="p">{</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s2">&quot;Sample clicked&quot;</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">},</span>
<span class="p">},</span>
<span class="p">];</span>
<span class="p">}</span>
</code></pre></div>
<p><code>appMenus</code> is an array of objects that satisfy the <code>MenuRegistration</code> interface.
@ -898,13 +898,13 @@ The following example demonstrates adding an item to the <strong>Help</strong> m
The properties of the appMenus array objects are defined as follows:</p>
<ul>
<li><code>parentId</code> is the name of the menu where your new menu item will be listed.
Valid values include: <code>"file"</code>, <code>"edit"</code>, <code>"view"</code>, and <code>"help"</code>.
<code>"lens"</code> is valid on Mac only.</li>
Valid values include: <code>"file"</code>, <code>"edit"</code>, <code>"view"</code>, and <code>"help"</code>.
<code>"lens"</code> is valid on Mac only.</li>
<li><code>label</code> is the name of your menu item.</li>
<li><code>click()</code> is called when the menu item is selected.
In this example, we simply log a message.
However, you would typically have this navigate to a specific page or perform another operation.
Note that pages are associated with the <a href="../renderer-extension/"><code>Renderer.LensExtension</code></a> class and can be defined in the process of extending it.</li>
In this example, we simply log a message.
However, you would typically have this navigate to a specific page or perform another operation.
Note that pages are associated with the <a href="../renderer-extension/"><code>Renderer.LensExtension</code></a> class and can be defined in the process of extending it.</li>
</ul>
<p>The following example demonstrates how an application menu can be used to navigate to such a page:</p>
<div class="highlight"><pre><span></span><code><span class="k">import</span> <span class="p">{</span> <span class="nx">Main</span> <span class="p">}</span> <span class="kr">from</span> <span class="s2">&quot;@k8slens/extensions&quot;</span><span class="p">;</span>
@ -914,9 +914,9 @@ Note that pages are associated with the <a href="../renderer-extension/"><code>R
<span class="p">{</span>
<span class="nx">parentId</span><span class="o">:</span> <span class="s2">&quot;help&quot;</span><span class="p">,</span>
<span class="nx">label</span><span class="o">:</span> <span class="s2">&quot;Sample&quot;</span><span class="p">,</span>
<span class="nx">click</span><span class="o">:</span> <span class="p">()</span> <span class="p">=&gt;</span> <span class="k">this</span><span class="p">.</span><span class="nx">navigate</span><span class="p">(</span><span class="s2">&quot;myGlobalPage&quot;</span><span class="p">)</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="nx">click</span><span class="o">:</span> <span class="p">()</span> <span class="p">=&gt;</span> <span class="k">this</span><span class="p">.</span><span class="nx">navigate</span><span class="p">(</span><span class="s2">&quot;myGlobalPage&quot;</span><span class="p">),</span>
<span class="p">},</span>
<span class="p">];</span>
<span class="p">}</span>
</code></pre></div>
<p>When the menu item is clicked the <code>navigate()</code> method looks for and displays a global page with id <code>"myGlobalPage"</code>.
@ -927,20 +927,24 @@ This page would be defined in your extension's <code>Renderer.LensExtension</cod
<span class="nx">label?</span>: <span class="kt">string</span><span class="p">;</span>
<span class="nx">click</span><span class="o">?:</span> <span class="p">(</span><span class="nx">menuItem</span>: <span class="kt">TrayMenuRegistration</span><span class="p">)</span> <span class="p">=&gt;</span> <span class="ow">void</span><span class="p">;</span>
<span class="nx">id?</span>: <span class="kt">string</span><span class="p">;</span>
<span class="kr">type</span><span class="o">?:</span> <span class="s2">&quot;normal&quot;</span> <span class="o">|</span> <span class="s2">&quot;separator&quot;</span> <span class="o">|</span> <span class="s2">&quot;submenu&quot;</span>
<span class="kr">type</span><span class="o">?:</span> <span class="s2">&quot;normal&quot;</span> <span class="o">|</span> <span class="s2">&quot;separator&quot;</span> <span class="o">|</span> <span class="s2">&quot;submenu&quot;</span><span class="p">;</span>
<span class="nx">toolTip?</span>: <span class="kt">string</span><span class="p">;</span>
<span class="nx">enabled?</span>: <span class="kt">boolean</span><span class="p">;</span>
<span class="nx">submenu?</span>: <span class="kt">TrayMenuRegistration</span><span class="p">[]</span>
<span class="nx">submenu?</span>: <span class="kt">TrayMenuRegistration</span><span class="p">[];</span>
<span class="p">}</span>
</code></pre></div>
<p>The following example demonstrates how tray menus can be added from extension:</p>
<div class="highlight"><pre><span></span><code><span class="k">import</span> <span class="p">{</span> <span class="nx">Main</span> <span class="p">}</span> <span class="kr">from</span> <span class="s2">&quot;@k8slens/extensions&quot;</span><span class="p">;</span>
<span class="k">export</span> <span class="k">default</span> <span class="kd">class</span> <span class="nx">SampleTrayMenuMainExtension</span> <span class="k">extends</span> <span class="nx">Main</span><span class="p">.</span><span class="nx">LensExtension</span> <span class="p">{</span>
<span class="nx">trayMenus</span> <span class="o">=</span> <span class="p">[{</span>
<span class="nx">label</span><span class="o">:</span> <span class="s2">&quot;menu from the extension&quot;</span><span class="p">,</span>
<span class="nx">click</span><span class="o">:</span> <span class="p">()</span> <span class="p">=&gt;</span> <span class="p">{</span> <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s2">&quot;tray menu clicked!&quot;</span><span class="p">)</span> <span class="p">}</span>
<span class="p">}]</span>
<span class="nx">trayMenus</span> <span class="o">=</span> <span class="p">[</span>
<span class="p">{</span>
<span class="nx">label</span><span class="o">:</span> <span class="s2">&quot;menu from the extension&quot;</span><span class="p">,</span>
<span class="nx">click</span><span class="o">:</span> <span class="p">()</span> <span class="p">=&gt;</span> <span class="p">{</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s2">&quot;tray menu clicked!&quot;</span><span class="p">);</span>
<span class="p">},</span>
<span class="p">},</span>
<span class="p">];</span>
<span class="p">}</span>
</code></pre></div>
<h3 id="addcatalogsource-and-removecatalogsource-methods"><code>addCatalogSource()</code> and <code>removeCatalogSource()</code> Methods<a class="headerlink" href="#addcatalogsource-and-removecatalogsource-methods" title="Permanent link">#</a></h3>

2
master/search/search_index.json
View File

File diff suppressed because one or more lines are too long

10
master/sitemap.xml
View File

@ -840,6 +840,11 @@
<lastmod>2022-01-19</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://api-docs.k8slens.dev/master/extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/</loc>
<lastmod>2022-01-19</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://api-docs.k8slens.dev/master/extensions/api/interfaces/Renderer.Component.BadgeProps/</loc>
<lastmod>2022-01-19</lastmod>
@ -850,6 +855,11 @@
<lastmod>2022-01-19</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://api-docs.k8slens.dev/master/extensions/api/interfaces/Renderer.Component.CategoryColumnRegistration/</loc>
<lastmod>2022-01-19</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://api-docs.k8slens.dev/master/extensions/api/interfaces/Renderer.Component.CheckboxProps/</loc>
<lastmod>2022-01-19</lastmod>

BIN
master/sitemap.xml.gz
View File

Binary file not shown.