mirror of
https://github.com/lensapp/lens.git
synced 2025-05-20 05:10:56 +00:00
Deployed 88edeeef43 to master with MkDocs 1.1.2 and mike 1.0.0
This commit is contained in:
1 parent
961a8c40e4
commit
ac6c34818d
293 files changed
+9990
-89083
No files matched your search
@@ -6,10 +6,10 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
|
||||
<meta name="description" content="Documentation for Lens IDE. The only system you’ll ever need to take control of your Kubernetes clusters. It's open source and free. Download it today!">
|
||||
<meta name="description" content="Documentation for Lens Extension API.">
|
||||
|
||||
|
||||
<link rel="canonical" href="https://docs.k8slens.dev/master/extensions/api/modules/_renderer_api_components_/">
|
||||
<link rel="canonical" href="https://api-docs.k8slens.dev/master/extensions/api/modules/_renderer_api_components_/">
|
||||
|
||||
|
||||
<meta name="author" content="Mirantis, Inc.">
|
||||
@@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
|
||||
<title>Module: "renderer-api/components" - Lens Documentation</title>
|
||||
<title>Module: "renderer-api/components" - Lens Extension API</title>
|
||||
|
||||
|
||||
|
||||
@@ -85,7 +85,7 @@
|
||||
|
||||
<header class="md-header" data-md-component="header">
|
||||
<nav class="md-header-nav md-grid" aria-label="Header">
|
||||
<a href="https://docs.k8slens.dev/master" title="Lens Documentation" class="md-header-nav__button md-logo" aria-label="Lens Documentation">
|
||||
<a href="https://api-docs.k8slens.dev/master" title="Lens Extension API" class="md-header-nav__button md-logo" aria-label="Lens Extension API">
|
||||
|
||||
<img src="../../../../img/lens-logo-icon.svg" alt="logo">
|
||||
|
||||
@@ -97,7 +97,7 @@
|
||||
<div class="md-header-nav__ellipsis">
|
||||
<div class="md-header-nav__topic">
|
||||
<span class="md-ellipsis">
|
||||
Lens Documentation
|
||||
Lens Extension API
|
||||
</span>
|
||||
</div>
|
||||
<div class="md-header-nav__topic">
|
||||
@@ -193,12 +193,12 @@
|
||||
|
||||
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
|
||||
<label class="md-nav__title" for="__drawer">
|
||||
<a href="https://docs.k8slens.dev/master" title="Lens Documentation" class="md-nav__button md-logo" aria-label="Lens Documentation">
|
||||
<a href="https://api-docs.k8slens.dev/master" title="Lens Extension API" class="md-nav__button md-logo" aria-label="Lens Extension API">
|
||||
|
||||
<img src="../../../../img/lens-logo-icon.svg" alt="logo">
|
||||
|
||||
</a>
|
||||
Lens Documentation
|
||||
Lens Extension API
|
||||
</label>
|
||||
|
||||
<div class="md-nav__source">
|
||||
@@ -233,126 +233,16 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../../../getting-started/" class="md-nav__link">
|
||||
Getting Started
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--nested">
|
||||
|
||||
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3">
|
||||
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-2" type="checkbox" id="nav-2">
|
||||
|
||||
<label class="md-nav__link" for="nav-3">
|
||||
Managing Clusters
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
</label>
|
||||
<nav class="md-nav" aria-label="Managing Clusters" data-md-level="1">
|
||||
<label class="md-nav__title" for="nav-3">
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
Managing Clusters
|
||||
</label>
|
||||
<ul class="md-nav__list" data-md-scrollfix>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../../../clusters/adding-clusters/" class="md-nav__link">
|
||||
Adding Clusters
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../../../clusters/removing-clusters/" class="md-nav__link">
|
||||
Removing Clusters
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../../../clusters/settings/" class="md-nav__link">
|
||||
Settings
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../../../helm/" class="md-nav__link">
|
||||
Using Helm Charts
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../../usage/" class="md-nav__link">
|
||||
Using Extensions
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../../../getting-started/preferences/" class="md-nav__link">
|
||||
Preferences
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--nested">
|
||||
|
||||
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-7" type="checkbox" id="nav-7">
|
||||
|
||||
<label class="md-nav__link" for="nav-7">
|
||||
<label class="md-nav__link" for="nav-2">
|
||||
Extension Development
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
</label>
|
||||
<nav class="md-nav" aria-label="Extension Development" data-md-level="1">
|
||||
<label class="md-nav__title" for="nav-7">
|
||||
<label class="md-nav__title" for="nav-2">
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
Extension Development
|
||||
</label>
|
||||
@@ -364,28 +254,16 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../../" class="md-nav__link">
|
||||
Overview
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--nested">
|
||||
|
||||
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-7-2" type="checkbox" id="nav-7-2">
|
||||
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-2-1" type="checkbox" id="nav-2-1">
|
||||
|
||||
<label class="md-nav__link" for="nav-7-2">
|
||||
<label class="md-nav__link" for="nav-2-1">
|
||||
Getting Started
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
</label>
|
||||
<nav class="md-nav" aria-label="Getting Started" data-md-level="2">
|
||||
<label class="md-nav__title" for="nav-7-2">
|
||||
<label class="md-nav__title" for="nav-2-1">
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
Getting Started
|
||||
</label>
|
||||
@@ -452,14 +330,14 @@
|
||||
|
||||
<li class="md-nav__item md-nav__item--nested">
|
||||
|
||||
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-7-3" type="checkbox" id="nav-7-3">
|
||||
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-2-2" type="checkbox" id="nav-2-2">
|
||||
|
||||
<label class="md-nav__link" for="nav-7-3">
|
||||
<label class="md-nav__link" for="nav-2-2">
|
||||
Extension Capabilities
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
</label>
|
||||
<nav class="md-nav" aria-label="Extension Capabilities" data-md-level="2">
|
||||
<label class="md-nav__title" for="nav-7-3">
|
||||
<label class="md-nav__title" for="nav-2-2">
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
Extension Capabilities
|
||||
</label>
|
||||
@@ -502,14 +380,14 @@
|
||||
|
||||
<li class="md-nav__item md-nav__item--nested">
|
||||
|
||||
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-7-4" type="checkbox" id="nav-7-4">
|
||||
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-2-3" type="checkbox" id="nav-2-3">
|
||||
|
||||
<label class="md-nav__link" for="nav-7-4">
|
||||
<label class="md-nav__link" for="nav-2-3">
|
||||
Extension Guides
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
</label>
|
||||
<nav class="md-nav" aria-label="Extension Guides" data-md-level="2">
|
||||
<label class="md-nav__title" for="nav-7-4">
|
||||
<label class="md-nav__title" for="nav-2-3">
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
Extension Guides
|
||||
</label>
|
||||
@@ -624,14 +502,14 @@
|
||||
|
||||
<li class="md-nav__item md-nav__item--nested">
|
||||
|
||||
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-7-5" type="checkbox" id="nav-7-5">
|
||||
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-2-4" type="checkbox" id="nav-2-4">
|
||||
|
||||
<label class="md-nav__link" for="nav-7-5">
|
||||
<label class="md-nav__link" for="nav-2-4">
|
||||
Testing and Publishing
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
</label>
|
||||
<nav class="md-nav" aria-label="Testing and Publishing" data-md-level="2">
|
||||
<label class="md-nav__title" for="nav-7-5">
|
||||
<label class="md-nav__title" for="nav-2-4">
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
Testing and Publishing
|
||||
</label>
|
||||
@@ -684,116 +562,6 @@
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--nested">
|
||||
|
||||
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-8" type="checkbox" id="nav-8">
|
||||
|
||||
<label class="md-nav__link" for="nav-8">
|
||||
Contributing
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
</label>
|
||||
<nav class="md-nav" aria-label="Contributing" data-md-level="1">
|
||||
<label class="md-nav__title" for="nav-8">
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
Contributing
|
||||
</label>
|
||||
<ul class="md-nav__list" data-md-scrollfix>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../../../contributing/" class="md-nav__link">
|
||||
Overview
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../../../contributing/development/" class="md-nav__link">
|
||||
Development
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../../../contributing/documentation/" class="md-nav__link">
|
||||
Documentation
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../../../contributing/maintainers/" class="md-nav__link">
|
||||
Maintainers
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../../../contributing/promotion/" class="md-nav__link">
|
||||
Promotion
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../../../support/" class="md-nav__link">
|
||||
Support
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../../../faq/" class="md-nav__link">
|
||||
FAQ
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
@@ -1361,47 +1129,47 @@
|
||||
<h2 id="type-aliases_1">Type aliases<a class="headerlink" href="#type-aliases_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="inputprops">InputProps<a class="headerlink" href="#inputprops" title="Permanent link">#</a></h3>
|
||||
<p>Ƭ <strong>InputProps</strong>: <em>Omit‹InputElementProps, "onChange" | "onSubmit"› & object</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/input/input.tsx#L43">src/renderer/components/input/input.tsx:43</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/input/input.tsx#L43">src/renderer/components/input/input.tsx:43</a></em></p>
|
||||
<hr />
|
||||
<h3 id="menucontextvalue">MenuContextValue<a class="headerlink" href="#menucontextvalue" title="Permanent link">#</a></h3>
|
||||
<p>Ƭ <strong>MenuContextValue</strong>: <em><a href="../../classes/_renderer_api_components_.menu/">Menu</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/menu/menu.tsx#L31">src/renderer/components/menu/menu.tsx:31</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/menu/menu.tsx#L31">src/renderer/components/menu/menu.tsx:31</a></em></p>
|
||||
<hr />
|
||||
<h3 id="notificationid">NotificationId<a class="headerlink" href="#notificationid" title="Permanent link">#</a></h3>
|
||||
<p>Ƭ <strong>NotificationId</strong>: <em>string | number</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/notifications/notifications.store.tsx#L28">src/renderer/components/notifications/notifications.store.tsx:28</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/notifications/notifications.store.tsx#L28">src/renderer/components/notifications/notifications.store.tsx:28</a></em></p>
|
||||
<hr />
|
||||
<h3 id="notificationmessage">NotificationMessage<a class="headerlink" href="#notificationmessage" title="Permanent link">#</a></h3>
|
||||
<p>Ƭ <strong>NotificationMessage</strong>: <em>React.ReactNode | React.ReactNode[] | JsonApiErrorParsed</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/notifications/notifications.store.tsx#L29">src/renderer/components/notifications/notifications.store.tsx:29</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/notifications/notifications.store.tsx#L29">src/renderer/components/notifications/notifications.store.tsx:29</a></em></p>
|
||||
<hr />
|
||||
<h3 id="radioprops">RadioProps<a class="headerlink" href="#radioprops" title="Permanent link">#</a></h3>
|
||||
<p>Ƭ <strong>RadioProps</strong>: <em>HTMLProps‹any› & object</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/radio/radio.tsx#L61">src/renderer/components/radio/radio.tsx:61</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/radio/radio.tsx#L61">src/renderer/components/radio/radio.tsx:61</a></em></p>
|
||||
<hr />
|
||||
<h3 id="tablecellelem">TableCellElem<a class="headerlink" href="#tablecellelem" title="Permanent link">#</a></h3>
|
||||
<p>Ƭ <strong>TableCellElem</strong>: <em>ReactElement‹<a href="../../interfaces/_renderer_api_components_.tablecellprops/">TableCellProps</a>›</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/table/table-cell.tsx#L30">src/renderer/components/table/table-cell.tsx:30</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/table/table-cell.tsx#L30">src/renderer/components/table/table-cell.tsx:30</a></em></p>
|
||||
<hr />
|
||||
<h3 id="tableheadelem">TableHeadElem<a class="headerlink" href="#tableheadelem" title="Permanent link">#</a></h3>
|
||||
<p>Ƭ <strong>TableHeadElem</strong>: <em>ReactElement‹<a href="../../interfaces/_renderer_api_components_.tableheadprops/">TableHeadProps</a>›</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/table/table-head.tsx#L27">src/renderer/components/table/table-head.tsx:27</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/table/table-head.tsx#L27">src/renderer/components/table/table-head.tsx:27</a></em></p>
|
||||
<hr />
|
||||
<h3 id="tableorderby">TableOrderBy<a class="headerlink" href="#tableorderby" title="Permanent link">#</a></h3>
|
||||
<p>Ƭ <strong>TableOrderBy</strong>: <em>"asc" | "desc" | string</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/table/table.tsx#L38">src/renderer/components/table/table.tsx:38</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/table/table.tsx#L38">src/renderer/components/table/table.tsx:38</a></em></p>
|
||||
<hr />
|
||||
<h3 id="tablerowelem">TableRowElem<a class="headerlink" href="#tablerowelem" title="Permanent link">#</a></h3>
|
||||
<p>Ƭ <strong>TableRowElem</strong>: <em>ReactElement‹<a href="../../interfaces/_renderer_api_components_.tablerowprops/">TableRowProps</a>›</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/table/table-row.tsx#L28">src/renderer/components/table/table-row.tsx:28</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/table/table-row.tsx#L28">src/renderer/components/table/table-row.tsx:28</a></em></p>
|
||||
<hr />
|
||||
<h3 id="tablesortby">TableSortBy<a class="headerlink" href="#tablesortby" title="Permanent link">#</a></h3>
|
||||
<p>Ƭ <strong>TableSortBy</strong>: <em>string</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/table/table.tsx#L37">src/renderer/components/table/table.tsx:37</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/table/table.tsx#L37">src/renderer/components/table/table.tsx:37</a></em></p>
|
||||
<hr />
|
||||
<h3 id="tablesortcallback">TableSortCallback<a class="headerlink" href="#tablesortcallback" title="Permanent link">#</a></h3>
|
||||
<p>Ƭ <strong>TableSortCallback</strong>: <em>function</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/table/table.tsx#L40">src/renderer/components/table/table.tsx:40</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/table/table.tsx#L40">src/renderer/components/table/table.tsx:40</a></em></p>
|
||||
<h4 id="type-declaration">Type declaration:<a class="headerlink" href="#type-declaration" title="Permanent link">#</a></h4>
|
||||
<p>▸ (<code>data</code>: D): <em>string | number | (string | number)[]</em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
@@ -1422,7 +1190,7 @@
|
||||
<hr />
|
||||
<h3 id="tablesortcallbacks">TableSortCallbacks<a class="headerlink" href="#tablesortcallbacks" title="Permanent link">#</a></h3>
|
||||
<p>Ƭ <strong>TableSortCallbacks</strong>: <em>object</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/table/table.tsx#L41">src/renderer/components/table/table.tsx:41</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/table/table.tsx#L41">src/renderer/components/table/table.tsx:41</a></em></p>
|
||||
<h4 id="type-declaration_1">Type declaration:<a class="headerlink" href="#type-declaration_1" title="Permanent link">#</a></h4>
|
||||
<ul>
|
||||
<li>[ <strong>columnId</strong>: <em>string</em>]: <a href="./#tablesortcallback">TableSortCallback</a></li>
|
||||
@@ -1430,7 +1198,7 @@
|
||||
<hr />
|
||||
<h3 id="tablesortparams">TableSortParams<a class="headerlink" href="#tablesortparams" title="Permanent link">#</a></h3>
|
||||
<p>Ƭ <strong>TableSortParams</strong>: <em>object</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/table/table.tsx#L39">src/renderer/components/table/table.tsx:39</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/table/table.tsx#L39">src/renderer/components/table/table.tsx:39</a></em></p>
|
||||
<h4 id="type-declaration_2">Type declaration:<a class="headerlink" href="#type-declaration_2" title="Permanent link">#</a></h4>
|
||||
<ul>
|
||||
<li>
|
||||
@@ -1443,11 +1211,11 @@
|
||||
<h2 id="variables_1">Variables<a class="headerlink" href="#variables_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="inputvalidators">InputValidators<a class="headerlink" href="#inputvalidators" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>InputValidators</strong>: <em><a href="./#inputvalidators">InputValidators</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/input/input.tsx#L35">src/renderer/components/input/input.tsx:35</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/input/input.tsx#L35">src/renderer/components/input/input.tsx:35</a></em></p>
|
||||
<hr />
|
||||
<h3 id="const-menucontext"><code>Const</code> MenuContext<a class="headerlink" href="#const-menucontext" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>MenuContext</strong>: <em>Context‹<a href="../../classes/_renderer_api_components_.menu/">Menu</a>‹››</em> = React.createContext<MenuContextValue>(null)</p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/menu/menu.tsx#L30">src/renderer/components/menu/menu.tsx:30</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/menu/menu.tsx#L30">src/renderer/components/menu/menu.tsx:30</a></em></p>
|
||||
<hr />
|
||||
<h3 id="const-switcher"><code>Const</code> Switcher<a class="headerlink" href="#const-switcher" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>Switcher</strong>: <em>ComponentClass‹object & StyledComponentProps‹"track" | "root" | "thumb" | "focusVisible" | "switchBase" | "checked"›, any› | FunctionComponent‹object & StyledComponentProps‹"track" | "root" | "thumb" | "focusVisible" | "switchBase" | "checked"››</em> = withStyles((theme: Theme) =>
|
||||
@@ -1506,7 +1274,7 @@
|
||||
/>
|
||||
);
|
||||
})</p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/switch/switcher.tsx#L34">src/renderer/components/switch/switcher.tsx:34</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/switch/switcher.tsx#L34">src/renderer/components/switch/switcher.tsx:34</a></em></p>
|
||||
<hr />
|
||||
<h3 id="const-tablayout"><code>Const</code> TabLayout<a class="headerlink" href="#const-tablayout" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>TabLayout</strong>: <em>(Anonymous function)</em> = observer(({ className, contentClass, tabs = [], children }: TabLayoutProps) => {
|
||||
@@ -1540,13 +1308,13 @@
|
||||
</code></pre></div>
|
||||
<p>);
|
||||
})</p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/layout/tab-layout.tsx#L48">src/renderer/components/layout/tab-layout.tsx:48</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/layout/tab-layout.tsx#L48">src/renderer/components/layout/tab-layout.tsx:48</a></em></p>
|
||||
<hr />
|
||||
<h3 id="const-kubedetailsurlparam"><code>Const</code> kubeDetailsUrlParam<a class="headerlink" href="#const-kubedetailsurlparam" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>kubeDetailsUrlParam</strong>: <em><a href="../../classes/_renderer_api_navigation_.pageparam/">PageParam</a>‹string›</em> = createPageParam({
|
||||
name: "kube-details",
|
||||
})</p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/kube-object/kube-object-details.tsx#L40">src/renderer/components/kube-object/kube-object-details.tsx:40</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/kube-object/kube-object-details.tsx#L40">src/renderer/components/kube-object/kube-object-details.tsx:40</a></em></p>
|
||||
<p>Used to store <code>object.selfLink</code> to show more info about resource in the details panel.</p>
|
||||
<hr />
|
||||
<h3 id="const-kubeselectedurlparam"><code>Const</code> kubeSelectedUrlParam<a class="headerlink" href="#const-kubeselectedurlparam" title="Permanent link">#</a></h3>
|
||||
@@ -1556,7 +1324,7 @@
|
||||
return kubeDetailsUrlParam.get();
|
||||
}
|
||||
})</p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/kube-object/kube-object-details.tsx#L51">src/renderer/components/kube-object/kube-object-details.tsx:51</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/kube-object/kube-object-details.tsx#L51">src/renderer/components/kube-object/kube-object-details.tsx:51</a></em></p>
|
||||
<p>Used to highlight last active/selected table row with the resource.</p>
|
||||
<p><strong><code>example</code></strong>
|
||||
If we go to "Nodes (page) -> Node (details) -> Pod (details)",
|
||||
@@ -1564,31 +1332,31 @@ last clicked Node should be "active" while Pod details are shown).</p>
|
||||
<hr />
|
||||
<h3 id="const-logtabstore"><code>Const</code> logTabStore<a class="headerlink" href="#const-logtabstore" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>logTabStore</strong>: <em>LogTabStore‹›</em> = new LogTabStore()</p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/dock/log-tab.store.ts#L140">src/renderer/components/dock/log-tab.store.ts:140</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/dock/log-tab.store.ts#L140">src/renderer/components/dock/log-tab.store.ts:140</a></em></p>
|
||||
<hr />
|
||||
<h3 id="const-notificationsstore"><code>Const</code> notificationsStore<a class="headerlink" href="#const-notificationsstore" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>notificationsStore</strong>: <em><a href="../../classes/_renderer_api_components_.notificationsstore/">NotificationsStore</a>‹›</em> = new NotificationsStore()</p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/notifications/notifications.store.tsx#L103">src/renderer/components/notifications/notifications.store.tsx:103</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/notifications/notifications.store.tsx#L103">src/renderer/components/notifications/notifications.store.tsx:103</a></em></p>
|
||||
<hr />
|
||||
<h3 id="const-orderbyurlparam"><code>Const</code> orderByUrlParam<a class="headerlink" href="#const-orderbyurlparam" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>orderByUrlParam</strong>: <em><a href="../../classes/_renderer_api_navigation_.pageparam/">PageParam</a>‹string›</em> = createPageParam({
|
||||
name: "order",
|
||||
})</p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/table/table.tsx#L72">src/renderer/components/table/table.tsx:72</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/table/table.tsx#L72">src/renderer/components/table/table.tsx:72</a></em></p>
|
||||
<hr />
|
||||
<h3 id="const-sortbyurlparam"><code>Const</code> sortByUrlParam<a class="headerlink" href="#const-sortbyurlparam" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>sortByUrlParam</strong>: <em><a href="../../classes/_renderer_api_navigation_.pageparam/">PageParam</a>‹string›</em> = createPageParam({
|
||||
name: "sort",
|
||||
})</p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/table/table.tsx#L68">src/renderer/components/table/table.tsx:68</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/table/table.tsx#L68">src/renderer/components/table/table.tsx:68</a></em></p>
|
||||
<hr />
|
||||
<h3 id="const-terminalstore"><code>Const</code> terminalStore<a class="headerlink" href="#const-terminalstore" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>terminalStore</strong>: <em>TerminalStore‹›</em> = new TerminalStore()</p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/dock/terminal.store.ts#L132">src/renderer/components/dock/terminal.store.ts:132</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/dock/terminal.store.ts#L132">src/renderer/components/dock/terminal.store.ts:132</a></em></p>
|
||||
<h2 id="functions_1">Functions<a class="headerlink" href="#functions_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="draweritemlabels">DrawerItemLabels<a class="headerlink" href="#draweritemlabels" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>DrawerItemLabels</strong>(<code>props</code>: <a href="../../interfaces/_renderer_api_components_.draweritemlabelsprops/">DrawerItemLabelsProps</a>): <em>Element‹›</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/drawer/drawer-item-labels.tsx#L30">src/renderer/components/drawer/drawer-item-labels.tsx:30</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/drawer/drawer-item-labels.tsx#L30">src/renderer/components/drawer/drawer-item-labels.tsx:30</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1608,7 +1376,7 @@ last clicked Node should be "active" while Pod details are shown).</p>
|
||||
<hr />
|
||||
<h3 id="formswitch">FormSwitch<a class="headerlink" href="#formswitch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>FormSwitch</strong>(<code>props</code>: FormControlLabelProps): <em>Element‹›</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/switch/form-switcher.tsx#L38">src/renderer/components/switch/form-switcher.tsx:38</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/switch/form-switcher.tsx#L38">src/renderer/components/switch/form-switcher.tsx:38</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1628,7 +1396,7 @@ last clicked Node should be "active" while Pod details are shown).</p>
|
||||
<hr />
|
||||
<h3 id="submenu">SubMenu<a class="headerlink" href="#submenu" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>SubMenu</strong>(<code>props</code>: Partial‹<a href="../../interfaces/_renderer_api_components_.menuprops/">MenuProps</a>›): <em>Element‹›</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/menu/menu.tsx#L319">src/renderer/components/menu/menu.tsx:319</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/menu/menu.tsx#L319">src/renderer/components/menu/menu.tsx:319</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1648,7 +1416,7 @@ last clicked Node should be "active" while Pod details are shown).</p>
|
||||
<hr />
|
||||
<h3 id="createterminaltab">createTerminalTab<a class="headerlink" href="#createterminaltab" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>createTerminalTab</strong>(<code>tabParams</code>: Partial‹ITerminalTab›): <em>IDockTab</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/dock/terminal.store.ts#L33">src/renderer/components/dock/terminal.store.ts:33</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/dock/terminal.store.ts#L33">src/renderer/components/dock/terminal.store.ts:33</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1670,7 +1438,7 @@ last clicked Node should be "active" while Pod details are shown).</p>
|
||||
<hr />
|
||||
<h3 id="getdetailsurl">getDetailsUrl<a class="headerlink" href="#getdetailsurl" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getDetailsUrl</strong>(<code>selfLink</code>: string, <code>resetSelected</code>: boolean, <code>mergeGlobals</code>: boolean): <em>string</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/kube-object/kube-object-details.tsx#L68">src/renderer/components/kube-object/kube-object-details.tsx:68</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/kube-object/kube-object-details.tsx#L68">src/renderer/components/kube-object/kube-object-details.tsx:68</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1702,12 +1470,12 @@ last clicked Node should be "active" while Pod details are shown).</p>
|
||||
<hr />
|
||||
<h3 id="hidedetails">hideDetails<a class="headerlink" href="#hidedetails" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>hideDetails</strong>(): <em>void</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/kube-object/kube-object-details.tsx#L64">src/renderer/components/kube-object/kube-object-details.tsx:64</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/kube-object/kube-object-details.tsx#L64">src/renderer/components/kube-object/kube-object-details.tsx:64</a></em></p>
|
||||
<p><strong>Returns:</strong> <em>void</em></p>
|
||||
<hr />
|
||||
<h3 id="showdetails">showDetails<a class="headerlink" href="#showdetails" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>showDetails</strong>(<code>selfLink</code>: string, <code>resetSelected</code>: boolean): <em>void</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/kube-object/kube-object-details.tsx#L58">src/renderer/components/kube-object/kube-object-details.tsx:58</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/kube-object/kube-object-details.tsx#L58">src/renderer/components/kube-object/kube-object-details.tsx:58</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1734,7 +1502,7 @@ last clicked Node should be "active" while Pod details are shown).</p>
|
||||
<hr />
|
||||
<h3 id="withtooltip">withTooltip<a class="headerlink" href="#withtooltip" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>withTooltip</strong>‹<strong>T</strong>›(<code>Target</code>: T): <em>T</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/tooltip/withTooltip.tsx#L39">src/renderer/components/tooltip/withTooltip.tsx:39</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/tooltip/withTooltip.tsx#L39">src/renderer/components/tooltip/withTooltip.tsx:39</a></em></p>
|
||||
<p><strong>Type parameters:</strong></p>
|
||||
<p>▪ <strong>T</strong>: <em>React.ComponentType‹any›</em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
@@ -1756,9 +1524,9 @@ last clicked Node should be "active" while Pod details are shown).</p>
|
||||
<h2 id="object-literals_1">Object literals<a class="headerlink" href="#object-literals_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="const-cpuoptions"><code>Const</code> cpuOptions<a class="headerlink" href="#const-cpuoptions" title="Permanent link">#</a></h3>
|
||||
<h3 id="cpuoptions-object">▪ <strong>cpuOptions</strong>: <em>object</em><a class="headerlink" href="#cpuoptions-object" title="Permanent link">#</a></h3>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/chart/bar-chart.tsx#L220">src/renderer/components/chart/bar-chart.tsx:220</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/chart/bar-chart.tsx#L220">src/renderer/components/chart/bar-chart.tsx:220</a></em></p>
|
||||
<p>▪ <strong>scales</strong>: <em>object</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/chart/bar-chart.tsx#L221">src/renderer/components/chart/bar-chart.tsx:221</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/chart/bar-chart.tsx#L221">src/renderer/components/chart/bar-chart.tsx:221</a></em></p>
|
||||
<ul>
|
||||
<li><strong>yAxes</strong>: <em>object[]</em> = [{
|
||||
ticks: {
|
||||
@@ -1775,7 +1543,7 @@ last clicked Node should be "active" while Pod details are shown).</p>
|
||||
</li>
|
||||
</ul>
|
||||
<p>▪ <strong>tooltips</strong>: <em>object</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/chart/bar-chart.tsx#L236">src/renderer/components/chart/bar-chart.tsx:236</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/chart/bar-chart.tsx#L236">src/renderer/components/chart/bar-chart.tsx:236</a></em></p>
|
||||
<ul>
|
||||
<li>
|
||||
<p><strong>callbacks</strong>: <em>object</em></p>
|
||||
@@ -1787,9 +1555,9 @@ last clicked Node should be "active" while Pod details are shown).</p>
|
||||
<hr />
|
||||
<h3 id="const-memoryoptions"><code>Const</code> memoryOptions<a class="headerlink" href="#const-memoryoptions" title="Permanent link">#</a></h3>
|
||||
<h3 id="memoryoptions-object">▪ <strong>memoryOptions</strong>: <em>object</em><a class="headerlink" href="#memoryoptions-object" title="Permanent link">#</a></h3>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/chart/bar-chart.tsx#L186">src/renderer/components/chart/bar-chart.tsx:186</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/chart/bar-chart.tsx#L186">src/renderer/components/chart/bar-chart.tsx:186</a></em></p>
|
||||
<p>▪ <strong>scales</strong>: <em>object</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/chart/bar-chart.tsx#L187">src/renderer/components/chart/bar-chart.tsx:187</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/chart/bar-chart.tsx#L187">src/renderer/components/chart/bar-chart.tsx:187</a></em></p>
|
||||
<ul>
|
||||
<li><strong>yAxes</strong>: <em>object[]</em> = [{
|
||||
ticks: {
|
||||
@@ -1811,7 +1579,7 @@ stepSize: 1
|
||||
</li>
|
||||
</ul>
|
||||
<p>▪ <strong>tooltips</strong>: <em>object</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/chart/bar-chart.tsx#L207">src/renderer/components/chart/bar-chart.tsx:207</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/chart/bar-chart.tsx#L207">src/renderer/components/chart/bar-chart.tsx:207</a></em></p>
|
||||
<ul>
|
||||
<li>
|
||||
<p><strong>callbacks</strong>: <em>object</em></p>
|
||||
|
||||
Reference in new issue
Block a user