mirror of
https://github.com/lensapp/lens.git
synced 2025-05-20 05:10:56 +00:00
Deployed ba1e5973be to master with MkDocs 1.1.2 and mike 1.0.1
This commit is contained in:
parent
a06ad1a247
commit
a9951676bb
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -9,7 +9,7 @@
|
|||||||
<meta name="description" content="Documentation for Lens Extension API.">
|
<meta name="description" content="Documentation for Lens Extension API.">
|
||||||
|
|
||||||
|
|
||||||
<link rel="canonical" href="https://api-docs.k8slens.dev/master/extensions/api/classes/_common_api_index_._common_api_catalog_.catalogentity/">
|
<link rel="canonical" href="https://api-docs.k8slens.dev/master/extensions/api/classes/common.catalog.catalogentity/">
|
||||||
|
|
||||||
|
|
||||||
<meta name="author" content="Mirantis, Inc.">
|
<meta name="author" content="Mirantis, Inc.">
|
||||||
@ -19,7 +19,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<title>Class: CatalogEntity ‹**Metadata, Status, Spec**› - Lens Extension API</title>
|
<title>Class: CatalogEntity - Lens Extension API</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -72,7 +72,7 @@
|
|||||||
<div data-md-component="skip">
|
<div data-md-component="skip">
|
||||||
|
|
||||||
|
|
||||||
<a href="#class-catalogentity-metadata-status-spec" class="md-skip">
|
<a href="#class-catalogentitymetadata-status-spec" class="md-skip">
|
||||||
Skip to content
|
Skip to content
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
@ -103,7 +103,7 @@
|
|||||||
<div class="md-header-nav__topic">
|
<div class="md-header-nav__topic">
|
||||||
<span class="md-ellipsis">
|
<span class="md-ellipsis">
|
||||||
|
|
||||||
Class: CatalogEntity ‹**Metadata, Status, Spec**›
|
Class: CatalogEntity<Metadata, Status, Spec\>
|
||||||
|
|
||||||
</span>
|
</span>
|
||||||
</div>
|
</div>
|
||||||
@ -612,11 +612,11 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#index" class="md-nav__link">
|
<a href="#table-of-contents" class="md-nav__link">
|
||||||
Index
|
Table of contents
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
<nav class="md-nav" aria-label="Index">
|
<nav class="md-nav" aria-label="Table of contents">
|
||||||
<ul class="md-nav__list">
|
<ul class="md-nav__list">
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -674,15 +674,15 @@
|
|||||||
<ul class="md-nav__list">
|
<ul class="md-nav__list">
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#abstract-apiversion" class="md-nav__link">
|
<a href="#apiversion" class="md-nav__link">
|
||||||
Abstract apiVersion
|
apiVersion
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#abstract-kind" class="md-nav__link">
|
<a href="#kind" class="md-nav__link">
|
||||||
Abstract kind
|
kind
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -736,22 +736,22 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#abstract-oncontextmenuopen" class="md-nav__link">
|
<a href="#oncontextmenuopen" class="md-nav__link">
|
||||||
Abstract onContextMenuOpen
|
onContextMenuOpen
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-abstract-onrun" class="md-nav__link">
|
<a href="#onrun" class="md-nav__link">
|
||||||
Optional Abstract onRun
|
onRun
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#abstract-onsettingsopen" class="md-nav__link">
|
<a href="#onsettingsopen" class="md-nav__link">
|
||||||
Abstract onSettingsOpen
|
onSettingsOpen
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -775,30 +775,50 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<h1 id="class-catalogentity-metadata-status-spec">Class: CatalogEntity ‹<strong>Metadata, Status, Spec</strong>›<a class="headerlink" href="#class-catalogentity-metadata-status-spec" title="Permanent link">#</a></h1>
|
<h1 id="class-catalogentitymetadata-status-spec">Class: CatalogEntity<Metadata, Status, Spec><a class="headerlink" href="#class-catalogentitymetadata-status-spec" title="Permanent link">#</a></h1>
|
||||||
|
<p><a href="../../modules/common/">Common</a>.<a href="../../modules/common.catalog/">Catalog</a>.CatalogEntity</p>
|
||||||
<h2 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h2>
|
<h2 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h2>
|
||||||
<p>▪ <strong>Metadata</strong>: <em><a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitymetadata/">CatalogEntityMetadata</a></em></p>
|
<table>
|
||||||
<p>▪ <strong>Status</strong>: <em><a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitystatus/">CatalogEntityStatus</a></em></p>
|
<thead>
|
||||||
<p>▪ <strong>Spec</strong>: <em><a href="../../modules/_common_api_index_._common_api_catalog_/#catalogentityspec">CatalogEntitySpec</a></em></p>
|
<tr>
|
||||||
|
<th align="left">Name</th>
|
||||||
|
<th align="left">Type</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>Metadata</code></td>
|
||||||
|
<td align="left"><code>Metadata</code>: <a href="../../interfaces/common.catalog.catalogentitymetadata/">CatalogEntityMetadata</a> = <a href="../../interfaces/common.catalog.catalogentitymetadata/">CatalogEntityMetadata</a></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>Status</code></td>
|
||||||
|
<td align="left"><code>Status</code>: <a href="../../interfaces/common.catalog.catalogentitystatus/">CatalogEntityStatus</a> = <a href="../../interfaces/common.catalog.catalogentitystatus/">CatalogEntityStatus</a></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>Spec</code></td>
|
||||||
|
<td align="left"><code>Spec</code>: <a href="../../modules/common.catalog/#catalogentityspec">CatalogEntitySpec</a> = <a href="../../modules/common.catalog/#catalogentityspec">CatalogEntitySpec</a></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
|
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
|
||||||
<ul>
|
<ul>
|
||||||
<li><strong>CatalogEntity</strong></li>
|
<li><strong>CatalogEntity</strong></li>
|
||||||
</ul>
|
</ul>
|
||||||
<p>↳ <a href="../_common_api_index_._common_api_catalog_.kubernetescluster/">KubernetesCluster</a></p>
|
<p>↳ <a href="../common.catalog.kubernetescluster/">KubernetesCluster</a></p>
|
||||||
<p>↳ <a href="../_common_api_index_._common_api_catalog_.weblink/">WebLink</a></p>
|
<p>↳ <a href="../common.catalog.weblink/">WebLink</a></p>
|
||||||
<h2 id="implements">Implements<a class="headerlink" href="#implements" title="Permanent link">#</a></h2>
|
<h2 id="implements">Implements<a class="headerlink" href="#implements" title="Permanent link">#</a></h2>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitykinddata/">CatalogEntityKindData</a></li>
|
<li><a href="../../interfaces/common.catalog.catalogentitykinddata/">CatalogEntityKindData</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="index">Index<a class="headerlink" href="#index" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructors">Constructors<a class="headerlink" href="#constructors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="./#constructor">constructor</a></li>
|
<li><a href="./#constructor">constructor</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="properties">Properties<a class="headerlink" href="#properties" title="Permanent link">#</a></h3>
|
<h3 id="properties">Properties<a class="headerlink" href="#properties" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="./#abstract-apiversion">apiVersion</a></li>
|
<li><a href="./#apiversion">apiVersion</a></li>
|
||||||
<li><a href="./#abstract-kind">kind</a></li>
|
<li><a href="./#kind">kind</a></li>
|
||||||
<li><a href="./#metadata">metadata</a></li>
|
<li><a href="./#metadata">metadata</a></li>
|
||||||
<li><a href="./#spec">spec</a></li>
|
<li><a href="./#spec">spec</a></li>
|
||||||
<li><a href="./#status">status</a></li>
|
<li><a href="./#status">status</a></li>
|
||||||
@ -807,122 +827,140 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><a href="./#getid">getId</a></li>
|
<li><a href="./#getid">getId</a></li>
|
||||||
<li><a href="./#getname">getName</a></li>
|
<li><a href="./#getname">getName</a></li>
|
||||||
<li><a href="./#abstract-oncontextmenuopen">onContextMenuOpen</a></li>
|
<li><a href="./#oncontextmenuopen">onContextMenuOpen</a></li>
|
||||||
<li><a href="./#optional-abstract-onrun">onRun</a></li>
|
<li><a href="./#onrun">onRun</a></li>
|
||||||
<li><a href="./#abstract-onsettingsopen">onSettingsOpen</a></li>
|
<li><a href="./#onsettingsopen">onSettingsOpen</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
<p>+ <strong>new CatalogEntity</strong>(<code>data</code>: <a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitydata/">CatalogEntityData</a>‹Metadata, Status, Spec›): <em><a href="./">CatalogEntity</a></em></p>
|
<p>• <strong>new CatalogEntity</strong><Metadata, Status, Spec>(<code>data</code>)</p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/catalog/catalog-entity.ts#L176">src/common/catalog/catalog-entity.ts:176</a></em></p>
|
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>data</code></td>
|
<td align="left"><code>Metadata</code></td>
|
||||||
<td><a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitydata/">CatalogEntityData</a>‹Metadata, Status, Spec›</td>
|
<td align="left"><code>Metadata</code>: <a href="../../interfaces/common.catalog.catalogentitymetadata/">CatalogEntityMetadata</a> = <a href="../../interfaces/common.catalog.catalogentitymetadata/">CatalogEntityMetadata</a></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>Status</code></td>
|
||||||
|
<td align="left"><code>Status</code>: <a href="../../interfaces/common.catalog.catalogentitystatus/">CatalogEntityStatus</a> = <a href="../../interfaces/common.catalog.catalogentitystatus/">CatalogEntityStatus</a></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>Spec</code></td>
|
||||||
|
<td align="left"><code>Spec</code>: <a href="../../modules/common.catalog/#catalogentityspec">CatalogEntitySpec</a> = <a href="../../modules/common.catalog/#catalogentityspec">CatalogEntitySpec</a></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="parameters">Parameters<a class="headerlink" href="#parameters" 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>data</code></td>
|
||||||
|
<td align="left"><a href="../../interfaces/common.catalog.catalogentitydata/">CatalogEntityData</a><Metadata, Status, Spec></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em><a href="./">CatalogEntity</a></em></p>
|
|
||||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||||
<h3 id="abstract-apiversion"><code>Abstract</code> apiVersion<a class="headerlink" href="#abstract-apiversion" title="Permanent link">#</a></h3>
|
<h3 id="apiversion">apiVersion<a class="headerlink" href="#apiversion" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>apiVersion</strong>: <em>string</em></p>
|
<p>• <code>Readonly</code> <code>Abstract</code> <strong>apiVersion</strong>: <code>string</code></p>
|
||||||
<p><em>Implementation of <a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitykinddata/">CatalogEntityKindData</a>.<a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitykinddata/#apiversion">apiVersion</a></em></p>
|
<h4 id="implementation-of">Implementation of<a class="headerlink" href="#implementation-of" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/catalog/catalog-entity.ts#L171">src/common/catalog/catalog-entity.ts:171</a></em></p>
|
<p><a href="../../interfaces/common.catalog.catalogentitykinddata/">CatalogEntityKindData</a>.<a href="../../interfaces/common.catalog.catalogentitykinddata/#apiversion">apiVersion</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="abstract-kind"><code>Abstract</code> kind<a class="headerlink" href="#abstract-kind" title="Permanent link">#</a></h3>
|
<h3 id="kind">kind<a class="headerlink" href="#kind" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>kind</strong>: <em>string</em></p>
|
<p>• <code>Readonly</code> <code>Abstract</code> <strong>kind</strong>: <code>string</code></p>
|
||||||
<p><em>Implementation of <a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitykinddata/">CatalogEntityKindData</a>.<a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitykinddata/#kind">kind</a></em></p>
|
<h4 id="implementation-of_1">Implementation of<a class="headerlink" href="#implementation-of_1" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/catalog/catalog-entity.ts#L172">src/common/catalog/catalog-entity.ts:172</a></em></p>
|
<p><a href="../../interfaces/common.catalog.catalogentitykinddata/">CatalogEntityKindData</a>.<a href="../../interfaces/common.catalog.catalogentitykinddata/#kind">kind</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="metadata">metadata<a class="headerlink" href="#metadata" title="Permanent link">#</a></h3>
|
<h3 id="metadata">metadata<a class="headerlink" href="#metadata" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>metadata</strong>: <em>Metadata</em></p>
|
<p>• <strong>metadata</strong>: <code>Metadata</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/catalog/catalog-entity.ts#L174">src/common/catalog/catalog-entity.ts:174</a></em></p>
|
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="spec">spec<a class="headerlink" href="#spec" title="Permanent link">#</a></h3>
|
<h3 id="spec">spec<a class="headerlink" href="#spec" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>spec</strong>: <em>Spec</em></p>
|
<p>• <strong>spec</strong>: <code>Spec</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/catalog/catalog-entity.ts#L176">src/common/catalog/catalog-entity.ts:176</a></em></p>
|
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="status">status<a class="headerlink" href="#status" title="Permanent link">#</a></h3>
|
<h3 id="status">status<a class="headerlink" href="#status" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>status</strong>: <em>Status</em></p>
|
<p>• <strong>status</strong>: <code>Status</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/catalog/catalog-entity.ts#L175">src/common/catalog/catalog-entity.ts:175</a></em></p>
|
|
||||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||||
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>getId</strong>(): <em>string</em></p>
|
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/catalog/catalog-entity.ts#L185">src/common/catalog/catalog-entity.ts:185</a></em></p>
|
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Returns:</strong> <em>string</em></p>
|
<p><code>string</code></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>getName</strong>(): <em>string</em></p>
|
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/catalog/catalog-entity.ts#L189">src/common/catalog/catalog-entity.ts:189</a></em></p>
|
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Returns:</strong> <em>string</em></p>
|
<p><code>string</code></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="abstract-oncontextmenuopen"><code>Abstract</code> onContextMenuOpen<a class="headerlink" href="#abstract-oncontextmenuopen" title="Permanent link">#</a></h3>
|
<h3 id="oncontextmenuopen">onContextMenuOpen<a class="headerlink" href="#oncontextmenuopen" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>onContextMenuOpen</strong>(<code>context</code>: <a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitycontextmenucontext/">CatalogEntityContextMenuContext</a>): <em>void | Promise‹void›</em></p>
|
<p>▸ <code>Abstract</code> <strong>onContextMenuOpen</strong>(<code>context</code>): <code>void</code> | <code>Promise</code><void></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/catalog/catalog-entity.ts#L194">src/common/catalog/catalog-entity.ts:194</a></em></p>
|
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>context</code></td>
|
<td align="left"><code>context</code></td>
|
||||||
<td><a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitycontextmenucontext/">CatalogEntityContextMenuContext</a></td>
|
<td align="left"><a href="../../interfaces/common.catalog.catalogentitycontextmenucontext/">CatalogEntityContextMenuContext</a></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void | Promise‹void›</em></p>
|
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code> | <code>Promise</code><void></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-abstract-onrun"><code>Optional</code> <code>Abstract</code> onRun<a class="headerlink" href="#optional-abstract-onrun" title="Permanent link">#</a></h3>
|
<h3 id="onrun">onRun<a class="headerlink" href="#onrun" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>onRun</strong>(<code>context</code>: <a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentityactioncontext/">CatalogEntityActionContext</a>): <em>void | Promise‹void›</em></p>
|
<p>▸ <code>Optional</code> <code>Abstract</code> <strong>onRun</strong>(<code>context</code>): <code>void</code> | <code>Promise</code><void></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/catalog/catalog-entity.ts#L193">src/common/catalog/catalog-entity.ts:193</a></em></p>
|
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>context</code></td>
|
<td align="left"><code>context</code></td>
|
||||||
<td><a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentityactioncontext/">CatalogEntityActionContext</a></td>
|
<td align="left"><a href="../../interfaces/common.catalog.catalogentityactioncontext/">CatalogEntityActionContext</a></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void | Promise‹void›</em></p>
|
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code> | <code>Promise</code><void></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="abstract-onsettingsopen"><code>Abstract</code> onSettingsOpen<a class="headerlink" href="#abstract-onsettingsopen" title="Permanent link">#</a></h3>
|
<h3 id="onsettingsopen">onSettingsOpen<a class="headerlink" href="#onsettingsopen" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>onSettingsOpen</strong>(<code>context</code>: <a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitysettingscontext/">CatalogEntitySettingsContext</a>): <em>void | Promise‹void›</em></p>
|
<p>▸ <code>Abstract</code> <strong>onSettingsOpen</strong>(<code>context</code>): <code>void</code> | <code>Promise</code><void></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/catalog/catalog-entity.ts#L195">src/common/catalog/catalog-entity.ts:195</a></em></p>
|
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>context</code></td>
|
<td align="left"><code>context</code></td>
|
||||||
<td><a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitysettingscontext/">CatalogEntitySettingsContext</a></td>
|
<td align="left"><a href="../../interfaces/common.catalog.catalogentitysettingscontext/">CatalogEntitySettingsContext</a></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void | Promise‹void›</em></p>
|
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code> | <code>Promise</code><void></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -9,7 +9,7 @@
|
|||||||
<meta name="description" content="Documentation for Lens Extension API.">
|
<meta name="description" content="Documentation for Lens Extension API.">
|
||||||
|
|
||||||
|
|
||||||
<link rel="canonical" href="https://api-docs.k8slens.dev/master/extensions/api/classes/_common_api_index_._common_api_catalog_.kubernetescluster/">
|
<link rel="canonical" href="https://api-docs.k8slens.dev/master/extensions/api/classes/common.catalog.kubernetescluster/">
|
||||||
|
|
||||||
|
|
||||||
<meta name="author" content="Mirantis, Inc.">
|
<meta name="author" content="Mirantis, Inc.">
|
||||||
@ -598,18 +598,11 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#implements" class="md-nav__link">
|
<a href="#table-of-contents" class="md-nav__link">
|
||||||
Implements
|
Table of contents
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
<nav class="md-nav" aria-label="Table of contents">
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#index" class="md-nav__link">
|
|
||||||
Index
|
|
||||||
</a>
|
|
||||||
|
|
||||||
<nav class="md-nav" aria-label="Index">
|
|
||||||
<ul class="md-nav__list">
|
<ul class="md-nav__list">
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -790,16 +783,13 @@
|
|||||||
|
|
||||||
|
|
||||||
<h1 id="class-kubernetescluster">Class: KubernetesCluster<a class="headerlink" href="#class-kubernetescluster" title="Permanent link">#</a></h1>
|
<h1 id="class-kubernetescluster">Class: KubernetesCluster<a class="headerlink" href="#class-kubernetescluster" title="Permanent link">#</a></h1>
|
||||||
|
<p><a href="../../modules/common/">Common</a>.<a href="../../modules/common.catalog/">Catalog</a>.KubernetesCluster</p>
|
||||||
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
|
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="../_common_api_index_._common_api_catalog_.catalogentity/">CatalogEntity</a>‹<a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitymetadata/">CatalogEntityMetadata</a>, <a href="../../interfaces/_common_api_index_._common_api_catalog_.kubernetesclusterstatus/">KubernetesClusterStatus</a>, <a href="../../modules/_common_api_index_._common_api_catalog_/#kubernetesclusterspec">KubernetesClusterSpec</a>›</li>
|
<li><a href="../common.catalog.catalogentity/">CatalogEntity</a><<a href="../../interfaces/common.catalog.catalogentitymetadata/">CatalogEntityMetadata</a>, <a href="../../interfaces/common.catalog.kubernetesclusterstatus/">KubernetesClusterStatus</a>, <a href="../../modules/common.catalog/#kubernetesclusterspec">KubernetesClusterSpec</a>></li>
|
||||||
</ul>
|
</ul>
|
||||||
<p>↳ <strong>KubernetesCluster</strong></p>
|
<p>↳ <strong>KubernetesCluster</strong></p>
|
||||||
<h2 id="implements">Implements<a class="headerlink" href="#implements" title="Permanent link">#</a></h2>
|
<h2 id="table-of-contents">Table of contents<a class="headerlink" href="#table-of-contents" title="Permanent link">#</a></h2>
|
||||||
<ul>
|
|
||||||
<li><a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitykinddata/">CatalogEntityKindData</a></li>
|
|
||||||
</ul>
|
|
||||||
<h2 id="index">Index<a class="headerlink" href="#index" title="Permanent link">#</a></h2>
|
|
||||||
<h3 id="constructors">Constructors<a class="headerlink" href="#constructors" title="Permanent link">#</a></h3>
|
<h3 id="constructors">Constructors<a class="headerlink" href="#constructors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="./#constructor">constructor</a></li>
|
<li><a href="./#constructor">constructor</a></li>
|
||||||
@ -825,127 +815,129 @@
|
|||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
<p>+ <strong>new KubernetesCluster</strong>(<code>data</code>: <a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitydata/">CatalogEntityData</a>‹<a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitymetadata/">CatalogEntityMetadata</a>, <a href="../../interfaces/_common_api_index_._common_api_catalog_.kubernetesclusterstatus/">KubernetesClusterStatus</a>, <a href="../../modules/_common_api_index_._common_api_catalog_/#kubernetesclusterspec">KubernetesClusterSpec</a>›): <em><a href="./">KubernetesCluster</a></em></p>
|
<p>• <strong>new KubernetesCluster</strong>(<code>data</code>)</p>
|
||||||
<p><em>Inherited from <a href="./">KubernetesCluster</a>.<a href="./#constructor">constructor</a></em></p>
|
<h4 id="parameters">Parameters<a class="headerlink" href="#parameters" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/catalog/catalog-entity.ts#L176">src/common/catalog/catalog-entity.ts:176</a></em></p>
|
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>data</code></td>
|
<td align="left"><code>data</code></td>
|
||||||
<td><a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitydata/">CatalogEntityData</a>‹<a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitymetadata/">CatalogEntityMetadata</a>, <a href="../../interfaces/_common_api_index_._common_api_catalog_.kubernetesclusterstatus/">KubernetesClusterStatus</a>, <a href="../../modules/_common_api_index_._common_api_catalog_/#kubernetesclusterspec">KubernetesClusterSpec</a>›</td>
|
<td align="left"><a href="../../interfaces/common.catalog.catalogentitydata/">CatalogEntityData</a><<a href="../../interfaces/common.catalog.catalogentitymetadata/">CatalogEntityMetadata</a>, <a href="../../interfaces/common.catalog.kubernetesclusterstatus/">KubernetesClusterStatus</a>, <a href="../../modules/common.catalog/#kubernetesclusterspec">KubernetesClusterSpec</a>></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em><a href="./">KubernetesCluster</a></em></p>
|
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../common.catalog.catalogentity/">CatalogEntity</a>.<a href="../common.catalog.catalogentity/#constructor">constructor</a></p>
|
||||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="apiversion">apiVersion<a class="headerlink" href="#apiversion" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>apiVersion</strong>: <em>"entity.k8slens.dev/v1alpha1"</em> = "entity.k8slens.dev/v1alpha1"</p>
|
<p>• <code>Readonly</code> <strong>apiVersion</strong>: <code>"entity.k8slens.dev/v1alpha1"</code></p>
|
||||||
<p><em>Implementation of <a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitykinddata/">CatalogEntityKindData</a>.<a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitykinddata/#apiversion">apiVersion</a></em></p>
|
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
||||||
<p><em>Overrides <a href="../_common_api_index_._common_api_catalog_.catalogentity/">CatalogEntity</a>.<a href="../_common_api_index_._common_api_catalog_.catalogentity/#abstract-apiversion">apiVersion</a></em></p>
|
<p><a href="../common.catalog.catalogentity/">CatalogEntity</a>.<a href="../common.catalog.catalogentity/#apiversion">apiVersion</a></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/catalog-entities/kubernetes-cluster.ts#L56">src/common/catalog-entities/kubernetes-cluster.ts:56</a></em></p>
|
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="kind">kind<a class="headerlink" href="#kind" title="Permanent link">#</a></h3>
|
<h3 id="kind">kind<a class="headerlink" href="#kind" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>kind</strong>: <em>"KubernetesCluster"</em> = "KubernetesCluster"</p>
|
<p>• <code>Readonly</code> <strong>kind</strong>: <code>"KubernetesCluster"</code></p>
|
||||||
<p><em>Implementation of <a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitykinddata/">CatalogEntityKindData</a>.<a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitykinddata/#kind">kind</a></em></p>
|
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
||||||
<p><em>Overrides <a href="../_common_api_index_._common_api_catalog_.catalogentity/">CatalogEntity</a>.<a href="../_common_api_index_._common_api_catalog_.catalogentity/#abstract-kind">kind</a></em></p>
|
<p><a href="../common.catalog.catalogentity/">CatalogEntity</a>.<a href="../common.catalog.catalogentity/#kind">kind</a></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/catalog-entities/kubernetes-cluster.ts#L57">src/common/catalog-entities/kubernetes-cluster.ts:57</a></em></p>
|
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="metadata">metadata<a class="headerlink" href="#metadata" title="Permanent link">#</a></h3>
|
<h3 id="metadata">metadata<a class="headerlink" href="#metadata" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>metadata</strong>: <em><a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitymetadata/">CatalogEntityMetadata</a></em></p>
|
<p>• <strong>metadata</strong>: <a href="../../interfaces/common.catalog.catalogentitymetadata/">CatalogEntityMetadata</a></p>
|
||||||
<p><em>Inherited from <a href="./">KubernetesCluster</a>.<a href="./#metadata">metadata</a></em></p>
|
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/catalog/catalog-entity.ts#L174">src/common/catalog/catalog-entity.ts:174</a></em></p>
|
<p><a href="../common.catalog.catalogentity/">CatalogEntity</a>.<a href="../common.catalog.catalogentity/#metadata">metadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="spec">spec<a class="headerlink" href="#spec" title="Permanent link">#</a></h3>
|
<h3 id="spec">spec<a class="headerlink" href="#spec" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>spec</strong>: <em><a href="../../modules/_common_api_index_._common_api_catalog_/#kubernetesclusterspec">KubernetesClusterSpec</a></em></p>
|
<p>• <strong>spec</strong>: <a href="../../modules/common.catalog/#kubernetesclusterspec">KubernetesClusterSpec</a></p>
|
||||||
<p><em>Inherited from <a href="./">KubernetesCluster</a>.<a href="./#spec">spec</a></em></p>
|
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/catalog/catalog-entity.ts#L176">src/common/catalog/catalog-entity.ts:176</a></em></p>
|
<p><a href="../common.catalog.catalogentity/">CatalogEntity</a>.<a href="../common.catalog.catalogentity/#spec">spec</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="status">status<a class="headerlink" href="#status" title="Permanent link">#</a></h3>
|
<h3 id="status">status<a class="headerlink" href="#status" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>status</strong>: <em><a href="../../interfaces/_common_api_index_._common_api_catalog_.kubernetesclusterstatus/">KubernetesClusterStatus</a></em></p>
|
<p>• <strong>status</strong>: <a href="../../interfaces/common.catalog.kubernetesclusterstatus/">KubernetesClusterStatus</a></p>
|
||||||
<p><em>Inherited from <a href="./">KubernetesCluster</a>.<a href="./#status">status</a></em></p>
|
<h4 id="inherited-from_3">Inherited from<a class="headerlink" href="#inherited-from_3" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/catalog/catalog-entity.ts#L175">src/common/catalog/catalog-entity.ts:175</a></em></p>
|
<p><a href="../common.catalog.catalogentity/">CatalogEntity</a>.<a href="../common.catalog.catalogentity/#status">status</a></p>
|
||||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||||
<h3 id="connect">connect<a class="headerlink" href="#connect" title="Permanent link">#</a></h3>
|
<h3 id="connect">connect<a class="headerlink" href="#connect" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>connect</strong>(): <em>Promise‹void›</em></p>
|
<p>▸ <strong>connect</strong>(): <code>Promise</code><void></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/catalog-entities/kubernetes-cluster.ts#L59">src/common/catalog-entities/kubernetes-cluster.ts:59</a></em></p>
|
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Returns:</strong> <em>Promise‹void›</em></p>
|
<p><code>Promise</code><void></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="disconnect">disconnect<a class="headerlink" href="#disconnect" title="Permanent link">#</a></h3>
|
<h3 id="disconnect">disconnect<a class="headerlink" href="#disconnect" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>disconnect</strong>(): <em>Promise‹void›</em></p>
|
<p>▸ <strong>disconnect</strong>(): <code>Promise</code><void></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/catalog-entities/kubernetes-cluster.ts#L75">src/common/catalog-entities/kubernetes-cluster.ts:75</a></em></p>
|
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Returns:</strong> <em>Promise‹void›</em></p>
|
<p><code>Promise</code><void></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>getId</strong>(): <em>string</em></p>
|
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
||||||
<p><em>Inherited from <a href="./">KubernetesCluster</a>.<a href="./#getid">getId</a></em></p>
|
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/catalog/catalog-entity.ts#L185">src/common/catalog/catalog-entity.ts:185</a></em></p>
|
<p><code>string</code></p>
|
||||||
<p><strong>Returns:</strong> <em>string</em></p>
|
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../common.catalog.catalogentity/">CatalogEntity</a>.<a href="../common.catalog.catalogentity/#getid">getId</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>getName</strong>(): <em>string</em></p>
|
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
||||||
<p><em>Inherited from <a href="./">KubernetesCluster</a>.<a href="./#getname">getName</a></em></p>
|
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/catalog/catalog-entity.ts#L189">src/common/catalog/catalog-entity.ts:189</a></em></p>
|
<p><code>string</code></p>
|
||||||
<p><strong>Returns:</strong> <em>string</em></p>
|
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../common.catalog.catalogentity/">CatalogEntity</a>.<a href="../common.catalog.catalogentity/#getname">getName</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="oncontextmenuopen">onContextMenuOpen<a class="headerlink" href="#oncontextmenuopen" title="Permanent link">#</a></h3>
|
<h3 id="oncontextmenuopen">onContextMenuOpen<a class="headerlink" href="#oncontextmenuopen" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>onContextMenuOpen</strong>(<code>context</code>: <a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitycontextmenucontext/">CatalogEntityContextMenuContext</a>): <em>Promise‹void›</em></p>
|
<p>▸ <strong>onContextMenuOpen</strong>(<code>context</code>): <code>Promise</code><void></p>
|
||||||
<p><em>Overrides <a href="../_common_api_index_._common_api_catalog_.catalogentity/">CatalogEntity</a>.<a href="../_common_api_index_._common_api_catalog_.catalogentity/#abstract-oncontextmenuopen">onContextMenuOpen</a></em></p>
|
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/catalog-entities/kubernetes-cluster.ts#L103">src/common/catalog-entities/kubernetes-cluster.ts:103</a></em></p>
|
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>context</code></td>
|
<td align="left"><code>context</code></td>
|
||||||
<td><a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitycontextmenucontext/">CatalogEntityContextMenuContext</a></td>
|
<td align="left"><a href="../../interfaces/common.catalog.catalogentitycontextmenucontext/">CatalogEntityContextMenuContext</a></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>Promise‹void›</em></p>
|
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><void></p>
|
||||||
|
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../common.catalog.catalogentity/">CatalogEntity</a>.<a href="../common.catalog.catalogentity/#oncontextmenuopen">onContextMenuOpen</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ondetailsopen">onDetailsOpen<a class="headerlink" href="#ondetailsopen" title="Permanent link">#</a></h3>
|
<h3 id="ondetailsopen">onDetailsOpen<a class="headerlink" href="#ondetailsopen" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>onDetailsOpen</strong>(): <em>void</em></p>
|
<p>▸ <strong>onDetailsOpen</strong>(): <code>void</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/catalog-entities/kubernetes-cluster.ts#L95">src/common/catalog-entities/kubernetes-cluster.ts:95</a></em></p>
|
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<p><code>void</code></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="onrun">onRun<a class="headerlink" href="#onrun" title="Permanent link">#</a></h3>
|
<h3 id="onrun">onRun<a class="headerlink" href="#onrun" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>onRun</strong>(<code>context</code>: <a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentityactioncontext/">CatalogEntityActionContext</a>): <em>Promise‹void›</em></p>
|
<p>▸ <strong>onRun</strong>(<code>context</code>): <code>Promise</code><void></p>
|
||||||
<p><em>Overrides <a href="../_common_api_index_._common_api_catalog_.catalogentity/">CatalogEntity</a>.<a href="../_common_api_index_._common_api_catalog_.catalogentity/#optional-abstract-onrun">onRun</a></em></p>
|
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/catalog-entities/kubernetes-cluster.ts#L91">src/common/catalog-entities/kubernetes-cluster.ts:91</a></em></p>
|
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>context</code></td>
|
<td align="left"><code>context</code></td>
|
||||||
<td><a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentityactioncontext/">CatalogEntityActionContext</a></td>
|
<td align="left"><a href="../../interfaces/common.catalog.catalogentityactioncontext/">CatalogEntityActionContext</a></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>Promise‹void›</em></p>
|
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><void></p>
|
||||||
|
<h4 id="overrides_3">Overrides<a class="headerlink" href="#overrides_3" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../common.catalog.catalogentity/">CatalogEntity</a>.<a href="../common.catalog.catalogentity/#onrun">onRun</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="onsettingsopen">onSettingsOpen<a class="headerlink" href="#onsettingsopen" title="Permanent link">#</a></h3>
|
<h3 id="onsettingsopen">onSettingsOpen<a class="headerlink" href="#onsettingsopen" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>onSettingsOpen</strong>(): <em>void</em></p>
|
<p>▸ <strong>onSettingsOpen</strong>(): <code>void</code></p>
|
||||||
<p><em>Overrides <a href="../_common_api_index_._common_api_catalog_.catalogentity/">CatalogEntity</a>.<a href="../_common_api_index_._common_api_catalog_.catalogentity/#abstract-onsettingsopen">onSettingsOpen</a></em></p>
|
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/catalog-entities/kubernetes-cluster.ts#L99">src/common/catalog-entities/kubernetes-cluster.ts:99</a></em></p>
|
<p><code>void</code></p>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="overrides_4">Overrides<a class="headerlink" href="#overrides_4" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../common.catalog.catalogentity/">CatalogEntity</a>.<a href="../common.catalog.catalogentity/#onsettingsopen">onSettingsOpen</a></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
File diff suppressed because it is too large
Load Diff
@ -9,7 +9,7 @@
|
|||||||
<meta name="description" content="Documentation for Lens Extension API.">
|
<meta name="description" content="Documentation for Lens Extension API.">
|
||||||
|
|
||||||
|
|
||||||
<link rel="canonical" href="https://api-docs.k8slens.dev/master/extensions/api/classes/_common_api_index_._common_api_catalog_.weblink/">
|
<link rel="canonical" href="https://api-docs.k8slens.dev/master/extensions/api/classes/common.catalog.weblink/">
|
||||||
|
|
||||||
|
|
||||||
<meta name="author" content="Mirantis, Inc.">
|
<meta name="author" content="Mirantis, Inc.">
|
||||||
@ -598,18 +598,11 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#implements" class="md-nav__link">
|
<a href="#table-of-contents" class="md-nav__link">
|
||||||
Implements
|
Table of contents
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
<nav class="md-nav" aria-label="Table of contents">
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#index" class="md-nav__link">
|
|
||||||
Index
|
|
||||||
</a>
|
|
||||||
|
|
||||||
<nav class="md-nav" aria-label="Index">
|
|
||||||
<ul class="md-nav__list">
|
<ul class="md-nav__list">
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -776,16 +769,13 @@
|
|||||||
|
|
||||||
|
|
||||||
<h1 id="class-weblink">Class: WebLink<a class="headerlink" href="#class-weblink" title="Permanent link">#</a></h1>
|
<h1 id="class-weblink">Class: WebLink<a class="headerlink" href="#class-weblink" title="Permanent link">#</a></h1>
|
||||||
|
<p><a href="../../modules/common/">Common</a>.<a href="../../modules/common.catalog/">Catalog</a>.WebLink</p>
|
||||||
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
|
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="../_common_api_index_._common_api_catalog_.catalogentity/">CatalogEntity</a>‹<a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitymetadata/">CatalogEntityMetadata</a>, <a href="../../interfaces/_common_api_index_._common_api_catalog_.weblinkstatus/">WebLinkStatus</a>, <a href="../../modules/_common_api_index_._common_api_catalog_/#weblinkspec">WebLinkSpec</a>›</li>
|
<li><a href="../common.catalog.catalogentity/">CatalogEntity</a><<a href="../../interfaces/common.catalog.catalogentitymetadata/">CatalogEntityMetadata</a>, <a href="../../interfaces/common.catalog.weblinkstatus/">WebLinkStatus</a>, <a href="../../modules/common.catalog/#weblinkspec">WebLinkSpec</a>></li>
|
||||||
</ul>
|
</ul>
|
||||||
<p>↳ <strong>WebLink</strong></p>
|
<p>↳ <strong>WebLink</strong></p>
|
||||||
<h2 id="implements">Implements<a class="headerlink" href="#implements" title="Permanent link">#</a></h2>
|
<h2 id="table-of-contents">Table of contents<a class="headerlink" href="#table-of-contents" title="Permanent link">#</a></h2>
|
||||||
<ul>
|
|
||||||
<li><a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitykinddata/">CatalogEntityKindData</a></li>
|
|
||||||
</ul>
|
|
||||||
<h2 id="index">Index<a class="headerlink" href="#index" title="Permanent link">#</a></h2>
|
|
||||||
<h3 id="constructors">Constructors<a class="headerlink" href="#constructors" title="Permanent link">#</a></h3>
|
<h3 id="constructors">Constructors<a class="headerlink" href="#constructors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="./#constructor">constructor</a></li>
|
<li><a href="./#constructor">constructor</a></li>
|
||||||
@ -809,87 +799,89 @@
|
|||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
<p>+ <strong>new WebLink</strong>(<code>data</code>: <a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitydata/">CatalogEntityData</a>‹<a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitymetadata/">CatalogEntityMetadata</a>, <a href="../../interfaces/_common_api_index_._common_api_catalog_.weblinkstatus/">WebLinkStatus</a>, <a href="../../modules/_common_api_index_._common_api_catalog_/#weblinkspec">WebLinkSpec</a>›): <em><a href="./">WebLink</a></em></p>
|
<p>• <strong>new WebLink</strong>(<code>data</code>)</p>
|
||||||
<p><em>Inherited from <a href="../_common_api_index_._common_api_catalog_.kubernetescluster/">KubernetesCluster</a>.<a href="../_common_api_index_._common_api_catalog_.kubernetescluster/#constructor">constructor</a></em></p>
|
<h4 id="parameters">Parameters<a class="headerlink" href="#parameters" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/catalog/catalog-entity.ts#L176">src/common/catalog/catalog-entity.ts:176</a></em></p>
|
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>data</code></td>
|
<td align="left"><code>data</code></td>
|
||||||
<td><a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitydata/">CatalogEntityData</a>‹<a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitymetadata/">CatalogEntityMetadata</a>, <a href="../../interfaces/_common_api_index_._common_api_catalog_.weblinkstatus/">WebLinkStatus</a>, <a href="../../modules/_common_api_index_._common_api_catalog_/#weblinkspec">WebLinkSpec</a>›</td>
|
<td align="left"><a href="../../interfaces/common.catalog.catalogentitydata/">CatalogEntityData</a><<a href="../../interfaces/common.catalog.catalogentitymetadata/">CatalogEntityMetadata</a>, <a href="../../interfaces/common.catalog.weblinkstatus/">WebLinkStatus</a>, <a href="../../modules/common.catalog/#weblinkspec">WebLinkSpec</a>></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em><a href="./">WebLink</a></em></p>
|
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../common.catalog.catalogentity/">CatalogEntity</a>.<a href="../common.catalog.catalogentity/#constructor">constructor</a></p>
|
||||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="apiversion">apiVersion<a class="headerlink" href="#apiversion" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>apiVersion</strong>: <em>"entity.k8slens.dev/v1alpha1"</em> = "entity.k8slens.dev/v1alpha1"</p>
|
<p>• <code>Readonly</code> <strong>apiVersion</strong>: <code>"entity.k8slens.dev/v1alpha1"</code></p>
|
||||||
<p><em>Implementation of <a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitykinddata/">CatalogEntityKindData</a>.<a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitykinddata/#apiversion">apiVersion</a></em></p>
|
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
||||||
<p><em>Overrides <a href="../_common_api_index_._common_api_catalog_.catalogentity/">CatalogEntity</a>.<a href="../_common_api_index_._common_api_catalog_.catalogentity/#abstract-apiversion">apiVersion</a></em></p>
|
<p><a href="../common.catalog.catalogentity/">CatalogEntity</a>.<a href="../common.catalog.catalogentity/#apiversion">apiVersion</a></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/catalog-entities/web-link.ts#L34">src/common/catalog-entities/web-link.ts:34</a></em></p>
|
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="kind">kind<a class="headerlink" href="#kind" title="Permanent link">#</a></h3>
|
<h3 id="kind">kind<a class="headerlink" href="#kind" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>kind</strong>: <em>"WebLink"</em> = "WebLink"</p>
|
<p>• <code>Readonly</code> <strong>kind</strong>: <code>"WebLink"</code></p>
|
||||||
<p><em>Implementation of <a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitykinddata/">CatalogEntityKindData</a>.<a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitykinddata/#kind">kind</a></em></p>
|
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
||||||
<p><em>Overrides <a href="../_common_api_index_._common_api_catalog_.catalogentity/">CatalogEntity</a>.<a href="../_common_api_index_._common_api_catalog_.catalogentity/#abstract-kind">kind</a></em></p>
|
<p><a href="../common.catalog.catalogentity/">CatalogEntity</a>.<a href="../common.catalog.catalogentity/#kind">kind</a></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/catalog-entities/web-link.ts#L35">src/common/catalog-entities/web-link.ts:35</a></em></p>
|
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="metadata">metadata<a class="headerlink" href="#metadata" title="Permanent link">#</a></h3>
|
<h3 id="metadata">metadata<a class="headerlink" href="#metadata" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>metadata</strong>: <em><a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitymetadata/">CatalogEntityMetadata</a></em></p>
|
<p>• <strong>metadata</strong>: <a href="../../interfaces/common.catalog.catalogentitymetadata/">CatalogEntityMetadata</a></p>
|
||||||
<p><em>Inherited from <a href="../_common_api_index_._common_api_catalog_.kubernetescluster/">KubernetesCluster</a>.<a href="../_common_api_index_._common_api_catalog_.kubernetescluster/#metadata">metadata</a></em></p>
|
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/catalog/catalog-entity.ts#L174">src/common/catalog/catalog-entity.ts:174</a></em></p>
|
<p><a href="../common.catalog.catalogentity/">CatalogEntity</a>.<a href="../common.catalog.catalogentity/#metadata">metadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="spec">spec<a class="headerlink" href="#spec" title="Permanent link">#</a></h3>
|
<h3 id="spec">spec<a class="headerlink" href="#spec" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>spec</strong>: <em><a href="../../modules/_common_api_index_._common_api_catalog_/#weblinkspec">WebLinkSpec</a></em></p>
|
<p>• <strong>spec</strong>: <a href="../../modules/common.catalog/#weblinkspec">WebLinkSpec</a></p>
|
||||||
<p><em>Inherited from <a href="../_common_api_index_._common_api_catalog_.kubernetescluster/">KubernetesCluster</a>.<a href="../_common_api_index_._common_api_catalog_.kubernetescluster/#spec">spec</a></em></p>
|
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/catalog/catalog-entity.ts#L176">src/common/catalog/catalog-entity.ts:176</a></em></p>
|
<p><a href="../common.catalog.catalogentity/">CatalogEntity</a>.<a href="../common.catalog.catalogentity/#spec">spec</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="status">status<a class="headerlink" href="#status" title="Permanent link">#</a></h3>
|
<h3 id="status">status<a class="headerlink" href="#status" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>status</strong>: <em><a href="../../interfaces/_common_api_index_._common_api_catalog_.weblinkstatus/">WebLinkStatus</a></em></p>
|
<p>• <strong>status</strong>: <a href="../../interfaces/common.catalog.weblinkstatus/">WebLinkStatus</a></p>
|
||||||
<p><em>Inherited from <a href="../_common_api_index_._common_api_catalog_.kubernetescluster/">KubernetesCluster</a>.<a href="../_common_api_index_._common_api_catalog_.kubernetescluster/#status">status</a></em></p>
|
<h4 id="inherited-from_3">Inherited from<a class="headerlink" href="#inherited-from_3" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/catalog/catalog-entity.ts#L175">src/common/catalog/catalog-entity.ts:175</a></em></p>
|
<p><a href="../common.catalog.catalogentity/">CatalogEntity</a>.<a href="../common.catalog.catalogentity/#status">status</a></p>
|
||||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||||
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>getId</strong>(): <em>string</em></p>
|
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
||||||
<p><em>Inherited from <a href="../_common_api_index_._common_api_catalog_.kubernetescluster/">KubernetesCluster</a>.<a href="../_common_api_index_._common_api_catalog_.kubernetescluster/#getid">getId</a></em></p>
|
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/catalog/catalog-entity.ts#L185">src/common/catalog/catalog-entity.ts:185</a></em></p>
|
<p><code>string</code></p>
|
||||||
<p><strong>Returns:</strong> <em>string</em></p>
|
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../common.catalog.catalogentity/">CatalogEntity</a>.<a href="../common.catalog.catalogentity/#getid">getId</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>getName</strong>(): <em>string</em></p>
|
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
||||||
<p><em>Inherited from <a href="../_common_api_index_._common_api_catalog_.kubernetescluster/">KubernetesCluster</a>.<a href="../_common_api_index_._common_api_catalog_.kubernetescluster/#getname">getName</a></em></p>
|
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/catalog/catalog-entity.ts#L189">src/common/catalog/catalog-entity.ts:189</a></em></p>
|
<p><code>string</code></p>
|
||||||
<p><strong>Returns:</strong> <em>string</em></p>
|
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../common.catalog.catalogentity/">CatalogEntity</a>.<a href="../common.catalog.catalogentity/#getname">getName</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="oncontextmenuopen">onContextMenuOpen<a class="headerlink" href="#oncontextmenuopen" title="Permanent link">#</a></h3>
|
<h3 id="oncontextmenuopen">onContextMenuOpen<a class="headerlink" href="#oncontextmenuopen" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>onContextMenuOpen</strong>(): <em>void</em></p>
|
<p>▸ <strong>onContextMenuOpen</strong>(): <code>void</code></p>
|
||||||
<p><em>Overrides <a href="../_common_api_index_._common_api_catalog_.catalogentity/">CatalogEntity</a>.<a href="../_common_api_index_._common_api_catalog_.catalogentity/#abstract-oncontextmenuopen">onContextMenuOpen</a></em></p>
|
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/catalog-entities/web-link.ts#L49">src/common/catalog-entities/web-link.ts:49</a></em></p>
|
<p><code>void</code></p>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../common.catalog.catalogentity/">CatalogEntity</a>.<a href="../common.catalog.catalogentity/#oncontextmenuopen">onContextMenuOpen</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ondetailsopen">onDetailsOpen<a class="headerlink" href="#ondetailsopen" title="Permanent link">#</a></h3>
|
<h3 id="ondetailsopen">onDetailsOpen<a class="headerlink" href="#ondetailsopen" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>onDetailsOpen</strong>(): <em>void</em></p>
|
<p>▸ <strong>onDetailsOpen</strong>(): <code>void</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/catalog-entities/web-link.ts#L45">src/common/catalog-entities/web-link.ts:45</a></em></p>
|
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<p><code>void</code></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="onrun">onRun<a class="headerlink" href="#onrun" title="Permanent link">#</a></h3>
|
<h3 id="onrun">onRun<a class="headerlink" href="#onrun" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>onRun</strong>(): <em>Promise‹void›</em></p>
|
<p>▸ <strong>onRun</strong>(): <code>Promise</code><void></p>
|
||||||
<p><em>Overrides <a href="../_common_api_index_._common_api_catalog_.catalogentity/">CatalogEntity</a>.<a href="../_common_api_index_._common_api_catalog_.catalogentity/#optional-abstract-onrun">onRun</a></em></p>
|
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/catalog-entities/web-link.ts#L37">src/common/catalog-entities/web-link.ts:37</a></em></p>
|
<p><code>Promise</code><void></p>
|
||||||
<p><strong>Returns:</strong> <em>Promise‹void›</em></p>
|
<h4 id="overrides_3">Overrides<a class="headerlink" href="#overrides_3" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../common.catalog.catalogentity/">CatalogEntity</a>.<a href="../common.catalog.catalogentity/#onrun">onRun</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="onsettingsopen">onSettingsOpen<a class="headerlink" href="#onsettingsopen" title="Permanent link">#</a></h3>
|
<h3 id="onsettingsopen">onSettingsOpen<a class="headerlink" href="#onsettingsopen" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>onSettingsOpen</strong>(): <em>void</em></p>
|
<p>▸ <strong>onSettingsOpen</strong>(): <code>void</code></p>
|
||||||
<p><em>Overrides <a href="../_common_api_index_._common_api_catalog_.catalogentity/">CatalogEntity</a>.<a href="../_common_api_index_._common_api_catalog_.catalogentity/#abstract-onsettingsopen">onSettingsOpen</a></em></p>
|
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/catalog-entities/web-link.ts#L41">src/common/catalog-entities/web-link.ts:41</a></em></p>
|
<p><code>void</code></p>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="overrides_4">Overrides<a class="headerlink" href="#overrides_4" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../common.catalog.catalogentity/">CatalogEntity</a>.<a href="../common.catalog.catalogentity/#onsettingsopen">onSettingsOpen</a></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
File diff suppressed because it is too large
Load Diff
@ -9,7 +9,7 @@
|
|||||||
<meta name="description" content="Documentation for Lens Extension API.">
|
<meta name="description" content="Documentation for Lens Extension API.">
|
||||||
|
|
||||||
|
|
||||||
<link rel="canonical" href="https://api-docs.k8slens.dev/master/extensions/api/classes/_common_api_index_._common_api_stores_.extensionstore/">
|
<link rel="canonical" href="https://api-docs.k8slens.dev/master/extensions/api/classes/common.store.extensionstore/">
|
||||||
|
|
||||||
|
|
||||||
<meta name="author" content="Mirantis, Inc.">
|
<meta name="author" content="Mirantis, Inc.">
|
||||||
@ -19,7 +19,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<title>Class: ExtensionStore ‹**T**› - Lens Extension API</title>
|
<title>Class: ExtensionStore - Lens Extension API</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -72,7 +72,7 @@
|
|||||||
<div data-md-component="skip">
|
<div data-md-component="skip">
|
||||||
|
|
||||||
|
|
||||||
<a href="#class-extensionstore-t" class="md-skip">
|
<a href="#class-extensionstoret" class="md-skip">
|
||||||
Skip to content
|
Skip to content
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
@ -103,7 +103,7 @@
|
|||||||
<div class="md-header-nav__topic">
|
<div class="md-header-nav__topic">
|
||||||
<span class="md-ellipsis">
|
<span class="md-ellipsis">
|
||||||
|
|
||||||
Class: ExtensionStore ‹**T**›
|
Class: ExtensionStore<T\>
|
||||||
|
|
||||||
</span>
|
</span>
|
||||||
</div>
|
</div>
|
||||||
@ -605,11 +605,11 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#index" class="md-nav__link">
|
<a href="#table-of-contents" class="md-nav__link">
|
||||||
Index
|
Table of contents
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
<nav class="md-nav" aria-label="Index">
|
<nav class="md-nav" aria-label="Table of contents">
|
||||||
<ul class="md-nav__list">
|
<ul class="md-nav__list">
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -654,8 +654,8 @@
|
|||||||
<ul class="md-nav__list">
|
<ul class="md-nav__list">
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#protected-constructor" class="md-nav__link">
|
<a href="#constructor" class="md-nav__link">
|
||||||
Protected constructor
|
constructor
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -674,8 +674,8 @@
|
|||||||
<ul class="md-nav__list">
|
<ul class="md-nav__list">
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#protected-extension" class="md-nav__link">
|
<a href="#extension" class="md-nav__link">
|
||||||
Protected extension
|
extension
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -688,22 +688,22 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#protected-params" class="md-nav__link">
|
<a href="#params" class="md-nav__link">
|
||||||
Protected params
|
params
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#protected-optional-storeconfig" class="md-nav__link">
|
<a href="#storeconfig" class="md-nav__link">
|
||||||
Protected Optional storeConfig
|
storeConfig
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#protected-syncdisposers" class="md-nav__link">
|
<a href="#syncdisposers" class="md-nav__link">
|
||||||
Protected syncDisposers
|
syncDisposers
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -736,15 +736,15 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#protected-syncmainchannel" class="md-nav__link">
|
<a href="#syncmainchannel" class="md-nav__link">
|
||||||
Protected syncMainChannel
|
syncMainChannel
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#protected-syncrendererchannel" class="md-nav__link">
|
<a href="#syncrendererchannel" class="md-nav__link">
|
||||||
Protected syncRendererChannel
|
syncRendererChannel
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -770,15 +770,15 @@
|
|||||||
<ul class="md-nav__list">
|
<ul class="md-nav__list">
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#protected-applywithoutsync" class="md-nav__link">
|
<a href="#applywithoutsync" class="md-nav__link">
|
||||||
Protected applyWithoutSync
|
applyWithoutSync
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#protected-cwd" class="md-nav__link">
|
<a href="#cwd" class="md-nav__link">
|
||||||
Protected cwd
|
cwd
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -798,15 +798,15 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#protected-abstract-fromstore" class="md-nav__link">
|
<a href="#fromstore" class="md-nav__link">
|
||||||
Protected Abstract fromStore
|
fromStore
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#protected-init" class="md-nav__link">
|
<a href="#init" class="md-nav__link">
|
||||||
Protected init
|
init
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -826,36 +826,36 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#protected-onmodelchange" class="md-nav__link">
|
<a href="#onmodelchange" class="md-nav__link">
|
||||||
Protected onModelChange
|
onModelChange
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#protected-onsync" class="md-nav__link">
|
<a href="#onsync" class="md-nav__link">
|
||||||
Protected onSync
|
onSync
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#protected-onsyncfrommain" class="md-nav__link">
|
<a href="#onsyncfrommain" class="md-nav__link">
|
||||||
Protected onSyncFromMain
|
onSyncFromMain
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#protected-savetofile" class="md-nav__link">
|
<a href="#savetofile" class="md-nav__link">
|
||||||
Protected saveToFile
|
saveToFile
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#abstract-tojson" class="md-nav__link">
|
<a href="#tojson" class="md-nav__link">
|
||||||
Abstract toJSON
|
toJSON
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -868,22 +868,22 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#static-createinstance" class="md-nav__link">
|
<a href="#createinstance" class="md-nav__link">
|
||||||
Static createInstance
|
createInstance
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#static-getinstance" class="md-nav__link">
|
<a href="#getinstance" class="md-nav__link">
|
||||||
Static getInstance
|
getInstance
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#static-resetinstance" class="md-nav__link">
|
<a href="#resetinstance" class="md-nav__link">
|
||||||
Static resetInstance
|
resetInstance
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -907,397 +907,476 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<h1 id="class-extensionstore-t">Class: ExtensionStore ‹<strong>T</strong>›<a class="headerlink" href="#class-extensionstore-t" title="Permanent link">#</a></h1>
|
<h1 id="class-extensionstoret">Class: ExtensionStore<T><a class="headerlink" href="#class-extensionstoret" title="Permanent link">#</a></h1>
|
||||||
|
<p><a href="../../modules/common/">Common</a>.<a href="../../modules/common.store/">Store</a>.ExtensionStore</p>
|
||||||
|
<p>Copyright (c) 2021 OpenLens Authors</p>
|
||||||
|
<p>Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||||
|
this software and associated documentation files (the "Software"), to deal in
|
||||||
|
the Software without restriction, including without limitation the rights to
|
||||||
|
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
||||||
|
the Software, and to permit persons to whom the Software is furnished to do so,
|
||||||
|
subject to the following conditions:</p>
|
||||||
|
<p>The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.</p>
|
||||||
|
<p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||||
|
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||||
|
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||||
|
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||||
|
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p>
|
||||||
<h2 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h2>
|
<h2 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h2>
|
||||||
<p>▪ <strong>T</strong></p>
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th align="left">Name</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>T</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
|
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
|
||||||
<ul>
|
<ul>
|
||||||
<li>BaseStore‹T›</li>
|
<li><code>BaseStore</code><T></li>
|
||||||
</ul>
|
</ul>
|
||||||
<p>↳ <strong>ExtensionStore</strong></p>
|
<p>↳ <strong>ExtensionStore</strong></p>
|
||||||
<h2 id="index">Index<a class="headerlink" href="#index" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructors">Constructors<a class="headerlink" href="#constructors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="./#protected-constructor">constructor</a></li>
|
<li><a href="./#constructor">constructor</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="properties">Properties<a class="headerlink" href="#properties" title="Permanent link">#</a></h3>
|
<h3 id="properties">Properties<a class="headerlink" href="#properties" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="./#protected-extension">extension</a></li>
|
<li><a href="./#extension">extension</a></li>
|
||||||
<li><a href="./#isloaded">isLoaded</a></li>
|
<li><a href="./#isloaded">isLoaded</a></li>
|
||||||
<li><a href="./#protected-params">params</a></li>
|
<li><a href="./#params">params</a></li>
|
||||||
<li><a href="./#protected-optional-storeconfig">storeConfig</a></li>
|
<li><a href="./#storeconfig">storeConfig</a></li>
|
||||||
<li><a href="./#protected-syncdisposers">syncDisposers</a></li>
|
<li><a href="./#syncdisposers">syncDisposers</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="./#name">name</a></li>
|
<li><a href="./#name">name</a></li>
|
||||||
<li><a href="./#path">path</a></li>
|
<li><a href="./#path">path</a></li>
|
||||||
<li><a href="./#protected-syncmainchannel">syncMainChannel</a></li>
|
<li><a href="./#syncmainchannel">syncMainChannel</a></li>
|
||||||
<li><a href="./#protected-syncrendererchannel">syncRendererChannel</a></li>
|
<li><a href="./#syncrendererchannel">syncRendererChannel</a></li>
|
||||||
<li><a href="./#whenloaded">whenLoaded</a></li>
|
<li><a href="./#whenloaded">whenLoaded</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">#</a></h3>
|
<h3 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="./#protected-applywithoutsync">applyWithoutSync</a></li>
|
<li><a href="./#applywithoutsync">applyWithoutSync</a></li>
|
||||||
<li><a href="./#protected-cwd">cwd</a></li>
|
<li><a href="./#cwd">cwd</a></li>
|
||||||
<li><a href="./#disablesync">disableSync</a></li>
|
<li><a href="./#disablesync">disableSync</a></li>
|
||||||
<li><a href="./#enablesync">enableSync</a></li>
|
<li><a href="./#enablesync">enableSync</a></li>
|
||||||
<li><a href="./#protected-abstract-fromstore">fromStore</a></li>
|
<li><a href="./#fromstore">fromStore</a></li>
|
||||||
<li><a href="./#protected-init">init</a></li>
|
<li><a href="./#init">init</a></li>
|
||||||
<li><a href="./#load">load</a></li>
|
<li><a href="./#load">load</a></li>
|
||||||
<li><a href="./#loadextension">loadExtension</a></li>
|
<li><a href="./#loadextension">loadExtension</a></li>
|
||||||
<li><a href="./#protected-onmodelchange">onModelChange</a></li>
|
<li><a href="./#onmodelchange">onModelChange</a></li>
|
||||||
<li><a href="./#protected-onsync">onSync</a></li>
|
<li><a href="./#onsync">onSync</a></li>
|
||||||
<li><a href="./#protected-onsyncfrommain">onSyncFromMain</a></li>
|
<li><a href="./#onsyncfrommain">onSyncFromMain</a></li>
|
||||||
<li><a href="./#protected-savetofile">saveToFile</a></li>
|
<li><a href="./#savetofile">saveToFile</a></li>
|
||||||
<li><a href="./#abstract-tojson">toJSON</a></li>
|
<li><a href="./#tojson">toJSON</a></li>
|
||||||
<li><a href="./#unregisteripclistener">unregisterIpcListener</a></li>
|
<li><a href="./#unregisteripclistener">unregisterIpcListener</a></li>
|
||||||
<li><a href="./#static-createinstance">createInstance</a></li>
|
<li><a href="./#createinstance">createInstance</a></li>
|
||||||
<li><a href="./#static-getinstance">getInstance</a></li>
|
<li><a href="./#getinstance">getInstance</a></li>
|
||||||
<li><a href="./#static-resetinstance">resetInstance</a></li>
|
<li><a href="./#resetinstance">resetInstance</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
||||||
<h3 id="protected-constructor"><code>Protected</code> constructor<a class="headerlink" href="#protected-constructor" title="Permanent link">#</a></h3>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
<p>+ <strong>new ExtensionStore</strong>(<code>params</code>: BaseStoreParams): <em><a href="./">ExtensionStore</a></em></p>
|
<p>• <code>Protected</code> <strong>new ExtensionStore</strong><T>(<code>params</code>)</p>
|
||||||
<p><em>Inherited from <a href="./">ExtensionStore</a>.<a href="./#protected-constructor">constructor</a></em></p>
|
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
||||||
<p><em>Overrides <a href="../_common_api_index_._common_api_utils_.singleton/">Singleton</a>.<a href="../_common_api_index_._common_api_utils_.singleton/#constructor">constructor</a></em></p>
|
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/base-store.ts#L49">src/common/base-store.ts:49</a></em></p>
|
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>params</code></td>
|
<td align="left"><code>T</code></td>
|
||||||
<td>BaseStoreParams</td>
|
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em><a href="./">ExtensionStore</a></em></p>
|
<h4 id="parameters">Parameters<a class="headerlink" href="#parameters" 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>params</code></td>
|
||||||
|
<td align="left"><code>BaseStoreParams</code><any></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||||
|
<p>BaseStore<T>.constructor</p>
|
||||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||||
<h3 id="protected-extension"><code>Protected</code> extension<a class="headerlink" href="#protected-extension" title="Permanent link">#</a></h3>
|
<h3 id="extension">extension<a class="headerlink" href="#extension" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>extension</strong>: <em>LensExtension</em></p>
|
<p>• <code>Protected</code> <strong>extension</strong>: <code>LensExtension</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/extensions/extension-store.ts#L27">src/extensions/extension-store.ts:27</a></em></p>
|
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isloaded">isLoaded<a class="headerlink" href="#isloaded" title="Permanent link">#</a></h3>
|
<h3 id="isloaded">isLoaded<a class="headerlink" href="#isloaded" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>isLoaded</strong>: <em>boolean</em> = false</p>
|
<p>• <strong>isLoaded</strong>: <code>boolean</code> = false</p>
|
||||||
<p><em>Inherited from <a href="./">ExtensionStore</a>.<a href="./#isloaded">isLoaded</a></em></p>
|
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/base-store.ts#L45">src/common/base-store.ts:45</a></em></p>
|
<p>BaseStore.isLoaded</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="protected-params"><code>Protected</code> params<a class="headerlink" href="#protected-params" title="Permanent link">#</a></h3>
|
<h3 id="params">params<a class="headerlink" href="#params" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>params</strong>: <em>BaseStoreParams</em></p>
|
<p>• <code>Protected</code> <strong>params</strong>: <code>BaseStoreParams</code><any></p>
|
||||||
<p><em>Inherited from <a href="./">ExtensionStore</a>.<a href="./#protected-params">params</a></em></p>
|
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/base-store.ts#L51">src/common/base-store.ts:51</a></em></p>
|
<p>BaseStore.params</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="protected-optional-storeconfig"><code>Protected</code> <code>Optional</code> storeConfig<a class="headerlink" href="#protected-optional-storeconfig" title="Permanent link">#</a></h3>
|
<h3 id="storeconfig">storeConfig<a class="headerlink" href="#storeconfig" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>storeConfig</strong>? : <em>Config‹T›</em></p>
|
<p>• <code>Protected</code> <code>Optional</code> <strong>storeConfig</strong>: <code>Conf</code><T></p>
|
||||||
<p><em>Inherited from <a href="./">ExtensionStore</a>.<a href="./#protected-optional-storeconfig">storeConfig</a></em></p>
|
<h4 id="inherited-from_3">Inherited from<a class="headerlink" href="#inherited-from_3" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/base-store.ts#L42">src/common/base-store.ts:42</a></em></p>
|
<p>BaseStore.storeConfig</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="protected-syncdisposers"><code>Protected</code> syncDisposers<a class="headerlink" href="#protected-syncdisposers" title="Permanent link">#</a></h3>
|
<h3 id="syncdisposers">syncDisposers<a class="headerlink" href="#syncdisposers" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>syncDisposers</strong>: <em>Disposer[]</em> = []</p>
|
<p>• <code>Protected</code> <strong>syncDisposers</strong>: <code>Disposer</code>[] = []</p>
|
||||||
<p><em>Inherited from <a href="./">ExtensionStore</a>.<a href="./#protected-syncdisposers">syncDisposers</a></em></p>
|
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/base-store.ts#L43">src/common/base-store.ts:43</a></em></p>
|
<p>BaseStore.syncDisposers</p>
|
||||||
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
||||||
<h3 id="name">name<a class="headerlink" href="#name" title="Permanent link">#</a></h3>
|
<h3 id="name">name<a class="headerlink" href="#name" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>get name</strong>(): <em>string</em></p>
|
<p>• <code>get</code> <strong>name</strong>(): <code>string</code></p>
|
||||||
<p><em>Inherited from <a href="./">ExtensionStore</a>.<a href="./#name">name</a></em></p>
|
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/base-store.ts#L63">src/common/base-store.ts:63</a></em></p>
|
<p><code>string</code></p>
|
||||||
<p><strong>Returns:</strong> <em>string</em></p>
|
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="path">path<a class="headerlink" href="#path" title="Permanent link">#</a></h3>
|
<h3 id="path">path<a class="headerlink" href="#path" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>get path</strong>(): <em>string</em></p>
|
<p>• <code>get</code> <strong>path</strong>(): <code>string</code></p>
|
||||||
<p><em>Inherited from <a href="./">ExtensionStore</a>.<a href="./#path">path</a></em></p>
|
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/base-store.ts#L75">src/common/base-store.ts:75</a></em></p>
|
<p><code>string</code></p>
|
||||||
<p><strong>Returns:</strong> <em>string</em></p>
|
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="protected-syncmainchannel"><code>Protected</code> syncMainChannel<a class="headerlink" href="#protected-syncmainchannel" title="Permanent link">#</a></h3>
|
<h3 id="syncmainchannel">syncMainChannel<a class="headerlink" href="#syncmainchannel" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>get syncMainChannel</strong>(): <em>string</em></p>
|
<p>• <code>Protected</code> <code>get</code> <strong>syncMainChannel</strong>(): <code>string</code></p>
|
||||||
<p><em>Inherited from <a href="./">ExtensionStore</a>.<a href="./#protected-syncmainchannel">syncMainChannel</a></em></p>
|
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/base-store.ts#L71">src/common/base-store.ts:71</a></em></p>
|
<p><code>string</code></p>
|
||||||
<p><strong>Returns:</strong> <em>string</em></p>
|
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="protected-syncrendererchannel"><code>Protected</code> syncRendererChannel<a class="headerlink" href="#protected-syncrendererchannel" title="Permanent link">#</a></h3>
|
<h3 id="syncrendererchannel">syncRendererChannel<a class="headerlink" href="#syncrendererchannel" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>get syncRendererChannel</strong>(): <em>string</em></p>
|
<p>• <code>Protected</code> <code>get</code> <strong>syncRendererChannel</strong>(): <code>string</code></p>
|
||||||
<p><em>Inherited from <a href="./">ExtensionStore</a>.<a href="./#protected-syncrendererchannel">syncRendererChannel</a></em></p>
|
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/base-store.ts#L67">src/common/base-store.ts:67</a></em></p>
|
<p><code>string</code></p>
|
||||||
<p><strong>Returns:</strong> <em>string</em></p>
|
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="whenloaded">whenLoaded<a class="headerlink" href="#whenloaded" title="Permanent link">#</a></h3>
|
<h3 id="whenloaded">whenLoaded<a class="headerlink" href="#whenloaded" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>get whenLoaded</strong>(): <em>Promise‹void› & object</em></p>
|
<p>• <code>get</code> <strong>whenLoaded</strong>(): <code>Promise</code><void\> & { <code>cancel</code>: () => <code>void</code> }</p>
|
||||||
<p><em>Inherited from <a href="./">ExtensionStore</a>.<a href="./#whenloaded">whenLoaded</a></em></p>
|
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/base-store.ts#L47">src/common/base-store.ts:47</a></em></p>
|
<p><code>Promise</code><void\> & { <code>cancel</code>: () => <code>void</code> }</p>
|
||||||
<p><strong>Returns:</strong> <em>Promise‹void› & object</em></p>
|
|
||||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||||
<h3 id="protected-applywithoutsync"><code>Protected</code> applyWithoutSync<a class="headerlink" href="#protected-applywithoutsync" title="Permanent link">#</a></h3>
|
<h3 id="applywithoutsync">applyWithoutSync<a class="headerlink" href="#applywithoutsync" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>applyWithoutSync</strong>(<code>callback</code>: function): <em>void</em></p>
|
<p>▸ <code>Protected</code> <strong>applyWithoutSync</strong>(<code>callback</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="./">ExtensionStore</a>.<a href="./#protected-applywithoutsync">applyWithoutSync</a></em></p>
|
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/base-store.ts#L165">src/common/base-store.ts:165</a></em></p>
|
<table>
|
||||||
<p><strong>Parameters:</strong></p>
|
<thead>
|
||||||
<p>▪ <strong>callback</strong>: <em>function</em></p>
|
<tr>
|
||||||
<p>▸ (): <em>void</em></p>
|
<th align="left">Name</th>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<th align="left">Type</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>callback</code></td>
|
||||||
|
<td align="left">() => <code>void</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
||||||
|
<p>BaseStore.applyWithoutSync</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="protected-cwd"><code>Protected</code> cwd<a class="headerlink" href="#protected-cwd" title="Permanent link">#</a></h3>
|
<h3 id="cwd">cwd<a class="headerlink" href="#cwd" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>cwd</strong>(): <em>string</em></p>
|
<p>▸ <code>Protected</code> <strong>cwd</strong>(): <code>string</code></p>
|
||||||
<p><em>Overrides void</em></p>
|
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/extensions/extension-store.ts#L41">src/extensions/extension-store.ts:41</a></em></p>
|
<p><code>string</code></p>
|
||||||
<p><strong>Returns:</strong> <em>string</em></p>
|
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
||||||
|
<p>BaseStore.cwd</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="disablesync">disableSync<a class="headerlink" href="#disablesync" title="Permanent link">#</a></h3>
|
<h3 id="disablesync">disableSync<a class="headerlink" href="#disablesync" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>disableSync</strong>(): <em>void</em></p>
|
<p>▸ <strong>disableSync</strong>(): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="./">ExtensionStore</a>.<a href="./#disablesync">disableSync</a></em></p>
|
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/base-store.ts#L160">src/common/base-store.ts:160</a></em></p>
|
<p><code>void</code></p>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||||
|
<p>BaseStore.disableSync</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="enablesync">enableSync<a class="headerlink" href="#enablesync" title="Permanent link">#</a></h3>
|
<h3 id="enablesync">enableSync<a class="headerlink" href="#enablesync" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>enableSync</strong>(): <em>void</em></p>
|
<p>▸ <strong>enableSync</strong>(): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="./">ExtensionStore</a>.<a href="./#enablesync">enableSync</a></em></p>
|
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/base-store.ts#L119">src/common/base-store.ts:119</a></em></p>
|
<p><code>void</code></p>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
||||||
|
<p>BaseStore.enableSync</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="protected-abstract-fromstore"><code>Protected</code> <code>Abstract</code> fromStore<a class="headerlink" href="#protected-abstract-fromstore" title="Permanent link">#</a></h3>
|
<h3 id="fromstore">fromStore<a class="headerlink" href="#fromstore" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>fromStore</strong>(<code>data</code>: T): <em>void</em></p>
|
<p>▸ <code>Protected</code> <code>Abstract</code> <strong>fromStore</strong>(<code>data</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="./">ExtensionStore</a>.<a href="./#protected-abstract-fromstore">fromStore</a></em></p>
|
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/base-store.ts#L195">src/common/base-store.ts:195</a></em></p>
|
|
||||||
<p>fromStore is called internally when a child class syncs with the file
|
<p>fromStore is called internally when a child class syncs with the file
|
||||||
system.</p>
|
system.</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
<th>Description</th>
|
<th align="left">Description</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>data</code></td>
|
<td align="left"><code>data</code></td>
|
||||||
<td>T</td>
|
<td align="left"><code>T</code></td>
|
||||||
<td>the parsed information read from the stored JSON file</td>
|
<td align="left">the parsed information read from the stored JSON file</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
||||||
|
<p>BaseStore.fromStore</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="protected-init"><code>Protected</code> init<a class="headerlink" href="#protected-init" title="Permanent link">#</a></h3>
|
<h3 id="init">init<a class="headerlink" href="#init" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>init</strong>(): <em>Promise‹void›</em></p>
|
<p>▸ <code>Protected</code> <strong>init</strong>(): <code>Promise</code><void></p>
|
||||||
<p><em>Inherited from <a href="./">ExtensionStore</a>.<a href="./#protected-init">init</a></em></p>
|
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/base-store.ts#L79">src/common/base-store.ts:79</a></em></p>
|
<p><code>Promise</code><void></p>
|
||||||
<p><strong>Returns:</strong> <em>Promise‹void›</em></p>
|
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
||||||
|
<p>BaseStore.init</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="load">load<a class="headerlink" href="#load" title="Permanent link">#</a></h3>
|
<h3 id="load">load<a class="headerlink" href="#load" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>load</strong>(): <em>Promise‹void›</em></p>
|
<p>▸ <strong>load</strong>(): <code>Promise</code><void></p>
|
||||||
<p><em>Overrides void</em></p>
|
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/extensions/extension-store.ts#L35">src/extensions/extension-store.ts:35</a></em></p>
|
<p><code>Promise</code><void></p>
|
||||||
<p><strong>Returns:</strong> <em>Promise‹void›</em></p>
|
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
||||||
|
<p>BaseStore.load</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="loadextension">loadExtension<a class="headerlink" href="#loadextension" title="Permanent link">#</a></h3>
|
<h3 id="loadextension">loadExtension<a class="headerlink" href="#loadextension" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>loadExtension</strong>(<code>extension</code>: LensExtension): <em>Promise‹void›</em></p>
|
<p>▸ <strong>loadExtension</strong>(<code>extension</code>): <code>Promise</code><void></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/extensions/extension-store.ts#L29">src/extensions/extension-store.ts:29</a></em></p>
|
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>extension</code></td>
|
<td align="left"><code>extension</code></td>
|
||||||
<td>LensExtension</td>
|
<td align="left"><code>LensExtension</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>Promise‹void›</em></p>
|
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><void></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="protected-onmodelchange"><code>Protected</code> onModelChange<a class="headerlink" href="#protected-onmodelchange" title="Permanent link">#</a></h3>
|
<h3 id="onmodelchange">onModelChange<a class="headerlink" href="#onmodelchange" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>onModelChange</strong>(<code>model</code>: T): <em>Promise‹void›</em></p>
|
<p>▸ <code>Protected</code> <strong>onModelChange</strong>(<code>model</code>): <code>Promise</code><void></p>
|
||||||
<p><em>Inherited from <a href="./">ExtensionStore</a>.<a href="./#protected-onmodelchange">onModelChange</a></em></p>
|
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/base-store.ts#L181">src/common/base-store.ts:181</a></em></p>
|
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>model</code></td>
|
<td align="left"><code>model</code></td>
|
||||||
<td>T</td>
|
<td align="left"><code>T</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>Promise‹void›</em></p>
|
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><void></p>
|
||||||
|
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
||||||
|
<p>BaseStore.onModelChange</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="protected-onsync"><code>Protected</code> onSync<a class="headerlink" href="#protected-onsync" title="Permanent link">#</a></h3>
|
<h3 id="onsync">onSync<a class="headerlink" href="#onsync" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>onSync</strong>(<code>model</code>: T): <em>void</em></p>
|
<p>▸ <code>Protected</code> <strong>onSync</strong>(<code>model</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="./">ExtensionStore</a>.<a href="./#protected-onsync">onSync</a></em></p>
|
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/base-store.ts#L174">src/common/base-store.ts:174</a></em></p>
|
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>model</code></td>
|
<td align="left"><code>model</code></td>
|
||||||
<td>T</td>
|
<td align="left"><code>T</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||||
|
<p>BaseStore.onSync</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="protected-onsyncfrommain"><code>Protected</code> onSyncFromMain<a class="headerlink" href="#protected-onsyncfrommain" title="Permanent link">#</a></h3>
|
<h3 id="onsyncfrommain">onSyncFromMain<a class="headerlink" href="#onsyncfrommain" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>onSyncFromMain</strong>(<code>model</code>: T): <em>void</em></p>
|
<p>▸ <code>Protected</code> <strong>onSyncFromMain</strong>(<code>model</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="./">ExtensionStore</a>.<a href="./#protected-onsyncfrommain">onSyncFromMain</a></em></p>
|
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/base-store.ts#L149">src/common/base-store.ts:149</a></em></p>
|
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>model</code></td>
|
<td align="left"><code>model</code></td>
|
||||||
<td>T</td>
|
<td align="left"><code>T</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||||
|
<p>BaseStore.onSyncFromMain</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="protected-savetofile"><code>Protected</code> saveToFile<a class="headerlink" href="#protected-savetofile" title="Permanent link">#</a></h3>
|
<h3 id="savetofile">saveToFile<a class="headerlink" href="#savetofile" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>saveToFile</strong>(<code>model</code>: T): <em>Promise‹void›</em></p>
|
<p>▸ <code>Protected</code> <strong>saveToFile</strong>(<code>model</code>): <code>Promise</code><void></p>
|
||||||
<p><em>Inherited from <a href="./">ExtensionStore</a>.<a href="./#protected-savetofile">saveToFile</a></em></p>
|
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/base-store.ts#L108">src/common/base-store.ts:108</a></em></p>
|
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>model</code></td>
|
<td align="left"><code>model</code></td>
|
||||||
<td>T</td>
|
<td align="left"><code>T</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>Promise‹void›</em></p>
|
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><void></p>
|
||||||
|
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||||
|
<p>BaseStore.saveToFile</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="abstract-tojson"><code>Abstract</code> toJSON<a class="headerlink" href="#abstract-tojson" title="Permanent link">#</a></h3>
|
<h3 id="tojson">toJSON<a class="headerlink" href="#tojson" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>toJSON</strong>(): <em>T</em></p>
|
<p>▸ <code>Abstract</code> <strong>toJSON</strong>(): <code>T</code></p>
|
||||||
<p><em>Inherited from <a href="./">ExtensionStore</a>.<a href="./#abstract-tojson">toJSON</a></em></p>
|
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/base-store.ts#L204">src/common/base-store.ts:204</a></em></p>
|
|
||||||
<p>toJSON is called when syncing the store to the filesystem. It should
|
<p>toJSON is called when syncing the store to the filesystem. It should
|
||||||
produce a JSON serializable object representation of the current state.</p>
|
produce a JSON serializable object representation of the current state.</p>
|
||||||
<p>It is recommended that a round trip is valid. Namely, calling
|
<p>It is recommended that a round trip is valid. Namely, calling
|
||||||
<code>this.fromStore(this.toJSON())</code> shouldn't change the state.</p>
|
<code>this.fromStore(this.toJSON())</code> shouldn't change the state.</p>
|
||||||
<p><strong>Returns:</strong> <em>T</em></p>
|
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>T</code></p>
|
||||||
|
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
||||||
|
<p>BaseStore.toJSON</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="unregisteripclistener">unregisterIpcListener<a class="headerlink" href="#unregisteripclistener" title="Permanent link">#</a></h3>
|
<h3 id="unregisteripclistener">unregisterIpcListener<a class="headerlink" href="#unregisteripclistener" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>unregisterIpcListener</strong>(): <em>void</em></p>
|
<p>▸ <strong>unregisterIpcListener</strong>(): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="./">ExtensionStore</a>.<a href="./#unregisteripclistener">unregisterIpcListener</a></em></p>
|
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/base-store.ts#L155">src/common/base-store.ts:155</a></em></p>
|
<p><code>void</code></p>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
||||||
|
<p>BaseStore.unregisterIpcListener</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="static-createinstance"><code>Static</code> createInstance<a class="headerlink" href="#static-createinstance" title="Permanent link">#</a></h3>
|
<h3 id="createinstance">createInstance<a class="headerlink" href="#createinstance" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>createInstance</strong>‹<strong>T</strong>, <strong>R</strong>›(<code>this</code>: StaticThis‹T, R›, ...<code>args</code>: R): <em>T</em></p>
|
<p>▸ <code>Static</code> <strong>createInstance</strong><T, R>(...<code>args</code>): <code>T</code></p>
|
||||||
<p><em>Inherited from <a href="./">ExtensionStore</a>.<a href="./#static-createinstance">createInstance</a></em></p>
|
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/utils/singleton.ts#L46">src/common/utils/singleton.ts:46</a></em></p>
|
|
||||||
<p>Creates the single instance of the child class if one was not already created.</p>
|
<p>Creates the single instance of the child class if one was not already created.</p>
|
||||||
<p>Multiple calls will return the same instance.
|
<p>Multiple calls will return the same instance.
|
||||||
Essentially throwing away the arguments to the subsequent calls.</p>
|
Essentially throwing away the arguments to the subsequent calls.</p>
|
||||||
<p>Note: this is a racy function, if two (or more) calls are racing to call this function
|
<p>Note: this is a racy function, if two (or more) calls are racing to call this function
|
||||||
only the first's arguments will be used.</p>
|
only the first's arguments will be used.</p>
|
||||||
<p><strong>Type parameters:</strong></p>
|
<h4 id="type-parameters_2">Type parameters<a class="headerlink" href="#type-parameters_2" title="Permanent link">#</a></h4>
|
||||||
<p>▪ <strong>T</strong></p>
|
|
||||||
<p>▪ <strong>R</strong>: <em>any[]</em></p>
|
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
<th>Description</th>
|
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>this</code></td>
|
<td align="left"><code>T</code></td>
|
||||||
<td>StaticThis‹T, R›</td>
|
<td align="left"><code>T</code></td>
|
||||||
<td>Implicit argument that is the child class type</td>
|
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>...args</code></td>
|
<td align="left"><code>R</code></td>
|
||||||
<td>R</td>
|
<td align="left"><code>R</code>: <code>any</code>[]</td>
|
||||||
<td>The constructor arguments for the child class</td>
|
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>T</em></p>
|
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" 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>...args</code></td>
|
||||||
|
<td align="left"><code>R</code></td>
|
||||||
|
<td align="left">The constructor arguments for the child class</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>T</code></p>
|
||||||
<p>An instance of the child class</p>
|
<p>An instance of the child class</p>
|
||||||
|
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
||||||
|
<p>BaseStore.createInstance</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="static-getinstance"><code>Static</code> getInstance<a class="headerlink" href="#static-getinstance" title="Permanent link">#</a></h3>
|
<h3 id="getinstance">getInstance<a class="headerlink" href="#getinstance" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>getInstance</strong>‹<strong>T</strong>, <strong>R</strong>›(<code>this</code>: StaticThis‹T, R›, <code>strict</code>: boolean): <em>T | undefined</em></p>
|
<p>▸ <code>Static</code> <strong>getInstance</strong><T, R>(<code>strict</code>): <code>T</code></p>
|
||||||
<p><em>Inherited from <a href="./">ExtensionStore</a>.<a href="./#static-getinstance">getInstance</a></em></p>
|
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/utils/singleton.ts#L67">src/common/utils/singleton.ts:67</a></em></p>
|
|
||||||
<p>Get the instance of the child class that was previously created.</p>
|
<p>Get the instance of the child class that was previously created.</p>
|
||||||
<p><strong>Type parameters:</strong></p>
|
<h4 id="type-parameters_3">Type parameters<a class="headerlink" href="#type-parameters_3" title="Permanent link">#</a></h4>
|
||||||
<p>▪ <strong>T</strong></p>
|
|
||||||
<p>▪ <strong>R</strong>: <em>any[]</em></p>
|
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
<th>Default</th>
|
|
||||||
<th>Description</th>
|
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>this</code></td>
|
<td align="left"><code>T</code></td>
|
||||||
<td>StaticThis‹T, R›</td>
|
<td align="left"><code>T</code></td>
|
||||||
<td>-</td>
|
|
||||||
<td>Implicit argument that is the child class type</td>
|
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>strict</code></td>
|
<td align="left"><code>R</code></td>
|
||||||
<td>boolean</td>
|
<td align="left"><code>R</code>: <code>any</code>[]</td>
|
||||||
<td>true</td>
|
|
||||||
<td>If false will return <code>undefined</code> instead of throwing when an instance doesn't exist. Default: <code>true</code></td>
|
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>T | undefined</em></p>
|
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" 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>strict</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
<td align="left">If false will return <code>undefined</code> instead of throwing when an instance doesn't exist. Default: <code>true</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>T</code></p>
|
||||||
<p>An instance of the child class</p>
|
<p>An instance of the child class</p>
|
||||||
|
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||||
|
<p>BaseStore.getInstance</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="static-resetinstance"><code>Static</code> resetInstance<a class="headerlink" href="#static-resetinstance" title="Permanent link">#</a></h3>
|
<h3 id="resetinstance">resetInstance<a class="headerlink" href="#resetinstance" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>resetInstance</strong>(): <em>void</em></p>
|
<p>▸ <code>Static</code> <strong>resetInstance</strong>(): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="./">ExtensionStore</a>.<a href="./#static-resetinstance">resetInstance</a></em></p>
|
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/utils/singleton.ts#L82">src/common/utils/singleton.ts:82</a></em></p>
|
|
||||||
<p>Delete the instance of the child class.</p>
|
<p>Delete the instance of the child class.</p>
|
||||||
<p>Note: this doesn't prevent callers of <code>getInstance</code> from storing the result in a global.</p>
|
<p>Note: this doesn't prevent callers of <code>getInstance</code> from storing the result in a global.</p>
|
||||||
<p>There is <em>no</em> way in JS or TS to prevent globals like that.</p>
|
<p>There is <em>no</em> way in JS or TS to prevent globals like that.</p>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_18">Inherited from<a class="headerlink" href="#inherited-from_18" title="Permanent link">#</a></h4>
|
||||||
|
<p>BaseStore.resetInstance</p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -9,7 +9,7 @@
|
|||||||
<meta name="description" content="Documentation for Lens Extension API.">
|
<meta name="description" content="Documentation for Lens Extension API.">
|
||||||
|
|
||||||
|
|
||||||
<link rel="canonical" href="https://api-docs.k8slens.dev/master/extensions/api/classes/_common_api_index_._common_api_utils_.singleton/">
|
<link rel="canonical" href="https://api-docs.k8slens.dev/master/extensions/api/classes/common.util.singleton/">
|
||||||
|
|
||||||
|
|
||||||
<meta name="author" content="Mirantis, Inc.">
|
<meta name="author" content="Mirantis, Inc.">
|
||||||
@ -591,18 +591,11 @@
|
|||||||
<ul class="md-nav__list" data-md-scrollfix>
|
<ul class="md-nav__list" data-md-scrollfix>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#hierarchy" class="md-nav__link">
|
<a href="#table-of-contents" class="md-nav__link">
|
||||||
Hierarchy
|
Table of contents
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
<nav class="md-nav" aria-label="Table of contents">
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#index" class="md-nav__link">
|
|
||||||
Index
|
|
||||||
</a>
|
|
||||||
|
|
||||||
<nav class="md-nav" aria-label="Index">
|
|
||||||
<ul class="md-nav__list">
|
<ul class="md-nav__list">
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -653,22 +646,22 @@
|
|||||||
<ul class="md-nav__list">
|
<ul class="md-nav__list">
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#static-createinstance" class="md-nav__link">
|
<a href="#createinstance" class="md-nav__link">
|
||||||
Static createInstance
|
createInstance
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#static-getinstance" class="md-nav__link">
|
<a href="#getinstance" class="md-nav__link">
|
||||||
Static getInstance
|
getInstance
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#static-resetinstance" class="md-nav__link">
|
<a href="#resetinstance" class="md-nav__link">
|
||||||
Static resetInstance
|
resetInstance
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -693,105 +686,134 @@
|
|||||||
|
|
||||||
|
|
||||||
<h1 id="class-singleton">Class: Singleton<a class="headerlink" href="#class-singleton" title="Permanent link">#</a></h1>
|
<h1 id="class-singleton">Class: Singleton<a class="headerlink" href="#class-singleton" title="Permanent link">#</a></h1>
|
||||||
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
|
<p><a href="../../modules/common/">Common</a>.<a href="../../modules/common.util/">Util</a>.Singleton</p>
|
||||||
<ul>
|
<p>Copyright (c) 2021 OpenLens Authors</p>
|
||||||
<li><strong>Singleton</strong></li>
|
<p>Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||||
</ul>
|
this software and associated documentation files (the "Software"), to deal in
|
||||||
<h2 id="index">Index<a class="headerlink" href="#index" title="Permanent link">#</a></h2>
|
the Software without restriction, including without limitation the rights to
|
||||||
|
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
||||||
|
the Software, and to permit persons to whom the Software is furnished to do so,
|
||||||
|
subject to the following conditions:</p>
|
||||||
|
<p>The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.</p>
|
||||||
|
<p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||||
|
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||||
|
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||||
|
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||||
|
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p>
|
||||||
|
<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>
|
<h3 id="constructors">Constructors<a class="headerlink" href="#constructors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="./#constructor">constructor</a></li>
|
<li><a href="./#constructor">constructor</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">#</a></h3>
|
<h3 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="./#static-createinstance">createInstance</a></li>
|
<li><a href="./#createinstance">createInstance</a></li>
|
||||||
<li><a href="./#static-getinstance">getInstance</a></li>
|
<li><a href="./#getinstance">getInstance</a></li>
|
||||||
<li><a href="./#static-resetinstance">resetInstance</a></li>
|
<li><a href="./#resetinstance">resetInstance</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
<p>+ <strong>new Singleton</strong>(): <em><a href="./">Singleton</a></em></p>
|
<p>• <strong>new Singleton</strong>()</p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/utils/singleton.ts#L26">src/common/utils/singleton.ts:26</a></em></p>
|
|
||||||
<p><strong>Returns:</strong> <em><a href="./">Singleton</a></em></p>
|
|
||||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||||
<h3 id="static-createinstance"><code>Static</code> createInstance<a class="headerlink" href="#static-createinstance" title="Permanent link">#</a></h3>
|
<h3 id="createinstance">createInstance<a class="headerlink" href="#createinstance" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>createInstance</strong>‹<strong>T</strong>, <strong>R</strong>›(<code>this</code>: StaticThis‹T, R›, ...<code>args</code>: R): <em>T</em></p>
|
<p>▸ <code>Static</code> <strong>createInstance</strong><T, R>(...<code>args</code>): <code>T</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/utils/singleton.ts#L46">src/common/utils/singleton.ts:46</a></em></p>
|
|
||||||
<p>Creates the single instance of the child class if one was not already created.</p>
|
<p>Creates the single instance of the child class if one was not already created.</p>
|
||||||
<p>Multiple calls will return the same instance.
|
<p>Multiple calls will return the same instance.
|
||||||
Essentially throwing away the arguments to the subsequent calls.</p>
|
Essentially throwing away the arguments to the subsequent calls.</p>
|
||||||
<p>Note: this is a racy function, if two (or more) calls are racing to call this function
|
<p>Note: this is a racy function, if two (or more) calls are racing to call this function
|
||||||
only the first's arguments will be used.</p>
|
only the first's arguments will be used.</p>
|
||||||
<p><strong>Type parameters:</strong></p>
|
<h4 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h4>
|
||||||
<p>▪ <strong>T</strong></p>
|
|
||||||
<p>▪ <strong>R</strong>: <em>any[]</em></p>
|
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
<th>Description</th>
|
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>this</code></td>
|
<td align="left"><code>T</code></td>
|
||||||
<td>StaticThis‹T, R›</td>
|
<td align="left"><code>T</code></td>
|
||||||
<td>Implicit argument that is the child class type</td>
|
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>...args</code></td>
|
<td align="left"><code>R</code></td>
|
||||||
<td>R</td>
|
<td align="left"><code>R</code>: <code>any</code>[]</td>
|
||||||
<td>The constructor arguments for the child class</td>
|
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>T</em></p>
|
<h4 id="parameters">Parameters<a class="headerlink" href="#parameters" 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>...args</code></td>
|
||||||
|
<td align="left"><code>R</code></td>
|
||||||
|
<td align="left">The constructor arguments for the child class</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>T</code></p>
|
||||||
<p>An instance of the child class</p>
|
<p>An instance of the child class</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="static-getinstance"><code>Static</code> getInstance<a class="headerlink" href="#static-getinstance" title="Permanent link">#</a></h3>
|
<h3 id="getinstance">getInstance<a class="headerlink" href="#getinstance" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>getInstance</strong>‹<strong>T</strong>, <strong>R</strong>›(<code>this</code>: StaticThis‹T, R›, <code>strict</code>: boolean): <em>T | undefined</em></p>
|
<p>▸ <code>Static</code> <strong>getInstance</strong><T, R>(<code>strict</code>): <code>T</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/utils/singleton.ts#L67">src/common/utils/singleton.ts:67</a></em></p>
|
|
||||||
<p>Get the instance of the child class that was previously created.</p>
|
<p>Get the instance of the child class that was previously created.</p>
|
||||||
<p><strong>Type parameters:</strong></p>
|
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
||||||
<p>▪ <strong>T</strong></p>
|
|
||||||
<p>▪ <strong>R</strong>: <em>any[]</em></p>
|
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
<th>Default</th>
|
|
||||||
<th>Description</th>
|
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>this</code></td>
|
<td align="left"><code>T</code></td>
|
||||||
<td>StaticThis‹T, R›</td>
|
<td align="left"><code>T</code></td>
|
||||||
<td>-</td>
|
|
||||||
<td>Implicit argument that is the child class type</td>
|
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>strict</code></td>
|
<td align="left"><code>R</code></td>
|
||||||
<td>boolean</td>
|
<td align="left"><code>R</code>: <code>any</code>[]</td>
|
||||||
<td>true</td>
|
|
||||||
<td>If false will return <code>undefined</code> instead of throwing when an instance doesn't exist. Default: <code>true</code></td>
|
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>T | undefined</em></p>
|
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th align="left">Name</th>
|
||||||
|
<th align="left">Type</th>
|
||||||
|
<th align="left">Description</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>strict</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
<td align="left">If false will return <code>undefined</code> instead of throwing when an instance doesn't exist. Default: <code>true</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>T</code></p>
|
||||||
<p>An instance of the child class</p>
|
<p>An instance of the child class</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="static-resetinstance"><code>Static</code> resetInstance<a class="headerlink" href="#static-resetinstance" title="Permanent link">#</a></h3>
|
<h3 id="resetinstance">resetInstance<a class="headerlink" href="#resetinstance" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>resetInstance</strong>(): <em>void</em></p>
|
<p>▸ <code>Static</code> <strong>resetInstance</strong>(): <code>void</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/utils/singleton.ts#L82">src/common/utils/singleton.ts:82</a></em></p>
|
|
||||||
<p>Delete the instance of the child class.</p>
|
<p>Delete the instance of the child class.</p>
|
||||||
<p>Note: this doesn't prevent callers of <code>getInstance</code> from storing the result in a global.</p>
|
<p>Note: this doesn't prevent callers of <code>getInstance</code> from storing the result in a global.</p>
|
||||||
<p>There is <em>no</em> way in JS or TS to prevent globals like that.</p>
|
<p>There is <em>no</em> way in JS or TS to prevent globals like that.</p>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -9,7 +9,7 @@
|
|||||||
<meta name="description" content="Documentation for Lens Extension API.">
|
<meta name="description" content="Documentation for Lens Extension API.">
|
||||||
|
|
||||||
|
|
||||||
<link rel="canonical" href="https://api-docs.k8slens.dev/master/extensions/api/classes/_main_api_index_._main_api_catalog_.catalogentityregistry/">
|
<link rel="canonical" href="https://api-docs.k8slens.dev/master/extensions/api/classes/main.catalog.catalogentityregistry/">
|
||||||
|
|
||||||
|
|
||||||
<meta name="author" content="Mirantis, Inc.">
|
<meta name="author" content="Mirantis, Inc.">
|
||||||
@ -591,19 +591,19 @@
|
|||||||
<ul class="md-nav__list" data-md-scrollfix>
|
<ul class="md-nav__list" data-md-scrollfix>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#hierarchy" class="md-nav__link">
|
<a href="#table-of-contents" class="md-nav__link">
|
||||||
Hierarchy
|
Table of contents
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<nav class="md-nav" aria-label="Table of contents">
|
||||||
|
<ul class="md-nav__list">
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#constructors" class="md-nav__link">
|
||||||
|
Constructors
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#index" class="md-nav__link">
|
|
||||||
Index
|
|
||||||
</a>
|
|
||||||
|
|
||||||
<nav class="md-nav" aria-label="Index">
|
|
||||||
<ul class="md-nav__list">
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#methods" class="md-nav__link">
|
<a href="#methods" class="md-nav__link">
|
||||||
@ -615,6 +615,26 @@
|
|||||||
</ul>
|
</ul>
|
||||||
</nav>
|
</nav>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#constructors_1" class="md-nav__link">
|
||||||
|
Constructors
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<nav class="md-nav" aria-label="Constructors">
|
||||||
|
<ul class="md-nav__list">
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#constructor" class="md-nav__link">
|
||||||
|
constructor
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -652,41 +672,58 @@
|
|||||||
|
|
||||||
|
|
||||||
<h1 id="class-catalogentityregistry">Class: CatalogEntityRegistry<a class="headerlink" href="#class-catalogentityregistry" title="Permanent link">#</a></h1>
|
<h1 id="class-catalogentityregistry">Class: CatalogEntityRegistry<a class="headerlink" href="#class-catalogentityregistry" title="Permanent link">#</a></h1>
|
||||||
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
|
<p><a href="../../modules/main/">Main</a>.<a href="../../modules/main.catalog/">Catalog</a>.CatalogEntityRegistry</p>
|
||||||
|
<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>
|
<ul>
|
||||||
<li><strong>CatalogEntityRegistry</strong></li>
|
<li><a href="./#constructor">constructor</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="index">Index<a class="headerlink" href="#index" title="Permanent link">#</a></h2>
|
|
||||||
<h3 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">#</a></h3>
|
<h3 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="./#getitemsforapikind">getItemsForApiKind</a></li>
|
<li><a href="./#getitemsforapikind">getItemsForApiKind</a></li>
|
||||||
</ul>
|
</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 CatalogEntityRegistry</strong>()</p>
|
||||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||||
<h3 id="getitemsforapikind">getItemsForApiKind<a class="headerlink" href="#getitemsforapikind" title="Permanent link">#</a></h3>
|
<h3 id="getitemsforapikind">getItemsForApiKind<a class="headerlink" href="#getitemsforapikind" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>getItemsForApiKind</strong>‹<strong>T</strong>›(<code>apiVersion</code>: string, <code>kind</code>: string): <em>T[]</em></p>
|
<p>▸ <strong>getItemsForApiKind</strong><T>(<code>apiVersion</code>, <code>kind</code>): <code>T</code>[]</p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/extensions/main-api/catalog.ts#L28">src/extensions/main-api/catalog.ts:28</a></em></p>
|
<h4 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Type parameters:</strong></p>
|
|
||||||
<p>▪ <strong>T</strong>: <em><a href="../_common_api_index_._common_api_catalog_.catalogentity/">CatalogEntity</a></em></p>
|
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>apiVersion</code></td>
|
<td align="left"><code>T</code></td>
|
||||||
<td>string</td>
|
<td align="left"><code>T</code>: <a href="../common.catalog.catalogentity/">CatalogEntity</a><<a href="../../interfaces/common.catalog.catalogentitymetadata/">CatalogEntityMetadata</a>, <a href="../../interfaces/common.catalog.catalogentitystatus/">CatalogEntityStatus</a>, <a href="../../modules/common.catalog/#catalogentityspec">CatalogEntitySpec</a>, T></td>
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><code>kind</code></td>
|
|
||||||
<td>string</td>
|
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>T[]</em></p>
|
<h4 id="parameters">Parameters<a class="headerlink" href="#parameters" 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>apiVersion</code></td>
|
||||||
|
<td align="left"><code>string</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>kind</code></td>
|
||||||
|
<td align="left"><code>string</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>T</code>[]</p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -9,7 +9,7 @@
|
|||||||
<meta name="description" content="Documentation for Lens Extension API.">
|
<meta name="description" content="Documentation for Lens Extension API.">
|
||||||
|
|
||||||
|
|
||||||
<link rel="canonical" href="https://api-docs.k8slens.dev/master/extensions/api/classes/_main_api_index_.ipcmain/">
|
<link rel="canonical" href="https://api-docs.k8slens.dev/master/extensions/api/classes/main.ipc/">
|
||||||
|
|
||||||
|
|
||||||
<meta name="author" content="Mirantis, Inc.">
|
<meta name="author" content="Mirantis, Inc.">
|
||||||
@ -19,7 +19,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<title>Class: IpcMain - Lens Extension API</title>
|
<title>Class: Ipc - Lens Extension API</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -72,7 +72,7 @@
|
|||||||
<div data-md-component="skip">
|
<div data-md-component="skip">
|
||||||
|
|
||||||
|
|
||||||
<a href="#class-ipcmain" class="md-skip">
|
<a href="#class-ipc" class="md-skip">
|
||||||
Skip to content
|
Skip to content
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
@ -103,7 +103,7 @@
|
|||||||
<div class="md-header-nav__topic">
|
<div class="md-header-nav__topic">
|
||||||
<span class="md-ellipsis">
|
<span class="md-ellipsis">
|
||||||
|
|
||||||
Class: IpcMain
|
Class: Ipc
|
||||||
|
|
||||||
</span>
|
</span>
|
||||||
</div>
|
</div>
|
||||||
@ -598,11 +598,11 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#index" class="md-nav__link">
|
<a href="#table-of-contents" class="md-nav__link">
|
||||||
Index
|
Table of contents
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
<nav class="md-nav" aria-label="Index">
|
<nav class="md-nav" aria-label="Table of contents">
|
||||||
<ul class="md-nav__list">
|
<ul class="md-nav__list">
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -667,8 +667,8 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#protected-extension" class="md-nav__link">
|
<a href="#extension" class="md-nav__link">
|
||||||
Protected extension
|
extension
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -708,22 +708,22 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#static-createinstance" class="md-nav__link">
|
<a href="#createinstance" class="md-nav__link">
|
||||||
Static createInstance
|
createInstance
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#static-getinstance" class="md-nav__link">
|
<a href="#getinstance" class="md-nav__link">
|
||||||
Static getInstance
|
getInstance
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#static-resetinstance" class="md-nav__link">
|
<a href="#resetinstance" class="md-nav__link">
|
||||||
Static resetInstance
|
resetInstance
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -747,13 +747,14 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<h1 id="class-ipcmain">Class: IpcMain<a class="headerlink" href="#class-ipcmain" title="Permanent link">#</a></h1>
|
<h1 id="class-ipc">Class: Ipc<a class="headerlink" href="#class-ipc" title="Permanent link">#</a></h1>
|
||||||
|
<p><a href="../../modules/main/">Main</a>.Ipc</p>
|
||||||
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
|
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
|
||||||
<ul>
|
<ul>
|
||||||
<li>IpcRegistrar</li>
|
<li><code>IpcRegistrar</code></li>
|
||||||
</ul>
|
</ul>
|
||||||
<p>↳ <strong>IpcMain</strong></p>
|
<p>↳ <strong>Ipc</strong></p>
|
||||||
<h2 id="index">Index<a class="headerlink" href="#index" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructors">Constructors<a class="headerlink" href="#constructors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="./#constructor">constructor</a></li>
|
<li><a href="./#constructor">constructor</a></li>
|
||||||
@ -761,221 +762,237 @@
|
|||||||
<h3 id="properties">Properties<a class="headerlink" href="#properties" title="Permanent link">#</a></h3>
|
<h3 id="properties">Properties<a class="headerlink" href="#properties" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="./#[ipcprefix]">[IpcPrefix]</a></li>
|
<li><a href="./#[ipcprefix]">[IpcPrefix]</a></li>
|
||||||
<li><a href="./#protected-extension">extension</a></li>
|
<li><a href="./#extension">extension</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">#</a></h3>
|
<h3 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="./#broadcast">broadcast</a></li>
|
<li><a href="./#broadcast">broadcast</a></li>
|
||||||
<li><a href="./#handle">handle</a></li>
|
<li><a href="./#handle">handle</a></li>
|
||||||
<li><a href="./#listen">listen</a></li>
|
<li><a href="./#listen">listen</a></li>
|
||||||
<li><a href="./#static-createinstance">createInstance</a></li>
|
<li><a href="./#createinstance">createInstance</a></li>
|
||||||
<li><a href="./#static-getinstance">getInstance</a></li>
|
<li><a href="./#getinstance">getInstance</a></li>
|
||||||
<li><a href="./#static-resetinstance">resetInstance</a></li>
|
<li><a href="./#resetinstance">resetInstance</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
<p>+ <strong>new IpcMain</strong>(<code>extension</code>: <a href="../_main_api_index_.lensmainextension/">LensMainExtension</a>): <em><a href="./">IpcMain</a></em></p>
|
<p>• <strong>new Ipc</strong>(<code>extension</code>)</p>
|
||||||
<p><em>Overrides void</em></p>
|
<h4 id="parameters">Parameters<a class="headerlink" href="#parameters" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/extensions/ipc/ipc-main.ts#L28">src/extensions/ipc/ipc-main.ts:28</a></em></p>
|
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>extension</code></td>
|
<td align="left"><code>extension</code></td>
|
||||||
<td><a href="../_main_api_index_.lensmainextension/">LensMainExtension</a></td>
|
<td align="left"><a href="../main.lensextension/">LensExtension</a></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em><a href="./">IpcMain</a></em></p>
|
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
||||||
|
<p>IpcRegistrar.constructor</p>
|
||||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||||
<h3 id="ipcprefix">[IpcPrefix]<a class="headerlink" href="#ipcprefix" title="Permanent link">#</a></h3>
|
<h3 id="ipcprefix">[IpcPrefix]<a class="headerlink" href="#ipcprefix" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>[IpcPrefix]</strong>: <em>string</em></p>
|
<p>• <code>Readonly</code> <strong>[IpcPrefix]</strong>: <code>string</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_.ipcrenderer/">IpcRenderer</a>.<a href="../_renderer_api_index_.ipcrenderer/#[ipcprefix]">[IpcPrefix]</a></em></p>
|
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/extensions/ipc/ipc-registrar.ts#L29">src/extensions/ipc/ipc-registrar.ts:29</a></em></p>
|
<p>IpcRegistrar.__@IpcPrefix@39828</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="protected-extension"><code>Protected</code> extension<a class="headerlink" href="#protected-extension" title="Permanent link">#</a></h3>
|
<h3 id="extension">extension<a class="headerlink" href="#extension" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>extension</strong>: <em>LensExtension</em></p>
|
<p>• <code>Protected</code> <strong>extension</strong>: <code>LensExtension</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_.ipcrenderer/">IpcRenderer</a>.<a href="../_renderer_api_index_.ipcrenderer/#protected-extension">extension</a></em></p>
|
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/extensions/ipc/ipc-registrar.ts#L31">src/extensions/ipc/ipc-registrar.ts:31</a></em></p>
|
<p>IpcRegistrar.extension</p>
|
||||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||||
<h3 id="broadcast">broadcast<a class="headerlink" href="#broadcast" title="Permanent link">#</a></h3>
|
<h3 id="broadcast">broadcast<a class="headerlink" href="#broadcast" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>broadcast</strong>(<code>channel</code>: string, ...<code>args</code>: any[]): <em>void</em></p>
|
<p>▸ <strong>broadcast</strong>(<code>channel</code>, ...<code>args</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_.ipcrenderer/">IpcRenderer</a>.<a href="../_renderer_api_index_.ipcrenderer/#broadcast">broadcast</a></em></p>
|
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/extensions/ipc/ipc-registrar.ts#L41">src/extensions/ipc/ipc-registrar.ts:41</a></em></p>
|
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
<th>Description</th>
|
<th align="left">Description</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>channel</code></td>
|
<td align="left"><code>channel</code></td>
|
||||||
<td>string</td>
|
<td align="left"><code>string</code></td>
|
||||||
<td>The channel to broadcast to your whole extension, both <code>main</code> and <code>renderer</code></td>
|
<td align="left">The channel to broadcast to your whole extension, both <code>main</code> and <code>renderer</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>...args</code></td>
|
<td align="left"><code>...args</code></td>
|
||||||
<td>any[]</td>
|
<td align="left"><code>any</code>[]</td>
|
||||||
<td>The arguments passed to all listeners</td>
|
<td align="left">The arguments passed to all listeners</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||||
|
<p>IpcRegistrar.broadcast</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="handle">handle<a class="headerlink" href="#handle" title="Permanent link">#</a></h3>
|
<h3 id="handle">handle<a class="headerlink" href="#handle" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>handle</strong>(<code>channel</code>: string, <code>handler</code>: function): <em>void</em></p>
|
<p>▸ <strong>handle</strong>(<code>channel</code>, <code>handler</code>): <code>void</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/extensions/ipc/ipc-main.ts#L55">src/extensions/ipc/ipc-main.ts:55</a></em></p>
|
|
||||||
<p>Declare a RPC over <code>channel</code>. Lens will cleanup when the extension is disabled or uninstalled</p>
|
<p>Declare a RPC over <code>channel</code>. Lens will cleanup when the extension is disabled or uninstalled</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||||
<p>▪ <strong>channel</strong>: <em>string</em></p>
|
|
||||||
<p>The name of the RPC</p>
|
|
||||||
<p>▪ <strong>handler</strong>: <em>function</em></p>
|
|
||||||
<p>The remote procedure that is called</p>
|
|
||||||
<p>▸ (<code>event</code>: IpcMainInvokeEvent, ...<code>args</code>: any[]): <em>any</em></p>
|
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
|
<th align="left">Description</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>event</code></td>
|
<td align="left"><code>channel</code></td>
|
||||||
<td>IpcMainInvokeEvent</td>
|
<td align="left"><code>string</code></td>
|
||||||
|
<td align="left">The name of the RPC</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>...args</code></td>
|
<td align="left"><code>handler</code></td>
|
||||||
<td>any[]</td>
|
<td align="left">(<code>event</code>: <code>IpcMainInvokeEvent</code>, ...<code>args</code>: <code>any</code>[]) => <code>any</code></td>
|
||||||
|
<td align="left">The remote procedure that is called</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="listen">listen<a class="headerlink" href="#listen" title="Permanent link">#</a></h3>
|
<h3 id="listen">listen<a class="headerlink" href="#listen" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>listen</strong>(<code>channel</code>: string, <code>listener</code>: function): <em>Disposer</em></p>
|
<p>▸ <strong>listen</strong>(<code>channel</code>, <code>listener</code>): <code>Disposer</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/extensions/ipc/ipc-main.ts#L40">src/extensions/ipc/ipc-main.ts:40</a></em></p>
|
|
||||||
<p>Listen for broadcasts within your extension</p>
|
<p>Listen for broadcasts within your extension</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||||
<p>▪ <strong>channel</strong>: <em>string</em></p>
|
|
||||||
<p>The channel to listen for broadcasts on</p>
|
|
||||||
<p>▪ <strong>listener</strong>: <em>function</em></p>
|
|
||||||
<p>The function that will be called with the arguments of the broadcast</p>
|
|
||||||
<p>▸ (<code>event</code>: IpcRendererEvent, ...<code>args</code>: any[]): <em>any</em></p>
|
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
|
<th align="left">Description</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>event</code></td>
|
<td align="left"><code>channel</code></td>
|
||||||
<td>IpcRendererEvent</td>
|
<td align="left"><code>string</code></td>
|
||||||
|
<td align="left">The channel to listen for broadcasts on</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>...args</code></td>
|
<td align="left"><code>listener</code></td>
|
||||||
<td>any[]</td>
|
<td align="left">(<code>event</code>: <code>IpcRendererEvent</code>, ...<code>args</code>: <code>any</code>[]) => <code>any</code></td>
|
||||||
|
<td align="left">The function that will be called with the arguments of the broadcast</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>Disposer</em></p>
|
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Disposer</code></p>
|
||||||
<p>An optional disopser, Lens will cleanup when the extension is disabled or uninstalled even if this is not called</p>
|
<p>An optional disopser, Lens will cleanup when the extension is disabled or uninstalled even if this is not called</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="static-createinstance"><code>Static</code> createInstance<a class="headerlink" href="#static-createinstance" title="Permanent link">#</a></h3>
|
<h3 id="createinstance">createInstance<a class="headerlink" href="#createinstance" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>createInstance</strong>‹<strong>T</strong>, <strong>R</strong>›(<code>this</code>: StaticThis‹T, R›, ...<code>args</code>: R): <em>T</em></p>
|
<p>▸ <code>Static</code> <strong>createInstance</strong><T, R>(...<code>args</code>): <code>T</code></p>
|
||||||
<p><em>Inherited from <a href="../_common_api_index_._common_api_stores_.extensionstore/">ExtensionStore</a>.<a href="../_common_api_index_._common_api_stores_.extensionstore/#static-createinstance">createInstance</a></em></p>
|
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/utils/singleton.ts#L46">src/common/utils/singleton.ts:46</a></em></p>
|
|
||||||
<p>Creates the single instance of the child class if one was not already created.</p>
|
<p>Creates the single instance of the child class if one was not already created.</p>
|
||||||
<p>Multiple calls will return the same instance.
|
<p>Multiple calls will return the same instance.
|
||||||
Essentially throwing away the arguments to the subsequent calls.</p>
|
Essentially throwing away the arguments to the subsequent calls.</p>
|
||||||
<p>Note: this is a racy function, if two (or more) calls are racing to call this function
|
<p>Note: this is a racy function, if two (or more) calls are racing to call this function
|
||||||
only the first's arguments will be used.</p>
|
only the first's arguments will be used.</p>
|
||||||
<p><strong>Type parameters:</strong></p>
|
<h4 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h4>
|
||||||
<p>▪ <strong>T</strong></p>
|
|
||||||
<p>▪ <strong>R</strong>: <em>any[]</em></p>
|
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
<th>Description</th>
|
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>this</code></td>
|
<td align="left"><code>T</code></td>
|
||||||
<td>StaticThis‹T, R›</td>
|
<td align="left"><code>T</code></td>
|
||||||
<td>Implicit argument that is the child class type</td>
|
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>...args</code></td>
|
<td align="left"><code>R</code></td>
|
||||||
<td>R</td>
|
<td align="left"><code>R</code>: <code>any</code>[]</td>
|
||||||
<td>The constructor arguments for the child class</td>
|
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>T</em></p>
|
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th align="left">Name</th>
|
||||||
|
<th align="left">Type</th>
|
||||||
|
<th align="left">Description</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>...args</code></td>
|
||||||
|
<td align="left"><code>R</code></td>
|
||||||
|
<td align="left">The constructor arguments for the child class</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>T</code></p>
|
||||||
<p>An instance of the child class</p>
|
<p>An instance of the child class</p>
|
||||||
|
<h4 id="inherited-from_3">Inherited from<a class="headerlink" href="#inherited-from_3" title="Permanent link">#</a></h4>
|
||||||
|
<p>IpcRegistrar.createInstance</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="static-getinstance"><code>Static</code> getInstance<a class="headerlink" href="#static-getinstance" title="Permanent link">#</a></h3>
|
<h3 id="getinstance">getInstance<a class="headerlink" href="#getinstance" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>getInstance</strong>‹<strong>T</strong>, <strong>R</strong>›(<code>this</code>: StaticThis‹T, R›, <code>strict</code>: boolean): <em>T | undefined</em></p>
|
<p>▸ <code>Static</code> <strong>getInstance</strong><T, R>(<code>strict</code>): <code>T</code></p>
|
||||||
<p><em>Inherited from <a href="../_common_api_index_._common_api_stores_.extensionstore/">ExtensionStore</a>.<a href="../_common_api_index_._common_api_stores_.extensionstore/#static-getinstance">getInstance</a></em></p>
|
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/utils/singleton.ts#L67">src/common/utils/singleton.ts:67</a></em></p>
|
|
||||||
<p>Get the instance of the child class that was previously created.</p>
|
<p>Get the instance of the child class that was previously created.</p>
|
||||||
<p><strong>Type parameters:</strong></p>
|
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
||||||
<p>▪ <strong>T</strong></p>
|
|
||||||
<p>▪ <strong>R</strong>: <em>any[]</em></p>
|
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
<th>Default</th>
|
|
||||||
<th>Description</th>
|
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>this</code></td>
|
<td align="left"><code>T</code></td>
|
||||||
<td>StaticThis‹T, R›</td>
|
<td align="left"><code>T</code></td>
|
||||||
<td>-</td>
|
|
||||||
<td>Implicit argument that is the child class type</td>
|
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>strict</code></td>
|
<td align="left"><code>R</code></td>
|
||||||
<td>boolean</td>
|
<td align="left"><code>R</code>: <code>any</code>[]</td>
|
||||||
<td>true</td>
|
|
||||||
<td>If false will return <code>undefined</code> instead of throwing when an instance doesn't exist. Default: <code>true</code></td>
|
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>T | undefined</em></p>
|
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th align="left">Name</th>
|
||||||
|
<th align="left">Type</th>
|
||||||
|
<th align="left">Description</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>strict</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
<td align="left">If false will return <code>undefined</code> instead of throwing when an instance doesn't exist. Default: <code>true</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>T</code></p>
|
||||||
<p>An instance of the child class</p>
|
<p>An instance of the child class</p>
|
||||||
|
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||||
|
<p>IpcRegistrar.getInstance</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="static-resetinstance"><code>Static</code> resetInstance<a class="headerlink" href="#static-resetinstance" title="Permanent link">#</a></h3>
|
<h3 id="resetinstance">resetInstance<a class="headerlink" href="#resetinstance" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>resetInstance</strong>(): <em>void</em></p>
|
<p>▸ <code>Static</code> <strong>resetInstance</strong>(): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_common_api_index_._common_api_stores_.extensionstore/">ExtensionStore</a>.<a href="../_common_api_index_._common_api_stores_.extensionstore/#static-resetinstance">resetInstance</a></em></p>
|
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/common/utils/singleton.ts#L82">src/common/utils/singleton.ts:82</a></em></p>
|
|
||||||
<p>Delete the instance of the child class.</p>
|
<p>Delete the instance of the child class.</p>
|
||||||
<p>Note: this doesn't prevent callers of <code>getInstance</code> from storing the result in a global.</p>
|
<p>Note: this doesn't prevent callers of <code>getInstance</code> from storing the result in a global.</p>
|
||||||
<p>There is <em>no</em> way in JS or TS to prevent globals like that.</p>
|
<p>There is <em>no</em> way in JS or TS to prevent globals like that.</p>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
||||||
|
<p>IpcRegistrar.resetInstance</p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -9,7 +9,7 @@
|
|||||||
<meta name="description" content="Documentation for Lens Extension API.">
|
<meta name="description" content="Documentation for Lens Extension API.">
|
||||||
|
|
||||||
|
|
||||||
<link rel="canonical" href="https://api-docs.k8slens.dev/master/extensions/api/classes/_main_api_index_.lensmainextension/">
|
<link rel="canonical" href="https://api-docs.k8slens.dev/master/extensions/api/classes/main.lensextension/">
|
||||||
|
|
||||||
|
|
||||||
<meta name="author" content="Mirantis, Inc.">
|
<meta name="author" content="Mirantis, Inc.">
|
||||||
@ -19,7 +19,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<title>Class: LensMainExtension - Lens Extension API</title>
|
<title>Class: LensExtension - Lens Extension API</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -72,7 +72,7 @@
|
|||||||
<div data-md-component="skip">
|
<div data-md-component="skip">
|
||||||
|
|
||||||
|
|
||||||
<a href="#class-lensmainextension" class="md-skip">
|
<a href="#class-lensextension" class="md-skip">
|
||||||
Skip to content
|
Skip to content
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
@ -103,7 +103,7 @@
|
|||||||
<div class="md-header-nav__topic">
|
<div class="md-header-nav__topic">
|
||||||
<span class="md-ellipsis">
|
<span class="md-ellipsis">
|
||||||
|
|
||||||
Class: LensMainExtension
|
Class: LensExtension
|
||||||
|
|
||||||
</span>
|
</span>
|
||||||
</div>
|
</div>
|
||||||
@ -598,11 +598,11 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#index" class="md-nav__link">
|
<a href="#table-of-contents" class="md-nav__link">
|
||||||
Index
|
Table of contents
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
<nav class="md-nav" aria-label="Index">
|
<nav class="md-nav" aria-label="Table of contents">
|
||||||
<ul class="md-nav__list">
|
<ul class="md-nav__list">
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -798,15 +798,15 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#protected-onactivate" class="md-nav__link">
|
<a href="#onactivate" class="md-nav__link">
|
||||||
Protected onActivate
|
onActivate
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#protected-ondeactivate" class="md-nav__link">
|
<a href="#ondeactivate" class="md-nav__link">
|
||||||
Protected onDeactivate
|
onDeactivate
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -837,13 +837,14 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<h1 id="class-lensmainextension">Class: LensMainExtension<a class="headerlink" href="#class-lensmainextension" 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/main/">Main</a>.LensExtension</p>
|
||||||
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
|
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
|
||||||
<ul>
|
<ul>
|
||||||
<li>LensExtension</li>
|
<li><code>LensExtension</code></li>
|
||||||
</ul>
|
</ul>
|
||||||
<p>↳ <strong>LensMainExtension</strong></p>
|
<p>↳ <strong>LensExtension</strong></p>
|
||||||
<h2 id="index">Index<a class="headerlink" href="#index" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructors">Constructors<a class="headerlink" href="#constructors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="./#constructor">constructor</a></li>
|
<li><a href="./#constructor">constructor</a></li>
|
||||||
@ -871,222 +872,219 @@
|
|||||||
<li><a href="./#enable">enable</a></li>
|
<li><a href="./#enable">enable</a></li>
|
||||||
<li><a href="./#getextensionfilefolder">getExtensionFileFolder</a></li>
|
<li><a href="./#getextensionfilefolder">getExtensionFileFolder</a></li>
|
||||||
<li><a href="./#navigate">navigate</a></li>
|
<li><a href="./#navigate">navigate</a></li>
|
||||||
<li><a href="./#protected-onactivate">onActivate</a></li>
|
<li><a href="./#onactivate">onActivate</a></li>
|
||||||
<li><a href="./#protected-ondeactivate">onDeactivate</a></li>
|
<li><a href="./#ondeactivate">onDeactivate</a></li>
|
||||||
<li><a href="./#removecatalogsource">removeCatalogSource</a></li>
|
<li><a href="./#removecatalogsource">removeCatalogSource</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
<p>+ <strong>new LensMainExtension</strong>(<code>__namedParameters</code>: object): <em><a href="./">LensMainExtension</a></em></p>
|
<p>• <strong>new LensExtension</strong>(<code>__namedParameters</code>)</p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_.lensrendererextension/">LensRendererExtension</a>.<a href="../_renderer_api_index_.lensrendererextension/#constructor">constructor</a></em></p>
|
<h4 id="parameters">Parameters<a class="headerlink" href="#parameters" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/extensions/lens-extension.ts#L52">src/extensions/lens-extension.ts:52</a></em></p>
|
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<p>▪ <strong>__namedParameters</strong>: <em>object</em></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>id</code></td>
|
<td align="left"><code>__namedParameters</code></td>
|
||||||
<td>string</td>
|
<td align="left"><code>InstalledExtension</code></td>
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><code>isBundled</code></td>
|
|
||||||
<td>boolean</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><code>manifest</code></td>
|
|
||||||
<td>LensExtensionManifest</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><code>manifestPath</code></td>
|
|
||||||
<td>string</td>
|
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em><a href="./">LensMainExtension</a></em></p>
|
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||||
|
<p>LensExtension.constructor</p>
|
||||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||||
<h3 id="disposers">[Disposers]<a class="headerlink" href="#disposers" title="Permanent link">#</a></h3>
|
<h3 id="disposers">[Disposers]<a class="headerlink" href="#disposers" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>[Disposers]</strong>: <em>function & Extendable‹function›</em> = disposer()</p>
|
<p>• <strong>[Disposers]</strong>: <code>ExtendableDisposer</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_.lensrendererextension/">LensRendererExtension</a>.<a href="../_renderer_api_index_.lensrendererextension/#[disposers]">[Disposers]</a></em></p>
|
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/extensions/lens-extension.ts#L52">src/extensions/lens-extension.ts:52</a></em></p>
|
<p>LensExtension.__@Disposers@22632</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="appmenus">appMenus<a class="headerlink" href="#appmenus" title="Permanent link">#</a></h3>
|
<h3 id="appmenus">appMenus<a class="headerlink" href="#appmenus" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>appMenus</strong>: <em>MenuRegistration[]</em> = []</p>
|
<p>• <strong>appMenus</strong>: <code>MenuRegistration</code>[] = []</p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/extensions/lens-main-extension.ts#L31">src/extensions/lens-main-extension.ts:31</a></em></p>
|
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="id">id<a class="headerlink" href="#id" title="Permanent link">#</a></h3>
|
<h3 id="id">id<a class="headerlink" href="#id" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>id</strong>: <em>LensExtensionId</em></p>
|
<p>• <code>Readonly</code> <strong>id</strong>: <code>string</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_.lensrendererextension/">LensRendererExtension</a>.<a href="../_renderer_api_index_.lensrendererextension/#id">id</a></em></p>
|
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/extensions/lens-extension.ts#L44">src/extensions/lens-extension.ts:44</a></em></p>
|
<p>LensExtension.id</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isbundled">isBundled<a class="headerlink" href="#isbundled" title="Permanent link">#</a></h3>
|
<h3 id="isbundled">isBundled<a class="headerlink" href="#isbundled" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>isBundled</strong>: <em>boolean</em></p>
|
<p>• <code>Readonly</code> <strong>isBundled</strong>: <code>boolean</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_.lensrendererextension/">LensRendererExtension</a>.<a href="../_renderer_api_index_.lensrendererextension/#isbundled">isBundled</a></em></p>
|
<h4 id="inherited-from_3">Inherited from<a class="headerlink" href="#inherited-from_3" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/extensions/lens-extension.ts#L47">src/extensions/lens-extension.ts:47</a></em></p>
|
<p>LensExtension.isBundled</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="manifest">manifest<a class="headerlink" href="#manifest" title="Permanent link">#</a></h3>
|
<h3 id="manifest">manifest<a class="headerlink" href="#manifest" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>manifest</strong>: <em>LensExtensionManifest</em></p>
|
<p>• <code>Readonly</code> <strong>manifest</strong>: <code>LensExtensionManifest</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_.lensrendererextension/">LensRendererExtension</a>.<a href="../_renderer_api_index_.lensrendererextension/#manifest">manifest</a></em></p>
|
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/extensions/lens-extension.ts#L45">src/extensions/lens-extension.ts:45</a></em></p>
|
<p>LensExtension.manifest</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="manifestpath">manifestPath<a class="headerlink" href="#manifestpath" title="Permanent link">#</a></h3>
|
<h3 id="manifestpath">manifestPath<a class="headerlink" href="#manifestpath" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>manifestPath</strong>: <em>string</em></p>
|
<p>• <code>Readonly</code> <strong>manifestPath</strong>: <code>string</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_.lensrendererextension/">LensRendererExtension</a>.<a href="../_renderer_api_index_.lensrendererextension/#manifestpath">manifestPath</a></em></p>
|
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/extensions/lens-extension.ts#L46">src/extensions/lens-extension.ts:46</a></em></p>
|
<p>LensExtension.manifestPath</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="protocolhandlers">protocolHandlers<a class="headerlink" href="#protocolhandlers" title="Permanent link">#</a></h3>
|
<h3 id="protocolhandlers">protocolHandlers<a class="headerlink" href="#protocolhandlers" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>protocolHandlers</strong>: <em><a href="../../interfaces/_common_api_index_._common_api_types_.protocolhandlerregistration/">ProtocolHandlerRegistration</a>[]</em> = []</p>
|
<p>• <strong>protocolHandlers</strong>: <a href="../../interfaces/common.types.protocolhandlerregistration/">ProtocolHandlerRegistration</a>[] = []</p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_.lensrendererextension/">LensRendererExtension</a>.<a href="../_renderer_api_index_.lensrendererextension/#protocolhandlers">protocolHandlers</a></em></p>
|
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/extensions/lens-extension.ts#L49">src/extensions/lens-extension.ts:49</a></em></p>
|
<p>LensExtension.protocolHandlers</p>
|
||||||
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
||||||
<h3 id="description">description<a class="headerlink" href="#description" title="Permanent link">#</a></h3>
|
<h3 id="description">description<a class="headerlink" href="#description" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>get description</strong>(): <em>string</em></p>
|
<p>• <code>get</code> <strong>description</strong>(): <code>string</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_.lensrendererextension/">LensRendererExtension</a>.<a href="../_renderer_api_index_.lensrendererextension/#description">description</a></em></p>
|
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/extensions/lens-extension.ts#L70">src/extensions/lens-extension.ts:70</a></em></p>
|
<p><code>string</code></p>
|
||||||
<p><strong>Returns:</strong> <em>string</em></p>
|
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="name">name<a class="headerlink" href="#name" title="Permanent link">#</a></h3>
|
<h3 id="name">name<a class="headerlink" href="#name" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>get name</strong>(): <em>string</em></p>
|
<p>• <code>get</code> <strong>name</strong>(): <code>string</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_.lensrendererextension/">LensRendererExtension</a>.<a href="../_renderer_api_index_.lensrendererextension/#name">name</a></em></p>
|
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/extensions/lens-extension.ts#L62">src/extensions/lens-extension.ts:62</a></em></p>
|
<p><code>string</code></p>
|
||||||
<p><strong>Returns:</strong> <em>string</em></p>
|
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="version">version<a class="headerlink" href="#version" title="Permanent link">#</a></h3>
|
<h3 id="version">version<a class="headerlink" href="#version" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>get version</strong>(): <em>string</em></p>
|
<p>• <code>get</code> <strong>version</strong>(): <code>string</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_.lensrendererextension/">LensRendererExtension</a>.<a href="../_renderer_api_index_.lensrendererextension/#version">version</a></em></p>
|
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/extensions/lens-extension.ts#L66">src/extensions/lens-extension.ts:66</a></em></p>
|
<p><code>string</code></p>
|
||||||
<p><strong>Returns:</strong> <em>string</em></p>
|
|
||||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||||
<h3 id="addcatalogsource">addCatalogSource<a class="headerlink" href="#addcatalogsource" title="Permanent link">#</a></h3>
|
<h3 id="addcatalogsource">addCatalogSource<a class="headerlink" href="#addcatalogsource" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>addCatalogSource</strong>(<code>id</code>: string, <code>source</code>: IObservableArray‹<a href="../_common_api_index_._common_api_catalog_.catalogentity/">CatalogEntity</a>›): <em>void</em></p>
|
<p>▸ <strong>addCatalogSource</strong>(<code>id</code>, <code>source</code>): <code>void</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/extensions/lens-main-extension.ts#L44">src/extensions/lens-main-extension.ts:44</a></em></p>
|
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>id</code></td>
|
<td align="left"><code>id</code></td>
|
||||||
<td>string</td>
|
<td align="left"><code>string</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>source</code></td>
|
<td align="left"><code>source</code></td>
|
||||||
<td>IObservableArray‹<a href="../_common_api_index_._common_api_catalog_.catalogentity/">CatalogEntity</a>›</td>
|
<td align="left"><code>IObservableArray</code><<a href="../common.catalog.catalogentity/">CatalogEntity</a><<a href="../../interfaces/common.catalog.catalogentitymetadata/">CatalogEntityMetadata</a>, <a href="../../interfaces/common.catalog.catalogentitystatus/">CatalogEntityStatus</a>, <a href="../../modules/common.catalog/#catalogentityspec">CatalogEntitySpec</a>>></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="disable">disable<a class="headerlink" href="#disable" title="Permanent link">#</a></h3>
|
<h3 id="disable">disable<a class="headerlink" href="#disable" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>disable</strong>(): <em>Promise‹void›</em></p>
|
<p>▸ <strong>disable</strong>(): <code>Promise</code><void></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_.lensrendererextension/">LensRendererExtension</a>.<a href="../_renderer_api_index_.lensrendererextension/#disable">disable</a></em></p>
|
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/extensions/lens-extension.ts#L103">src/extensions/lens-extension.ts:103</a></em></p>
|
<p><code>Promise</code><void></p>
|
||||||
<p><strong>Returns:</strong> <em>Promise‹void›</em></p>
|
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
||||||
|
<p>LensExtension.disable</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="enable">enable<a class="headerlink" href="#enable" title="Permanent link">#</a></h3>
|
<h3 id="enable">enable<a class="headerlink" href="#enable" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>enable</strong>(<code>register</code>: function): <em>Promise‹void›</em></p>
|
<p>▸ <strong>enable</strong>(<code>register</code>): <code>Promise</code><void></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_.lensrendererextension/">LensRendererExtension</a>.<a href="../_renderer_api_index_.lensrendererextension/#enable">enable</a></em></p>
|
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/extensions/lens-extension.ts#L86">src/extensions/lens-extension.ts:86</a></em></p>
|
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<p>▪ <strong>register</strong>: <em>function</em></p>
|
|
||||||
<p>▸ (<code>ext</code>: LensExtension): <em>Promise‹Disposer[]›</em></p>
|
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>ext</code></td>
|
<td align="left"><code>register</code></td>
|
||||||
<td>LensExtension</td>
|
<td align="left">(<code>ext</code>: <code>LensExtension</code>) => <code>Promise</code><Disposer[]></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>Promise‹void›</em></p>
|
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><void></p>
|
||||||
|
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
||||||
|
<p>LensExtension.enable</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="getextensionfilefolder">getExtensionFileFolder<a class="headerlink" href="#getextensionfilefolder" title="Permanent link">#</a></h3>
|
<h3 id="getextensionfilefolder">getExtensionFileFolder<a class="headerlink" href="#getextensionfilefolder" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>getExtensionFileFolder</strong>(): <em>Promise‹string›</em></p>
|
<p>▸ <strong>getExtensionFileFolder</strong>(): <code>Promise</code><string></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_.lensrendererextension/">LensRendererExtension</a>.<a href="../_renderer_api_index_.lensrendererextension/#getextensionfilefolder">getExtensionFileFolder</a></em></p>
|
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/extensions/lens-extension.ts#L81">src/extensions/lens-extension.ts:81</a></em></p>
|
|
||||||
<p>getExtensionFileFolder returns the path to an already created folder. This
|
<p>getExtensionFileFolder returns the path to an already created folder. This
|
||||||
folder is for the sole use of this extension.</p>
|
folder is for the sole use of this extension.</p>
|
||||||
<p>Note: there is no security done on this folder, only obfiscation of the
|
<p>Note: there is no security done on this folder, only obfiscation of the
|
||||||
folder name.</p>
|
folder name.</p>
|
||||||
<p><strong>Returns:</strong> <em>Promise‹string›</em></p>
|
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><string></p>
|
||||||
|
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
||||||
|
<p>LensExtension.getExtensionFileFolder</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="navigate">navigate<a class="headerlink" href="#navigate" title="Permanent link">#</a></h3>
|
<h3 id="navigate">navigate<a class="headerlink" href="#navigate" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>navigate</strong>‹<strong>P</strong>›(<code>pageId?</code>: string, <code>params?</code>: P, <code>frameId?</code>: number): <em>Promise‹void›</em></p>
|
<p>▸ <strong>navigate</strong><P>(<code>pageId?</code>, <code>params?</code>, <code>frameId?</code>): <code>Promise</code><void></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/extensions/lens-main-extension.ts#L33">src/extensions/lens-main-extension.ts:33</a></em></p>
|
<h4 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Type parameters:</strong></p>
|
|
||||||
<p>▪ <strong>P</strong>: <em>object</em></p>
|
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>pageId?</code></td>
|
<td align="left"><code>P</code></td>
|
||||||
<td>string</td>
|
<td align="left"><code>P</code>: <code>object</code></td>
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><code>params?</code></td>
|
|
||||||
<td>P</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><code>frameId?</code></td>
|
|
||||||
<td>number</td>
|
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>Promise‹void›</em></p>
|
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th align="left">Name</th>
|
||||||
|
<th align="left">Type</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>pageId?</code></td>
|
||||||
|
<td align="left"><code>string</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>params?</code></td>
|
||||||
|
<td align="left"><code>P</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>frameId?</code></td>
|
||||||
|
<td align="left"><code>number</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><void></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="protected-onactivate"><code>Protected</code> onActivate<a class="headerlink" href="#protected-onactivate" title="Permanent link">#</a></h3>
|
<h3 id="onactivate">onActivate<a class="headerlink" href="#onactivate" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>onActivate</strong>(): <em>Promise‹void› | void</em></p>
|
<p>▸ <code>Protected</code> <strong>onActivate</strong>(): <code>void</code> | <code>Promise</code><void></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_.lensrendererextension/">LensRendererExtension</a>.<a href="../_renderer_api_index_.lensrendererextension/#protected-onactivate">onActivate</a></em></p>
|
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/extensions/lens-extension.ts#L119">src/extensions/lens-extension.ts:119</a></em></p>
|
<p><code>void</code> | <code>Promise</code><void></p>
|
||||||
<p><strong>Returns:</strong> <em>Promise‹void› | void</em></p>
|
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
||||||
|
<p>LensExtension.onActivate</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="protected-ondeactivate"><code>Protected</code> onDeactivate<a class="headerlink" href="#protected-ondeactivate" title="Permanent link">#</a></h3>
|
<h3 id="ondeactivate">onDeactivate<a class="headerlink" href="#ondeactivate" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>onDeactivate</strong>(): <em>Promise‹void› | void</em></p>
|
<p>▸ <code>Protected</code> <strong>onDeactivate</strong>(): <code>void</code> | <code>Promise</code><void></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_.lensrendererextension/">LensRendererExtension</a>.<a href="../_renderer_api_index_.lensrendererextension/#protected-ondeactivate">onDeactivate</a></em></p>
|
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/extensions/lens-extension.ts#L123">src/extensions/lens-extension.ts:123</a></em></p>
|
<p><code>void</code> | <code>Promise</code><void></p>
|
||||||
<p><strong>Returns:</strong> <em>Promise‹void› | void</em></p>
|
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||||
|
<p>LensExtension.onDeactivate</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="removecatalogsource">removeCatalogSource<a class="headerlink" href="#removecatalogsource" title="Permanent link">#</a></h3>
|
<h3 id="removecatalogsource">removeCatalogSource<a class="headerlink" href="#removecatalogsource" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>removeCatalogSource</strong>(<code>id</code>: string): <em>void</em></p>
|
<p>▸ <strong>removeCatalogSource</strong>(<code>id</code>): <code>void</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/extensions/lens-main-extension.ts#L48">src/extensions/lens-main-extension.ts:48</a></em></p>
|
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>id</code></td>
|
<td align="left"><code>id</code></td>
|
||||||
<td>string</td>
|
<td align="left"><code>string</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -9,7 +9,7 @@
|
|||||||
<meta name="description" content="Documentation for Lens Extension API.">
|
<meta name="description" content="Documentation for Lens Extension API.">
|
||||||
|
|
||||||
|
|
||||||
<link rel="canonical" href="https://api-docs.k8slens.dev/master/extensions/api/classes/_renderer_api_index_._renderer_api_catalog_.catalogentityregistry/">
|
<link rel="canonical" href="https://api-docs.k8slens.dev/master/extensions/api/classes/renderer.catalog.catalogentityregistry/">
|
||||||
|
|
||||||
|
|
||||||
<meta name="author" content="Mirantis, Inc.">
|
<meta name="author" content="Mirantis, Inc.">
|
||||||
@ -591,19 +591,19 @@
|
|||||||
<ul class="md-nav__list" data-md-scrollfix>
|
<ul class="md-nav__list" data-md-scrollfix>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#hierarchy" class="md-nav__link">
|
<a href="#table-of-contents" class="md-nav__link">
|
||||||
Hierarchy
|
Table of contents
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<nav class="md-nav" aria-label="Table of contents">
|
||||||
|
<ul class="md-nav__list">
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#constructors" class="md-nav__link">
|
||||||
|
Constructors
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#index" class="md-nav__link">
|
|
||||||
Index
|
|
||||||
</a>
|
|
||||||
|
|
||||||
<nav class="md-nav" aria-label="Index">
|
|
||||||
<ul class="md-nav__list">
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#accessors" class="md-nav__link">
|
<a href="#accessors" class="md-nav__link">
|
||||||
@ -622,6 +622,26 @@
|
|||||||
</ul>
|
</ul>
|
||||||
</nav>
|
</nav>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#constructors_1" class="md-nav__link">
|
||||||
|
Constructors
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<nav class="md-nav" aria-label="Constructors">
|
||||||
|
<ul class="md-nav__list">
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#constructor" class="md-nav__link">
|
||||||
|
constructor
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -700,11 +720,12 @@
|
|||||||
|
|
||||||
|
|
||||||
<h1 id="class-catalogentityregistry">Class: CatalogEntityRegistry<a class="headerlink" href="#class-catalogentityregistry" title="Permanent link">#</a></h1>
|
<h1 id="class-catalogentityregistry">Class: CatalogEntityRegistry<a class="headerlink" href="#class-catalogentityregistry" title="Permanent link">#</a></h1>
|
||||||
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
|
<p><a href="../../modules/renderer/">Renderer</a>.<a href="../../modules/renderer.catalog/">Catalog</a>.CatalogEntityRegistry</p>
|
||||||
|
<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>
|
<ul>
|
||||||
<li><strong>CatalogEntityRegistry</strong></li>
|
<li><a href="./#constructor">constructor</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="index">Index<a class="headerlink" href="#index" title="Permanent link">#</a></h2>
|
|
||||||
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="./#activeentity">activeEntity</a></li>
|
<li><a href="./#activeentity">activeEntity</a></li>
|
||||||
@ -716,85 +737,114 @@
|
|||||||
<li><a href="./#getitemsforapikind">getItemsForApiKind</a></li>
|
<li><a href="./#getitemsforapikind">getItemsForApiKind</a></li>
|
||||||
<li><a href="./#getitemsforcategory">getItemsForCategory</a></li>
|
<li><a href="./#getitemsforcategory">getItemsForCategory</a></li>
|
||||||
</ul>
|
</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 CatalogEntityRegistry</strong>()</p>
|
||||||
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
||||||
<h3 id="activeentity">activeEntity<a class="headerlink" href="#activeentity" title="Permanent link">#</a></h3>
|
<h3 id="activeentity">activeEntity<a class="headerlink" href="#activeentity" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>get activeEntity</strong>(): <em><a href="../_common_api_index_._common_api_catalog_.catalogentity/">CatalogEntity</a>‹<a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitymetadata/">CatalogEntityMetadata</a>, <a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitystatus/">CatalogEntityStatus</a>, object›</em></p>
|
<p>• <code>get</code> <strong>activeEntity</strong>(): <a href="../common.catalog.catalogentity/">CatalogEntity</a><<a href="../../interfaces/common.catalog.catalogentitymetadata/">CatalogEntityMetadata</a>, <a href="../../interfaces/common.catalog.catalogentitystatus/">CatalogEntityStatus</a>, <a href="../../modules/common.catalog/#catalogentityspec">CatalogEntitySpec</a>></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/extensions/renderer-api/catalog.ts#L32">src/extensions/renderer-api/catalog.ts:32</a></em></p>
|
|
||||||
<p>Currently active/visible entity</p>
|
<p>Currently active/visible entity</p>
|
||||||
<p><strong>Returns:</strong> <em><a href="../_common_api_index_._common_api_catalog_.catalogentity/">CatalogEntity</a>‹<a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitymetadata/">CatalogEntityMetadata</a>, <a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitystatus/">CatalogEntityStatus</a>, object›</em></p>
|
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../common.catalog.catalogentity/">CatalogEntity</a><<a href="../../interfaces/common.catalog.catalogentitymetadata/">CatalogEntityMetadata</a>, <a href="../../interfaces/common.catalog.catalogentitystatus/">CatalogEntityStatus</a>, <a href="../../modules/common.catalog/#catalogentityspec">CatalogEntitySpec</a>></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="entities">entities<a class="headerlink" href="#entities" title="Permanent link">#</a></h3>
|
<h3 id="entities">entities<a class="headerlink" href="#entities" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>get entities</strong>(): <em>Map‹string, <a href="../_common_api_index_._common_api_catalog_.catalogentity/">CatalogEntity</a>›</em></p>
|
<p>• <code>get</code> <strong>entities</strong>(): <code>Map</code><string, <a href="../common.catalog.catalogentity/">CatalogEntity</a><<a href="../../interfaces/common.catalog.catalogentitymetadata/">CatalogEntityMetadata</a>, <a href="../../interfaces/common.catalog.catalogentitystatus/">CatalogEntityStatus</a>, <a href="../../modules/common.catalog/#catalogentityspec">CatalogEntitySpec</a>>></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/extensions/renderer-api/catalog.ts#L36">src/extensions/renderer-api/catalog.ts:36</a></em></p>
|
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Returns:</strong> <em>Map‹string, <a href="../_common_api_index_._common_api_catalog_.catalogentity/">CatalogEntity</a>›</em></p>
|
<p><code>Map</code><string, <a href="../common.catalog.catalogentity/">CatalogEntity</a><<a href="../../interfaces/common.catalog.catalogentitymetadata/">CatalogEntityMetadata</a>, <a href="../../interfaces/common.catalog.catalogentitystatus/">CatalogEntityStatus</a>, <a href="../../modules/common.catalog/#catalogentityspec">CatalogEntitySpec</a>>></p>
|
||||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||||
<h3 id="getbyid">getById<a class="headerlink" href="#getbyid" title="Permanent link">#</a></h3>
|
<h3 id="getbyid">getById<a class="headerlink" href="#getbyid" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>getById</strong>(<code>id</code>: string): <em><a href="../_common_api_index_._common_api_catalog_.catalogentity/">CatalogEntity</a>‹<a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitymetadata/">CatalogEntityMetadata</a>, <a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitystatus/">CatalogEntityStatus</a>, object›</em></p>
|
<p>▸ <strong>getById</strong>(<code>id</code>): <a href="../common.catalog.catalogentity/">CatalogEntity</a><<a href="../../interfaces/common.catalog.catalogentitymetadata/">CatalogEntityMetadata</a>, <a href="../../interfaces/common.catalog.catalogentitystatus/">CatalogEntityStatus</a>, <a href="../../modules/common.catalog/#catalogentityspec">CatalogEntitySpec</a>></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/extensions/renderer-api/catalog.ts#L40">src/extensions/renderer-api/catalog.ts:40</a></em></p>
|
<h4 id="parameters">Parameters<a class="headerlink" href="#parameters" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>id</code></td>
|
<td align="left"><code>id</code></td>
|
||||||
<td>string</td>
|
<td align="left"><code>string</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em><a href="../_common_api_index_._common_api_catalog_.catalogentity/">CatalogEntity</a>‹<a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitymetadata/">CatalogEntityMetadata</a>, <a href="../../interfaces/_common_api_index_._common_api_catalog_.catalogentitystatus/">CatalogEntityStatus</a>, object›</em></p>
|
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../common.catalog.catalogentity/">CatalogEntity</a><<a href="../../interfaces/common.catalog.catalogentitymetadata/">CatalogEntityMetadata</a>, <a href="../../interfaces/common.catalog.catalogentitystatus/">CatalogEntityStatus</a>, <a href="../../modules/common.catalog/#catalogentityspec">CatalogEntitySpec</a>></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="getitemsforapikind">getItemsForApiKind<a class="headerlink" href="#getitemsforapikind" title="Permanent link">#</a></h3>
|
<h3 id="getitemsforapikind">getItemsForApiKind<a class="headerlink" href="#getitemsforapikind" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>getItemsForApiKind</strong>‹<strong>T</strong>›(<code>apiVersion</code>: string, <code>kind</code>: string): <em>T[]</em></p>
|
<p>▸ <strong>getItemsForApiKind</strong><T>(<code>apiVersion</code>, <code>kind</code>): <code>T</code>[]</p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/extensions/renderer-api/catalog.ts#L44">src/extensions/renderer-api/catalog.ts:44</a></em></p>
|
<h4 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Type parameters:</strong></p>
|
|
||||||
<p>▪ <strong>T</strong>: <em><a href="../_common_api_index_._common_api_catalog_.catalogentity/">CatalogEntity</a></em></p>
|
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>apiVersion</code></td>
|
<td align="left"><code>T</code></td>
|
||||||
<td>string</td>
|
<td align="left"><code>T</code>: <a href="../common.catalog.catalogentity/">CatalogEntity</a><<a href="../../interfaces/common.catalog.catalogentitymetadata/">CatalogEntityMetadata</a>, <a href="../../interfaces/common.catalog.catalogentitystatus/">CatalogEntityStatus</a>, <a href="../../modules/common.catalog/#catalogentityspec">CatalogEntitySpec</a>, T></td>
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><code>kind</code></td>
|
|
||||||
<td>string</td>
|
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>T[]</em></p>
|
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th align="left">Name</th>
|
||||||
|
<th align="left">Type</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>apiVersion</code></td>
|
||||||
|
<td align="left"><code>string</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>kind</code></td>
|
||||||
|
<td align="left"><code>string</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>T</code>[]</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="getitemsforcategory">getItemsForCategory<a class="headerlink" href="#getitemsforcategory" title="Permanent link">#</a></h3>
|
<h3 id="getitemsforcategory">getItemsForCategory<a class="headerlink" href="#getitemsforcategory" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>getItemsForCategory</strong>‹<strong>T</strong>›(<code>category</code>: <a href="../_common_api_index_._common_api_catalog_.catalogcategory/">CatalogCategory</a>): <em>T[]</em></p>
|
<p>▸ <strong>getItemsForCategory</strong><T>(<code>category</code>): <code>T</code>[]</p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/extensions/renderer-api/catalog.ts#L48">src/extensions/renderer-api/catalog.ts:48</a></em></p>
|
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Type parameters:</strong></p>
|
|
||||||
<p>▪ <strong>T</strong>: <em><a href="../_common_api_index_._common_api_catalog_.catalogentity/">CatalogEntity</a></em></p>
|
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>category</code></td>
|
<td align="left"><code>T</code></td>
|
||||||
<td><a href="../_common_api_index_._common_api_catalog_.catalogcategory/">CatalogCategory</a></td>
|
<td align="left"><code>T</code>: <a href="../common.catalog.catalogentity/">CatalogEntity</a><<a href="../../interfaces/common.catalog.catalogentitymetadata/">CatalogEntityMetadata</a>, <a href="../../interfaces/common.catalog.catalogentitystatus/">CatalogEntityStatus</a>, <a href="../../modules/common.catalog/#catalogentityspec">CatalogEntitySpec</a>, T></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>T[]</em></p>
|
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" 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>category</code></td>
|
||||||
|
<td align="left"><a href="../common.catalog.catalogcategory/">CatalogCategory</a></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>T</code>[]</p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
1434
master/extensions/api/classes/renderer.component.badge/index.html
Normal file
1434
master/extensions/api/classes/renderer.component.badge/index.html
Normal file
File diff suppressed because it is too large
Load Diff
@ -9,7 +9,7 @@
|
|||||||
<meta name="description" content="Documentation for Lens Extension API.">
|
<meta name="description" content="Documentation for Lens Extension API.">
|
||||||
|
|
||||||
|
|
||||||
<link rel="canonical" href="https://api-docs.k8slens.dev/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.barchart/">
|
<link rel="canonical" href="https://api-docs.k8slens.dev/master/extensions/api/classes/renderer.component.barchart/">
|
||||||
|
|
||||||
|
|
||||||
<meta name="author" content="Mirantis, Inc.">
|
<meta name="author" content="Mirantis, Inc.">
|
||||||
@ -19,7 +19,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<title>Class: BarChart ‹**S, SS, S**› - Lens Extension API</title>
|
<title>Class: BarChart - Lens Extension API</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -72,7 +72,7 @@
|
|||||||
<div data-md-component="skip">
|
<div data-md-component="skip">
|
||||||
|
|
||||||
|
|
||||||
<a href="#class-barchart-s-ss-s" class="md-skip">
|
<a href="#class-barchart" class="md-skip">
|
||||||
Skip to content
|
Skip to content
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
@ -103,7 +103,7 @@
|
|||||||
<div class="md-header-nav__topic">
|
<div class="md-header-nav__topic">
|
||||||
<span class="md-ellipsis">
|
<span class="md-ellipsis">
|
||||||
|
|
||||||
Class: BarChart ‹**S, SS, S**›
|
Class: BarChart
|
||||||
|
|
||||||
</span>
|
</span>
|
||||||
</div>
|
</div>
|
||||||
@ -590,13 +590,6 @@
|
|||||||
</label>
|
</label>
|
||||||
<ul class="md-nav__list" data-md-scrollfix>
|
<ul class="md-nav__list" 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">
|
<li class="md-nav__item">
|
||||||
<a href="#hierarchy" class="md-nav__link">
|
<a href="#hierarchy" class="md-nav__link">
|
||||||
Hierarchy
|
Hierarchy
|
||||||
@ -605,11 +598,11 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#index" class="md-nav__link">
|
<a href="#table-of-contents" class="md-nav__link">
|
||||||
Index
|
Table of contents
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
<nav class="md-nav" aria-label="Index">
|
<nav class="md-nav" aria-label="Table of contents">
|
||||||
<ul class="md-nav__list">
|
<ul class="md-nav__list">
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -695,15 +688,15 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#static-optional-contexttype" class="md-nav__link">
|
<a href="#contexttype" class="md-nav__link">
|
||||||
Static Optional contextType
|
contextType
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#static-defaultprops" class="md-nav__link">
|
<a href="#defaultprops" class="md-nav__link">
|
||||||
Static defaultProps
|
defaultProps
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -722,71 +715,71 @@
|
|||||||
<ul class="md-nav__list">
|
<ul class="md-nav__list">
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-unsafe_componentwillmount" class="md-nav__link">
|
<a href="#unsafe_componentwillmount" class="md-nav__link">
|
||||||
Optional UNSAFE_componentWillMount
|
UNSAFE_componentWillMount
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-unsafe_componentwillreceiveprops" class="md-nav__link">
|
<a href="#unsafe_componentwillreceiveprops" class="md-nav__link">
|
||||||
Optional UNSAFE_componentWillReceiveProps
|
UNSAFE_componentWillReceiveProps
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-unsafe_componentwillupdate" class="md-nav__link">
|
<a href="#unsafe_componentwillupdate" class="md-nav__link">
|
||||||
Optional UNSAFE_componentWillUpdate
|
UNSAFE_componentWillUpdate
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-componentdidcatch" class="md-nav__link">
|
<a href="#componentdidcatch" class="md-nav__link">
|
||||||
Optional componentDidCatch
|
componentDidCatch
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-componentdidmount" class="md-nav__link">
|
<a href="#componentdidmount" class="md-nav__link">
|
||||||
Optional componentDidMount
|
componentDidMount
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-componentdidupdate" class="md-nav__link">
|
<a href="#componentdidupdate" class="md-nav__link">
|
||||||
Optional componentDidUpdate
|
componentDidUpdate
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-componentwillmount" class="md-nav__link">
|
<a href="#componentwillmount" class="md-nav__link">
|
||||||
Optional componentWillMount
|
componentWillMount
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-componentwillreceiveprops" class="md-nav__link">
|
<a href="#componentwillreceiveprops" class="md-nav__link">
|
||||||
Optional componentWillReceiveProps
|
componentWillReceiveProps
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-componentwillunmount" class="md-nav__link">
|
<a href="#componentwillunmount" class="md-nav__link">
|
||||||
Optional componentWillUnmount
|
componentWillUnmount
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-componentwillupdate" class="md-nav__link">
|
<a href="#componentwillupdate" class="md-nav__link">
|
||||||
Optional componentWillUpdate
|
componentWillUpdate
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -799,8 +792,8 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-getsnapshotbeforeupdate" class="md-nav__link">
|
<a href="#getsnapshotbeforeupdate" class="md-nav__link">
|
||||||
Optional getSnapshotBeforeUpdate
|
getSnapshotBeforeUpdate
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -820,8 +813,8 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-shouldcomponentupdate" class="md-nav__link">
|
<a href="#shouldcomponentupdate" class="md-nav__link">
|
||||||
Optional shouldComponentUpdate
|
shouldComponentUpdate
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -845,17 +838,14 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<h1 id="class-barchart-s-ss-s">Class: BarChart ‹<strong>S, SS, S</strong>›<a class="headerlink" href="#class-barchart-s-ss-s" title="Permanent link">#</a></h1>
|
<h1 id="class-barchart">Class: BarChart<a class="headerlink" href="#class-barchart" title="Permanent link">#</a></h1>
|
||||||
<h2 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h2>
|
<p><a href="../../modules/renderer/">Renderer</a>.<a href="../../modules/renderer.component/">Component</a>.BarChart</p>
|
||||||
<p>▪ <strong>S</strong></p>
|
|
||||||
<p>▪ <strong>SS</strong></p>
|
|
||||||
<p>▪ <strong>S</strong></p>
|
|
||||||
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
|
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
|
||||||
<ul>
|
<ul>
|
||||||
<li>Component‹Props›</li>
|
<li><code>Component</code><Props></li>
|
||||||
</ul>
|
</ul>
|
||||||
<p>↳ <strong>BarChart</strong></p>
|
<p>↳ <strong>BarChart</strong></p>
|
||||||
<h2 id="index">Index<a class="headerlink" href="#index" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructors">Constructors<a class="headerlink" href="#constructors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="./#constructor">constructor</a></li>
|
<li><a href="./#constructor">constructor</a></li>
|
||||||
@ -866,78 +856,74 @@
|
|||||||
<li><a href="./#props">props</a></li>
|
<li><a href="./#props">props</a></li>
|
||||||
<li><a href="./#refs">refs</a></li>
|
<li><a href="./#refs">refs</a></li>
|
||||||
<li><a href="./#state">state</a></li>
|
<li><a href="./#state">state</a></li>
|
||||||
<li><a href="./#static-optional-contexttype">contextType</a></li>
|
<li><a href="./#contexttype">contextType</a></li>
|
||||||
<li><a href="./#static-defaultprops">defaultProps</a></li>
|
<li><a href="./#defaultprops">defaultProps</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">#</a></h3>
|
<h3 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="./#optional-unsafe_componentwillmount">UNSAFE_componentWillMount</a></li>
|
<li><a href="./#unsafe_componentwillmount">UNSAFE_componentWillMount</a></li>
|
||||||
<li><a href="./#optional-unsafe_componentwillreceiveprops">UNSAFE_componentWillReceiveProps</a></li>
|
<li><a href="./#unsafe_componentwillreceiveprops">UNSAFE_componentWillReceiveProps</a></li>
|
||||||
<li><a href="./#optional-unsafe_componentwillupdate">UNSAFE_componentWillUpdate</a></li>
|
<li><a href="./#unsafe_componentwillupdate">UNSAFE_componentWillUpdate</a></li>
|
||||||
<li><a href="./#optional-componentdidcatch">componentDidCatch</a></li>
|
<li><a href="./#componentdidcatch">componentDidCatch</a></li>
|
||||||
<li><a href="./#optional-componentdidmount">componentDidMount</a></li>
|
<li><a href="./#componentdidmount">componentDidMount</a></li>
|
||||||
<li><a href="./#optional-componentdidupdate">componentDidUpdate</a></li>
|
<li><a href="./#componentdidupdate">componentDidUpdate</a></li>
|
||||||
<li><a href="./#optional-componentwillmount">componentWillMount</a></li>
|
<li><a href="./#componentwillmount">componentWillMount</a></li>
|
||||||
<li><a href="./#optional-componentwillreceiveprops">componentWillReceiveProps</a></li>
|
<li><a href="./#componentwillreceiveprops">componentWillReceiveProps</a></li>
|
||||||
<li><a href="./#optional-componentwillunmount">componentWillUnmount</a></li>
|
<li><a href="./#componentwillunmount">componentWillUnmount</a></li>
|
||||||
<li><a href="./#optional-componentwillupdate">componentWillUpdate</a></li>
|
<li><a href="./#componentwillupdate">componentWillUpdate</a></li>
|
||||||
<li><a href="./#forceupdate">forceUpdate</a></li>
|
<li><a href="./#forceupdate">forceUpdate</a></li>
|
||||||
<li><a href="./#optional-getsnapshotbeforeupdate">getSnapshotBeforeUpdate</a></li>
|
<li><a href="./#getsnapshotbeforeupdate">getSnapshotBeforeUpdate</a></li>
|
||||||
<li><a href="./#render">render</a></li>
|
<li><a href="./#render">render</a></li>
|
||||||
<li><a href="./#setstate">setState</a></li>
|
<li><a href="./#setstate">setState</a></li>
|
||||||
<li><a href="./#optional-shouldcomponentupdate">shouldComponentUpdate</a></li>
|
<li><a href="./#shouldcomponentupdate">shouldComponentUpdate</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
<p>+ <strong>new BarChart</strong>(<code>props</code>: Readonly‹Props› | Props): <em><a href="./">BarChart</a></em></p>
|
<p>• <strong>new BarChart</strong>(<code>props</code>)</p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#constructor">constructor</a></em></p>
|
<h4 id="parameters">Parameters<a class="headerlink" href="#parameters" title="Permanent link">#</a></h4>
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:473</p>
|
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>props</code></td>
|
<td align="left"><code>props</code></td>
|
||||||
<td>Readonly‹Props› | Props</td>
|
<td align="left"><code>Props</code> | <code>Readonly</code><Props></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em><a href="./">BarChart</a></em></p>
|
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||||
<p>+ <strong>new BarChart</strong>(<code>props</code>: Props, <code>context</code>: any): <em><a href="./">BarChart</a></em></p>
|
<p>React.Component<Props>.constructor</p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#constructor">constructor</a></em></p>
|
<p>• <strong>new BarChart</strong>(<code>props</code>, <code>context</code>)</p>
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:475</p>
|
<p><strong><code>deprecated</code></strong></p>
|
||||||
<p><strong><code>deprecated</code></strong> </p>
|
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/legacy-context.html</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/docs/legacy-context.html</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>props</code></td>
|
<td align="left"><code>props</code></td>
|
||||||
<td>Props</td>
|
<td align="left"><code>Props</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>context</code></td>
|
<td align="left"><code>context</code></td>
|
||||||
<td>any</td>
|
<td align="left"><code>any</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em><a href="./">BarChart</a></em></p>
|
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component<Props>.constructor</p>
|
||||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||||
<h3 id="context">context<a class="headerlink" href="#context" title="Permanent link">#</a></h3>
|
<h3 id="context">context<a class="headerlink" href="#context" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>context</strong>: <em>any</em></p>
|
<p>• <strong>context</strong>: <code>any</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#context">context</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:473</p>
|
|
||||||
<p>If using the new style context, re-declare this in your class to be the
|
<p>If using the new style context, re-declare this in your class to be the
|
||||||
<code>React.ContextType</code> of your <code>static contextType</code>.
|
<code>React.ContextType</code> of your <code>static contextType</code>.
|
||||||
Should be used with type annotation or static contextType.</p>
|
Should be used with type annotation or static contextType.</p>
|
||||||
@ -948,32 +934,30 @@ Should be used with type annotation or static contextType.</p>
|
|||||||
<span class="kr">declare</span> <span class="nx">context</span>: <span class="kt">React.ContextType</span><span class="o"><</span><span class="k">typeof</span> <span class="nx">MyContext</span><span class="o">></span>
|
<span class="kr">declare</span> <span class="nx">context</span>: <span class="kt">React.ContextType</span><span class="o"><</span><span class="k">typeof</span> <span class="nx">MyContext</span><span class="o">></span>
|
||||||
</code></pre></div>
|
</code></pre></div>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html</p>
|
||||||
|
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.context</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="props">props<a class="headerlink" href="#props" title="Permanent link">#</a></h3>
|
<h3 id="props">props<a class="headerlink" href="#props" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>props</strong>: <em>Readonly‹Props› & Readonly‹object›</em></p>
|
<p>• <code>Readonly</code> <strong>props</strong>: <code>Readonly</code><Props> & <code>Readonly</code><<code>Object</code>></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#props">props</a></em></p>
|
<h4 id="inherited-from_3">Inherited from<a class="headerlink" href="#inherited-from_3" title="Permanent link">#</a></h4>
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:498</p>
|
<p>React.Component.props</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="refs">refs<a class="headerlink" href="#refs" title="Permanent link">#</a></h3>
|
<h3 id="refs">refs<a class="headerlink" href="#refs" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>refs</strong>: <em>object</em></p>
|
<p>• <strong>refs</strong>: <code>Object</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#refs">refs</a></em></p>
|
<p><strong><code>deprecated</code></strong>
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:504</p>
|
|
||||||
<p><strong><code>deprecated</code></strong>
|
|
||||||
https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||||
<h4 id="type-declaration">Type declaration:<a class="headerlink" href="#type-declaration" title="Permanent link">#</a></h4>
|
<h4 id="index-signature">Index signature<a class="headerlink" href="#index-signature" title="Permanent link">#</a></h4>
|
||||||
<ul>
|
<p>▪ [key: <code>string</code>]: <code>ReactInstance</code></p>
|
||||||
<li>[ <strong>key</strong>: <em>string</em>]: ReactInstance</li>
|
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||||
</ul>
|
<p>React.Component.refs</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="state">state<a class="headerlink" href="#state" title="Permanent link">#</a></h3>
|
<h3 id="state">state<a class="headerlink" href="#state" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>state</strong>: <em>Readonly‹S›</em></p>
|
<p>• <strong>state</strong>: <code>Readonly</code><<code>Object</code>></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#state">state</a></em></p>
|
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:499</p>
|
<p>React.Component.state</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="static-optional-contexttype"><code>Static</code> <code>Optional</code> contextType<a class="headerlink" href="#static-optional-contexttype" title="Permanent link">#</a></h3>
|
<h3 id="contexttype">contextType<a class="headerlink" href="#contexttype" title="Permanent link">#</a></h3>
|
||||||
<p>▪ <strong>contextType</strong>? : <em>Context‹any›</em></p>
|
<p>▪ <code>Static</code> <code>Optional</code> <strong>contextType</strong>: <code>Context</code><any></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#static-optional-contexttype">contextType</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:455</p>
|
|
||||||
<p>If set, <code>this.context</code> will be set at runtime to the current value of the given Context.</p>
|
<p>If set, <code>this.context</code> will be set at runtime to the current value of the given Context.</p>
|
||||||
<p>Usage:</p>
|
<p>Usage:</p>
|
||||||
<div class="highlight"><pre><span></span><code><span class="kd">type</span> <span class="nx">MyContext</span> <span class="o">=</span> <span class="kt">number</span>
|
<div class="highlight"><pre><span></span><code><span class="kd">type</span> <span class="nx">MyContext</span> <span class="o">=</span> <span class="kt">number</span>
|
||||||
@ -988,15 +972,14 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
|||||||
<span class="p">}</span>
|
<span class="p">}</span>
|
||||||
</code></pre></div>
|
</code></pre></div>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html#classcontexttype</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||||
|
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.contextType</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="static-defaultprops"><code>Static</code> defaultProps<a class="headerlink" href="#static-defaultprops" title="Permanent link">#</a></h3>
|
<h3 id="defaultprops">defaultProps<a class="headerlink" href="#defaultprops" title="Permanent link">#</a></h3>
|
||||||
<p>▪ <strong>defaultProps</strong>: <em>object</em> = defaultProps as object</p>
|
<p>▪ <code>Static</code> <strong>defaultProps</strong>: <code>object</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/chart/bar-chart.tsx#L46">src/renderer/components/chart/bar-chart.tsx:46</a></em></p>
|
|
||||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||||
<h3 id="optional-unsafe_componentwillmount"><code>Optional</code> UNSAFE_componentWillMount<a class="headerlink" href="#optional-unsafe_componentwillmount" title="Permanent link">#</a></h3>
|
<h3 id="unsafe_componentwillmount">UNSAFE_componentWillMount<a class="headerlink" href="#unsafe_componentwillmount" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>UNSAFE_componentWillMount</strong>(): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>UNSAFE_componentWillMount</strong>(): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-unsafe_componentwillmount">UNSAFE_componentWillMount</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:711</p>
|
|
||||||
<p>Called immediately before mounting occurs, and before <code>Component#render</code>.
|
<p>Called immediately before mounting occurs, and before <code>Component#render</code>.
|
||||||
Avoid introducing any side-effects or subscriptions in this method.</p>
|
Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||||
<p>This method will not stop working in React 17.</p>
|
<p>This method will not stop working in React 17.</p>
|
||||||
@ -1005,12 +988,13 @@ prevents this from being invoked.</p>
|
|||||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead</p>
|
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.UNSAFE_componentWillMount</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-unsafe_componentwillreceiveprops"><code>Optional</code> UNSAFE_componentWillReceiveProps<a class="headerlink" href="#optional-unsafe_componentwillreceiveprops" title="Permanent link">#</a></h3>
|
<h3 id="unsafe_componentwillreceiveprops">UNSAFE_componentWillReceiveProps<a class="headerlink" href="#unsafe_componentwillreceiveprops" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>UNSAFE_componentWillReceiveProps</strong>(<code>nextProps</code>: Readonly‹Props›, <code>nextContext</code>: any): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>UNSAFE_componentWillReceiveProps</strong>(<code>nextProps</code>, <code>nextContext</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-unsafe_componentwillreceiveprops">UNSAFE_componentWillReceiveProps</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:743</p>
|
|
||||||
<p>Called when the component may be receiving new props.
|
<p>Called when the component may be receiving new props.
|
||||||
React may call this even if props have not changed, so be sure to compare new and existing
|
React may call this even if props have not changed, so be sure to compare new and existing
|
||||||
props if you only want to handle changes.</p>
|
props if you only want to handle changes.</p>
|
||||||
@ -1021,31 +1005,32 @@ prevents this from being invoked.</p>
|
|||||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead</p>
|
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextProps</code></td>
|
<td align="left"><code>nextProps</code></td>
|
||||||
<td>Readonly‹Props›</td>
|
<td align="left"><code>Readonly</code><Props></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextContext</code></td>
|
<td align="left"><code>nextContext</code></td>
|
||||||
<td>any</td>
|
<td align="left"><code>any</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.UNSAFE_componentWillReceiveProps</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-unsafe_componentwillupdate"><code>Optional</code> UNSAFE_componentWillUpdate<a class="headerlink" href="#optional-unsafe_componentwillupdate" title="Permanent link">#</a></h3>
|
<h3 id="unsafe_componentwillupdate">UNSAFE_componentWillUpdate<a class="headerlink" href="#unsafe_componentwillupdate" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>UNSAFE_componentWillUpdate</strong>(<code>nextProps</code>: Readonly‹Props›, <code>nextState</code>: Readonly‹S›, <code>nextContext</code>: any): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>UNSAFE_componentWillUpdate</strong>(<code>nextProps</code>, <code>nextState</code>, <code>nextContext</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-unsafe_componentwillupdate">UNSAFE_componentWillUpdate</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:771</p>
|
|
||||||
<p>Called immediately before rendering when new props or state is received. Not called for the initial render.</p>
|
<p>Called immediately before rendering when new props or state is received. Not called for the initial render.</p>
|
||||||
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
||||||
<p>This method will not stop working in React 17.</p>
|
<p>This method will not stop working in React 17.</p>
|
||||||
@ -1054,100 +1039,104 @@ prevents this from being invoked.</p>
|
|||||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead</p>
|
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextProps</code></td>
|
<td align="left"><code>nextProps</code></td>
|
||||||
<td>Readonly‹Props›</td>
|
<td align="left"><code>Readonly</code><Props></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextState</code></td>
|
<td align="left"><code>nextState</code></td>
|
||||||
<td>Readonly‹S›</td>
|
<td align="left"><code>Readonly</code><<code>Object</code>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextContext</code></td>
|
<td align="left"><code>nextContext</code></td>
|
||||||
<td>any</td>
|
<td align="left"><code>any</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.UNSAFE_componentWillUpdate</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-componentdidcatch"><code>Optional</code> componentDidCatch<a class="headerlink" href="#optional-componentdidcatch" title="Permanent link">#</a></h3>
|
<h3 id="componentdidcatch">componentDidCatch<a class="headerlink" href="#componentdidcatch" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>componentDidCatch</strong>(<code>error</code>: Error, <code>errorInfo</code>: ErrorInfo): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>componentDidCatch</strong>(<code>error</code>, <code>errorInfo</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-componentdidcatch">componentDidCatch</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:640</p>
|
|
||||||
<p>Catches exceptions generated in descendant components. Unhandled exceptions will cause
|
<p>Catches exceptions generated in descendant components. Unhandled exceptions will cause
|
||||||
the entire component tree to unmount.</p>
|
the entire component tree to unmount.</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>error</code></td>
|
<td align="left"><code>error</code></td>
|
||||||
<td>Error</td>
|
<td align="left"><code>Error</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>errorInfo</code></td>
|
<td align="left"><code>errorInfo</code></td>
|
||||||
<td>ErrorInfo</td>
|
<td align="left"><code>ErrorInfo</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.componentDidCatch</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-componentdidmount"><code>Optional</code> componentDidMount<a class="headerlink" href="#optional-componentdidmount" title="Permanent link">#</a></h3>
|
<h3 id="componentdidmount">componentDidMount<a class="headerlink" href="#componentdidmount" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>componentDidMount</strong>(): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>componentDidMount</strong>(): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.wizardlayout/">WizardLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.wizardlayout/#optional-componentdidmount">componentDidMount</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:619</p>
|
|
||||||
<p>Called immediately after a component is mounted. Setting state here will trigger re-rendering.</p>
|
<p>Called immediately after a component is mounted. Setting state here will trigger re-rendering.</p>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<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>React.Component.componentDidMount</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-componentdidupdate"><code>Optional</code> componentDidUpdate<a class="headerlink" href="#optional-componentdidupdate" title="Permanent link">#</a></h3>
|
<h3 id="componentdidupdate">componentDidUpdate<a class="headerlink" href="#componentdidupdate" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>componentDidUpdate</strong>(<code>prevProps</code>: Readonly‹Props›, <code>prevState</code>: Readonly‹S›, <code>snapshot?</code>: SS): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>componentDidUpdate</strong>(<code>prevProps</code>, <code>prevState</code>, <code>snapshot?</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-componentdidupdate">componentDidUpdate</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:682</p>
|
|
||||||
<p>Called immediately after updating occurs. Not called for the initial render.</p>
|
<p>Called immediately after updating occurs. Not called for the initial render.</p>
|
||||||
<p>The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.</p>
|
<p>The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>prevProps</code></td>
|
<td align="left"><code>prevProps</code></td>
|
||||||
<td>Readonly‹Props›</td>
|
<td align="left"><code>Readonly</code><Props></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>prevState</code></td>
|
<td align="left"><code>prevState</code></td>
|
||||||
<td>Readonly‹S›</td>
|
<td align="left"><code>Readonly</code><<code>Object</code>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>snapshot?</code></td>
|
<td align="left"><code>snapshot?</code></td>
|
||||||
<td>SS</td>
|
<td align="left"><code>any</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.componentDidUpdate</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-componentwillmount"><code>Optional</code> componentWillMount<a class="headerlink" href="#optional-componentwillmount" title="Permanent link">#</a></h3>
|
<h3 id="componentwillmount">componentWillMount<a class="headerlink" href="#componentwillmount" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>componentWillMount</strong>(): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>componentWillMount</strong>(): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-componentwillmount">componentWillMount</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:697</p>
|
|
||||||
<p>Called immediately before mounting occurs, and before <code>Component#render</code>.
|
<p>Called immediately before mounting occurs, and before <code>Component#render</code>.
|
||||||
Avoid introducing any side-effects or subscriptions in this method.</p>
|
Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||||
@ -1155,12 +1144,13 @@ prevents this from being invoked.</p>
|
|||||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.componentWillMount</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-componentwillreceiveprops"><code>Optional</code> componentWillReceiveProps<a class="headerlink" href="#optional-componentwillreceiveprops" title="Permanent link">#</a></h3>
|
<h3 id="componentwillreceiveprops">componentWillReceiveProps<a class="headerlink" href="#componentwillreceiveprops" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>componentWillReceiveProps</strong>(<code>nextProps</code>: Readonly‹Props›, <code>nextContext</code>: any): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>componentWillReceiveProps</strong>(<code>nextProps</code>, <code>nextContext</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-componentwillreceiveprops">componentWillReceiveProps</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:726</p>
|
|
||||||
<p>Called when the component may be receiving new props.
|
<p>Called when the component may be receiving new props.
|
||||||
React may call this even if props have not changed, so be sure to compare new and existing
|
React may call this even if props have not changed, so be sure to compare new and existing
|
||||||
props if you only want to handle changes.</p>
|
props if you only want to handle changes.</p>
|
||||||
@ -1170,39 +1160,41 @@ prevents this from being invoked.</p>
|
|||||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextProps</code></td>
|
<td align="left"><code>nextProps</code></td>
|
||||||
<td>Readonly‹Props›</td>
|
<td align="left"><code>Readonly</code><Props></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextContext</code></td>
|
<td align="left"><code>nextContext</code></td>
|
||||||
<td>any</td>
|
<td align="left"><code>any</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.componentWillReceiveProps</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-componentwillunmount"><code>Optional</code> componentWillUnmount<a class="headerlink" href="#optional-componentwillunmount" title="Permanent link">#</a></h3>
|
<h3 id="componentwillunmount">componentWillUnmount<a class="headerlink" href="#componentwillunmount" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>componentWillUnmount</strong>(): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>componentWillUnmount</strong>(): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.wizardlayout/">WizardLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.wizardlayout/#optional-componentwillunmount">componentWillUnmount</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:635</p>
|
|
||||||
<p>Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as
|
<p>Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as
|
||||||
cancelled network requests, or cleaning up any DOM elements created in <code>componentDidMount</code>.</p>
|
cancelled network requests, or cleaning up any DOM elements created in <code>componentDidMount</code>.</p>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.componentWillUnmount</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-componentwillupdate"><code>Optional</code> componentWillUpdate<a class="headerlink" href="#optional-componentwillupdate" title="Permanent link">#</a></h3>
|
<h3 id="componentwillupdate">componentWillUpdate<a class="headerlink" href="#componentwillupdate" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>componentWillUpdate</strong>(<code>nextProps</code>: Readonly‹Props›, <code>nextState</code>: Readonly‹S›, <code>nextContext</code>: any): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>componentWillUpdate</strong>(<code>nextProps</code>, <code>nextState</code>, <code>nextContext</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-componentwillupdate">componentWillUpdate</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:756</p>
|
|
||||||
<p>Called immediately before rendering when new props or state is received. Not called for the initial render.</p>
|
<p>Called immediately before rendering when new props or state is received. Not called for the initial render.</p>
|
||||||
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
||||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||||
@ -1210,122 +1202,170 @@ prevents this from being invoked.</p>
|
|||||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextProps</code></td>
|
<td align="left"><code>nextProps</code></td>
|
||||||
<td>Readonly‹Props›</td>
|
<td align="left"><code>Readonly</code><Props></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextState</code></td>
|
<td align="left"><code>nextState</code></td>
|
||||||
<td>Readonly‹S›</td>
|
<td align="left"><code>Readonly</code><<code>Object</code>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextContext</code></td>
|
<td align="left"><code>nextContext</code></td>
|
||||||
<td>any</td>
|
<td align="left"><code>any</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.componentWillUpdate</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="forceupdate">forceUpdate<a class="headerlink" href="#forceupdate" title="Permanent link">#</a></h3>
|
<h3 id="forceupdate">forceUpdate<a class="headerlink" href="#forceupdate" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>forceUpdate</strong>(<code>callback?</code>: function): <em>void</em></p>
|
<p>▸ <strong>forceUpdate</strong>(<code>callback?</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#forceupdate">forceUpdate</a></em></p>
|
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:490</p>
|
<table>
|
||||||
<p><strong>Parameters:</strong></p>
|
<thead>
|
||||||
<p>▪<code>Optional</code> <strong>callback</strong>: <em>function</em></p>
|
<tr>
|
||||||
<p>▸ (): <em>void</em></p>
|
<th align="left">Name</th>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<th align="left">Type</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>callback?</code></td>
|
||||||
|
<td align="left">() => <code>void</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.forceUpdate</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-getsnapshotbeforeupdate"><code>Optional</code> getSnapshotBeforeUpdate<a class="headerlink" href="#optional-getsnapshotbeforeupdate" title="Permanent link">#</a></h3>
|
<h3 id="getsnapshotbeforeupdate">getSnapshotBeforeUpdate<a class="headerlink" href="#getsnapshotbeforeupdate" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>getSnapshotBeforeUpdate</strong>(<code>prevProps</code>: Readonly‹Props›, <code>prevState</code>: Readonly‹S›): <em>SS | null</em></p>
|
<p>▸ <code>Optional</code> <strong>getSnapshotBeforeUpdate</strong>(<code>prevProps</code>, <code>prevState</code>): <code>any</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-getsnapshotbeforeupdate">getSnapshotBeforeUpdate</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:676</p>
|
|
||||||
<p>Runs before React applies the result of <code>render</code> to the document, and
|
<p>Runs before React applies the result of <code>render</code> to the document, and
|
||||||
returns an object to be given to componentDidUpdate. Useful for saving
|
returns an object to be given to componentDidUpdate. Useful for saving
|
||||||
things such as scroll position before <code>render</code> causes changes to it.</p>
|
things such as scroll position before <code>render</code> causes changes to it.</p>
|
||||||
<p>Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated
|
<p>Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated
|
||||||
lifecycle events from running.</p>
|
lifecycle events from running.</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>prevProps</code></td>
|
<td align="left"><code>prevProps</code></td>
|
||||||
<td>Readonly‹Props›</td>
|
<td align="left"><code>Readonly</code><Props></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>prevState</code></td>
|
<td align="left"><code>prevState</code></td>
|
||||||
<td>Readonly‹S›</td>
|
<td align="left"><code>Readonly</code><<code>Object</code>></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>SS | null</em></p>
|
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>any</code></p>
|
||||||
|
<h4 id="inherited-from_18">Inherited from<a class="headerlink" href="#inherited-from_18" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.getSnapshotBeforeUpdate</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="render">render<a class="headerlink" href="#render" title="Permanent link">#</a></h3>
|
<h3 id="render">render<a class="headerlink" href="#render" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>render</strong>(): <em>Element‹›</em></p>
|
<p>▸ <strong>render</strong>(): <code>Element</code></p>
|
||||||
<p><em>Overrides void</em></p>
|
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/chart/bar-chart.tsx#L48">src/renderer/components/chart/bar-chart.tsx:48</a></em></p>
|
<p><code>Element</code></p>
|
||||||
<p><strong>Returns:</strong> <em>Element‹›</em></p>
|
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.render</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="setstate">setState<a class="headerlink" href="#setstate" title="Permanent link">#</a></h3>
|
<h3 id="setstate">setState<a class="headerlink" href="#setstate" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>setState</strong>‹<strong>K</strong>›(<code>state</code>: function | S | object, <code>callback?</code>: function): <em>void</em></p>
|
<p>▸ <strong>setState</strong><K>(<code>state</code>, <code>callback?</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#setstate">setState</a></em></p>
|
<h4 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h4>
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:485</p>
|
<table>
|
||||||
<p><strong>Type parameters:</strong></p>
|
<thead>
|
||||||
<p>▪ <strong>K</strong>: <em>keyof S</em></p>
|
<tr>
|
||||||
<p><strong>Parameters:</strong></p>
|
<th align="left">Name</th>
|
||||||
<p>▪ <strong>state</strong>: <em>function | S | object</em></p>
|
<th align="left">Type</th>
|
||||||
<p>▪<code>Optional</code> <strong>callback</strong>: <em>function</em></p>
|
</tr>
|
||||||
<p>▸ (): <em>void</em></p>
|
</thead>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>K</code></td>
|
||||||
|
<td align="left"><code>K</code>: <code>never</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" 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>state</code></td>
|
||||||
|
<td align="left">{} | (<code>prevState</code>: <code>Readonly</code><<code>Object</code>>, <code>props</code>: <code>Readonly</code><Props\>) => {} | <code>Pick</code><<code>Object</code>, K> | <code>Pick</code><<code>Object</code>, K></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>callback?</code></td>
|
||||||
|
<td align="left">() => <code>void</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.setState</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-shouldcomponentupdate"><code>Optional</code> shouldComponentUpdate<a class="headerlink" href="#optional-shouldcomponentupdate" title="Permanent link">#</a></h3>
|
<h3 id="shouldcomponentupdate">shouldComponentUpdate<a class="headerlink" href="#shouldcomponentupdate" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>shouldComponentUpdate</strong>(<code>nextProps</code>: Readonly‹Props›, <code>nextState</code>: Readonly‹S›, <code>nextContext</code>: any): <em>boolean</em></p>
|
<p>▸ <code>Optional</code> <strong>shouldComponentUpdate</strong>(<code>nextProps</code>, <code>nextState</code>, <code>nextContext</code>): <code>boolean</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-shouldcomponentupdate">shouldComponentUpdate</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:630</p>
|
|
||||||
<p>Called to determine whether the change in props and state should trigger a re-render.</p>
|
<p>Called to determine whether the change in props and state should trigger a re-render.</p>
|
||||||
<p><code>Component</code> always returns true.
|
<p><code>Component</code> always returns true.
|
||||||
<code>PureComponent</code> implements a shallow comparison on props and state and returns true if any
|
<code>PureComponent</code> implements a shallow comparison on props and state and returns true if any
|
||||||
props or states have changed.</p>
|
props or states have changed.</p>
|
||||||
<p>If false is returned, <code>Component#render</code>, <code>componentWillUpdate</code>
|
<p>If false is returned, <code>Component#render</code>, <code>componentWillUpdate</code>
|
||||||
and <code>componentDidUpdate</code> will not be called.</p>
|
and <code>componentDidUpdate</code> will not be called.</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextProps</code></td>
|
<td align="left"><code>nextProps</code></td>
|
||||||
<td>Readonly‹Props›</td>
|
<td align="left"><code>Readonly</code><Props></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextState</code></td>
|
<td align="left"><code>nextState</code></td>
|
||||||
<td>Readonly‹S›</td>
|
<td align="left"><code>Readonly</code><<code>Object</code>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextContext</code></td>
|
<td align="left"><code>nextContext</code></td>
|
||||||
<td>any</td>
|
<td align="left"><code>any</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>boolean</em></p>
|
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>boolean</code></p>
|
||||||
|
<h4 id="inherited-from_20">Inherited from<a class="headerlink" href="#inherited-from_20" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.shouldComponentUpdate</p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
1434
master/extensions/api/classes/renderer.component.button/index.html
Normal file
1434
master/extensions/api/classes/renderer.component.button/index.html
Normal file
File diff suppressed because it is too large
Load Diff
1475
master/extensions/api/classes/renderer.component.checkbox/index.html
Normal file
1475
master/extensions/api/classes/renderer.component.checkbox/index.html
Normal file
File diff suppressed because it is too large
Load Diff
@ -9,7 +9,7 @@
|
|||||||
<meta name="description" content="Documentation for Lens Extension API.">
|
<meta name="description" content="Documentation for Lens Extension API.">
|
||||||
|
|
||||||
|
|
||||||
<link rel="canonical" href="https://api-docs.k8slens.dev/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.commandoverlay/">
|
<link rel="canonical" href="https://api-docs.k8slens.dev/master/extensions/api/classes/renderer.component.commandoverlay/">
|
||||||
|
|
||||||
|
|
||||||
<meta name="author" content="Mirantis, Inc.">
|
<meta name="author" content="Mirantis, Inc.">
|
||||||
@ -591,19 +591,19 @@
|
|||||||
<ul class="md-nav__list" data-md-scrollfix>
|
<ul class="md-nav__list" data-md-scrollfix>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#hierarchy" class="md-nav__link">
|
<a href="#table-of-contents" class="md-nav__link">
|
||||||
Hierarchy
|
Table of contents
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<nav class="md-nav" aria-label="Table of contents">
|
||||||
|
<ul class="md-nav__list">
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#constructors" class="md-nav__link">
|
||||||
|
Constructors
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#index" class="md-nav__link">
|
|
||||||
Index
|
|
||||||
</a>
|
|
||||||
|
|
||||||
<nav class="md-nav" aria-label="Index">
|
|
||||||
<ul class="md-nav__list">
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#methods" class="md-nav__link">
|
<a href="#methods" class="md-nav__link">
|
||||||
@ -615,6 +615,26 @@
|
|||||||
</ul>
|
</ul>
|
||||||
</nav>
|
</nav>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#constructors_1" class="md-nav__link">
|
||||||
|
Constructors
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<nav class="md-nav" aria-label="Constructors">
|
||||||
|
<ul class="md-nav__list">
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#constructor" class="md-nav__link">
|
||||||
|
constructor
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -626,15 +646,15 @@
|
|||||||
<ul class="md-nav__list">
|
<ul class="md-nav__list">
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#static-close" class="md-nav__link">
|
<a href="#close" class="md-nav__link">
|
||||||
Static close
|
close
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#static-open" class="md-nav__link">
|
<a href="#open" class="md-nav__link">
|
||||||
Static open
|
open
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -659,41 +679,45 @@
|
|||||||
|
|
||||||
|
|
||||||
<h1 id="class-commandoverlay">Class: CommandOverlay<a class="headerlink" href="#class-commandoverlay" title="Permanent link">#</a></h1>
|
<h1 id="class-commandoverlay">Class: CommandOverlay<a class="headerlink" href="#class-commandoverlay" title="Permanent link">#</a></h1>
|
||||||
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
|
<p><a href="../../modules/renderer/">Renderer</a>.<a href="../../modules/renderer.component/">Component</a>.CommandOverlay</p>
|
||||||
|
<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>
|
<ul>
|
||||||
<li><strong>CommandOverlay</strong></li>
|
<li><a href="./#constructor">constructor</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="index">Index<a class="headerlink" href="#index" title="Permanent link">#</a></h2>
|
|
||||||
<h3 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">#</a></h3>
|
<h3 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="./#static-close">close</a></li>
|
<li><a href="./#close">close</a></li>
|
||||||
<li><a href="./#static-open">open</a></li>
|
<li><a href="./#open">open</a></li>
|
||||||
</ul>
|
</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 CommandOverlay</strong>()</p>
|
||||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||||
<h3 id="static-close"><code>Static</code> close<a class="headerlink" href="#static-close" title="Permanent link">#</a></h3>
|
<h3 id="close">close<a class="headerlink" href="#close" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>close</strong>(): <em>void</em></p>
|
<p>▸ <code>Static</code> <strong>close</strong>(): <code>void</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/command-palette/command-container.tsx#L46">src/renderer/components/command-palette/command-container.tsx:46</a></em></p>
|
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<p><code>void</code></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="static-open"><code>Static</code> open<a class="headerlink" href="#static-open" title="Permanent link">#</a></h3>
|
<h3 id="open">open<a class="headerlink" href="#open" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>open</strong>(<code>component</code>: ReactElement): <em>void</em></p>
|
<p>▸ <code>Static</code> <strong>open</strong>(<code>component</code>): <code>void</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/command-palette/command-container.tsx#L42">src/renderer/components/command-palette/command-container.tsx:42</a></em></p>
|
<h4 id="parameters">Parameters<a class="headerlink" href="#parameters" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>component</code></td>
|
<td align="left"><code>component</code></td>
|
||||||
<td>ReactElement</td>
|
<td align="left"><code>ReactElement</code><any, string | JSXElementConstructor<any>></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
1628
master/extensions/api/classes/renderer.component.dialog/index.html
Normal file
1628
master/extensions/api/classes/renderer.component.dialog/index.html
Normal file
File diff suppressed because it is too large
Load Diff
@ -9,7 +9,7 @@
|
|||||||
<meta name="description" content="Documentation for Lens Extension API.">
|
<meta name="description" content="Documentation for Lens Extension API.">
|
||||||
|
|
||||||
|
|
||||||
<link rel="canonical" href="https://api-docs.k8slens.dev/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.drawer/">
|
<link rel="canonical" href="https://api-docs.k8slens.dev/master/extensions/api/classes/renderer.component.drawer/">
|
||||||
|
|
||||||
|
|
||||||
<meta name="author" content="Mirantis, Inc.">
|
<meta name="author" content="Mirantis, Inc.">
|
||||||
@ -19,7 +19,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<title>Class: Drawer ‹**S, SS, S**› - Lens Extension API</title>
|
<title>Class: Drawer - Lens Extension API</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -72,7 +72,7 @@
|
|||||||
<div data-md-component="skip">
|
<div data-md-component="skip">
|
||||||
|
|
||||||
|
|
||||||
<a href="#class-drawer-s-ss-s" class="md-skip">
|
<a href="#class-drawer" class="md-skip">
|
||||||
Skip to content
|
Skip to content
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
@ -103,7 +103,7 @@
|
|||||||
<div class="md-header-nav__topic">
|
<div class="md-header-nav__topic">
|
||||||
<span class="md-ellipsis">
|
<span class="md-ellipsis">
|
||||||
|
|
||||||
Class: Drawer ‹**S, SS, S**›
|
Class: Drawer
|
||||||
|
|
||||||
</span>
|
</span>
|
||||||
</div>
|
</div>
|
||||||
@ -590,13 +590,6 @@
|
|||||||
</label>
|
</label>
|
||||||
<ul class="md-nav__list" data-md-scrollfix>
|
<ul class="md-nav__list" 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">
|
<li class="md-nav__item">
|
||||||
<a href="#hierarchy" class="md-nav__link">
|
<a href="#hierarchy" class="md-nav__link">
|
||||||
Hierarchy
|
Hierarchy
|
||||||
@ -605,11 +598,11 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#index" class="md-nav__link">
|
<a href="#table-of-contents" class="md-nav__link">
|
||||||
Index
|
Table of contents
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
<nav class="md-nav" aria-label="Index">
|
<nav class="md-nav" aria-label="Table of contents">
|
||||||
<ul class="md-nav__list">
|
<ul class="md-nav__list">
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -695,15 +688,15 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#static-optional-contexttype" class="md-nav__link">
|
<a href="#contexttype" class="md-nav__link">
|
||||||
Static Optional contextType
|
contextType
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#static-defaultprops" class="md-nav__link">
|
<a href="#defaultprops" class="md-nav__link">
|
||||||
Static defaultProps
|
defaultProps
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -722,22 +715,22 @@
|
|||||||
<ul class="md-nav__list">
|
<ul class="md-nav__list">
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-unsafe_componentwillmount" class="md-nav__link">
|
<a href="#unsafe_componentwillmount" class="md-nav__link">
|
||||||
Optional UNSAFE_componentWillMount
|
UNSAFE_componentWillMount
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-unsafe_componentwillreceiveprops" class="md-nav__link">
|
<a href="#unsafe_componentwillreceiveprops" class="md-nav__link">
|
||||||
Optional UNSAFE_componentWillReceiveProps
|
UNSAFE_componentWillReceiveProps
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-unsafe_componentwillupdate" class="md-nav__link">
|
<a href="#unsafe_componentwillupdate" class="md-nav__link">
|
||||||
Optional UNSAFE_componentWillUpdate
|
UNSAFE_componentWillUpdate
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -750,8 +743,8 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-componentdidcatch" class="md-nav__link">
|
<a href="#componentdidcatch" class="md-nav__link">
|
||||||
Optional componentDidCatch
|
componentDidCatch
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -764,22 +757,22 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-componentdidupdate" class="md-nav__link">
|
<a href="#componentdidupdate" class="md-nav__link">
|
||||||
Optional componentDidUpdate
|
componentDidUpdate
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-componentwillmount" class="md-nav__link">
|
<a href="#componentwillmount" class="md-nav__link">
|
||||||
Optional componentWillMount
|
componentWillMount
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-componentwillreceiveprops" class="md-nav__link">
|
<a href="#componentwillreceiveprops" class="md-nav__link">
|
||||||
Optional componentWillReceiveProps
|
componentWillReceiveProps
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -792,8 +785,8 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-componentwillupdate" class="md-nav__link">
|
<a href="#componentwillupdate" class="md-nav__link">
|
||||||
Optional componentWillUpdate
|
componentWillUpdate
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -806,8 +799,8 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-getsnapshotbeforeupdate" class="md-nav__link">
|
<a href="#getsnapshotbeforeupdate" class="md-nav__link">
|
||||||
Optional getSnapshotBeforeUpdate
|
getSnapshotBeforeUpdate
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -862,8 +855,8 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-shouldcomponentupdate" class="md-nav__link">
|
<a href="#shouldcomponentupdate" class="md-nav__link">
|
||||||
Optional shouldComponentUpdate
|
shouldComponentUpdate
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -887,17 +880,14 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<h1 id="class-drawer-s-ss-s">Class: Drawer ‹<strong>S, SS, S</strong>›<a class="headerlink" href="#class-drawer-s-ss-s" title="Permanent link">#</a></h1>
|
<h1 id="class-drawer">Class: Drawer<a class="headerlink" href="#class-drawer" title="Permanent link">#</a></h1>
|
||||||
<h2 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h2>
|
<p><a href="../../modules/renderer/">Renderer</a>.<a href="../../modules/renderer.component/">Component</a>.Drawer</p>
|
||||||
<p>▪ <strong>S</strong></p>
|
|
||||||
<p>▪ <strong>SS</strong></p>
|
|
||||||
<p>▪ <strong>S</strong></p>
|
|
||||||
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
|
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
|
||||||
<ul>
|
<ul>
|
||||||
<li>Component‹<a href="../../interfaces/_renderer_api_index_._renderer_api_components_.drawerprops/">DrawerProps</a>›</li>
|
<li><code>Component</code><<a href="../../interfaces/renderer.component.drawerprops/">DrawerProps</a>></li>
|
||||||
</ul>
|
</ul>
|
||||||
<p>↳ <strong>Drawer</strong></p>
|
<p>↳ <strong>Drawer</strong></p>
|
||||||
<h2 id="index">Index<a class="headerlink" href="#index" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructors">Constructors<a class="headerlink" href="#constructors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="./#constructor">constructor</a></li>
|
<li><a href="./#constructor">constructor</a></li>
|
||||||
@ -908,24 +898,24 @@
|
|||||||
<li><a href="./#props">props</a></li>
|
<li><a href="./#props">props</a></li>
|
||||||
<li><a href="./#refs">refs</a></li>
|
<li><a href="./#refs">refs</a></li>
|
||||||
<li><a href="./#state">state</a></li>
|
<li><a href="./#state">state</a></li>
|
||||||
<li><a href="./#static-optional-contexttype">contextType</a></li>
|
<li><a href="./#contexttype">contextType</a></li>
|
||||||
<li><a href="./#static-defaultprops">defaultProps</a></li>
|
<li><a href="./#defaultprops">defaultProps</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">#</a></h3>
|
<h3 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="./#optional-unsafe_componentwillmount">UNSAFE_componentWillMount</a></li>
|
<li><a href="./#unsafe_componentwillmount">UNSAFE_componentWillMount</a></li>
|
||||||
<li><a href="./#optional-unsafe_componentwillreceiveprops">UNSAFE_componentWillReceiveProps</a></li>
|
<li><a href="./#unsafe_componentwillreceiveprops">UNSAFE_componentWillReceiveProps</a></li>
|
||||||
<li><a href="./#optional-unsafe_componentwillupdate">UNSAFE_componentWillUpdate</a></li>
|
<li><a href="./#unsafe_componentwillupdate">UNSAFE_componentWillUpdate</a></li>
|
||||||
<li><a href="./#close">close</a></li>
|
<li><a href="./#close">close</a></li>
|
||||||
<li><a href="./#optional-componentdidcatch">componentDidCatch</a></li>
|
<li><a href="./#componentdidcatch">componentDidCatch</a></li>
|
||||||
<li><a href="./#componentdidmount">componentDidMount</a></li>
|
<li><a href="./#componentdidmount">componentDidMount</a></li>
|
||||||
<li><a href="./#optional-componentdidupdate">componentDidUpdate</a></li>
|
<li><a href="./#componentdidupdate">componentDidUpdate</a></li>
|
||||||
<li><a href="./#optional-componentwillmount">componentWillMount</a></li>
|
<li><a href="./#componentwillmount">componentWillMount</a></li>
|
||||||
<li><a href="./#optional-componentwillreceiveprops">componentWillReceiveProps</a></li>
|
<li><a href="./#componentwillreceiveprops">componentWillReceiveProps</a></li>
|
||||||
<li><a href="./#componentwillunmount">componentWillUnmount</a></li>
|
<li><a href="./#componentwillunmount">componentWillUnmount</a></li>
|
||||||
<li><a href="./#optional-componentwillupdate">componentWillUpdate</a></li>
|
<li><a href="./#componentwillupdate">componentWillUpdate</a></li>
|
||||||
<li><a href="./#forceupdate">forceUpdate</a></li>
|
<li><a href="./#forceupdate">forceUpdate</a></li>
|
||||||
<li><a href="./#optional-getsnapshotbeforeupdate">getSnapshotBeforeUpdate</a></li>
|
<li><a href="./#getsnapshotbeforeupdate">getSnapshotBeforeUpdate</a></li>
|
||||||
<li><a href="./#onclickoutside">onClickOutside</a></li>
|
<li><a href="./#onclickoutside">onClickOutside</a></li>
|
||||||
<li><a href="./#onescapekey">onEscapeKey</a></li>
|
<li><a href="./#onescapekey">onEscapeKey</a></li>
|
||||||
<li><a href="./#onmousedown">onMouseDown</a></li>
|
<li><a href="./#onmousedown">onMouseDown</a></li>
|
||||||
@ -933,59 +923,55 @@
|
|||||||
<li><a href="./#restorescrollpos">restoreScrollPos</a></li>
|
<li><a href="./#restorescrollpos">restoreScrollPos</a></li>
|
||||||
<li><a href="./#savescrollpos">saveScrollPos</a></li>
|
<li><a href="./#savescrollpos">saveScrollPos</a></li>
|
||||||
<li><a href="./#setstate">setState</a></li>
|
<li><a href="./#setstate">setState</a></li>
|
||||||
<li><a href="./#optional-shouldcomponentupdate">shouldComponentUpdate</a></li>
|
<li><a href="./#shouldcomponentupdate">shouldComponentUpdate</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
<p>+ <strong>new Drawer</strong>(<code>props</code>: Readonly‹<a href="../../interfaces/_renderer_api_index_._renderer_api_components_.drawerprops/">DrawerProps</a>› | <a href="../../interfaces/_renderer_api_index_._renderer_api_components_.drawerprops/">DrawerProps</a>): <em><a href="./">Drawer</a></em></p>
|
<p>• <strong>new Drawer</strong>(<code>props</code>)</p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#constructor">constructor</a></em></p>
|
<h4 id="parameters">Parameters<a class="headerlink" href="#parameters" title="Permanent link">#</a></h4>
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:473</p>
|
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>props</code></td>
|
<td align="left"><code>props</code></td>
|
||||||
<td>Readonly‹<a href="../../interfaces/_renderer_api_index_._renderer_api_components_.drawerprops/">DrawerProps</a>› | <a href="../../interfaces/_renderer_api_index_._renderer_api_components_.drawerprops/">DrawerProps</a></td>
|
<td align="left"><a href="../../interfaces/renderer.component.drawerprops/">DrawerProps</a> | <code>Readonly</code><<a href="../../interfaces/renderer.component.drawerprops/">DrawerProps</a>></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em><a href="./">Drawer</a></em></p>
|
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||||
<p>+ <strong>new Drawer</strong>(<code>props</code>: <a href="../../interfaces/_renderer_api_index_._renderer_api_components_.drawerprops/">DrawerProps</a>, <code>context</code>: any): <em><a href="./">Drawer</a></em></p>
|
<p>React.Component<DrawerProps>.constructor</p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#constructor">constructor</a></em></p>
|
<p>• <strong>new Drawer</strong>(<code>props</code>, <code>context</code>)</p>
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:475</p>
|
<p><strong><code>deprecated</code></strong></p>
|
||||||
<p><strong><code>deprecated</code></strong> </p>
|
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/legacy-context.html</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/docs/legacy-context.html</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>props</code></td>
|
<td align="left"><code>props</code></td>
|
||||||
<td><a href="../../interfaces/_renderer_api_index_._renderer_api_components_.drawerprops/">DrawerProps</a></td>
|
<td align="left"><a href="../../interfaces/renderer.component.drawerprops/">DrawerProps</a></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>context</code></td>
|
<td align="left"><code>context</code></td>
|
||||||
<td>any</td>
|
<td align="left"><code>any</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em><a href="./">Drawer</a></em></p>
|
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component<DrawerProps>.constructor</p>
|
||||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||||
<h3 id="context">context<a class="headerlink" href="#context" title="Permanent link">#</a></h3>
|
<h3 id="context">context<a class="headerlink" href="#context" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>context</strong>: <em>any</em></p>
|
<p>• <strong>context</strong>: <code>any</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#context">context</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:473</p>
|
|
||||||
<p>If using the new style context, re-declare this in your class to be the
|
<p>If using the new style context, re-declare this in your class to be the
|
||||||
<code>React.ContextType</code> of your <code>static contextType</code>.
|
<code>React.ContextType</code> of your <code>static contextType</code>.
|
||||||
Should be used with type annotation or static contextType.</p>
|
Should be used with type annotation or static contextType.</p>
|
||||||
@ -996,32 +982,30 @@ Should be used with type annotation or static contextType.</p>
|
|||||||
<span class="kr">declare</span> <span class="nx">context</span>: <span class="kt">React.ContextType</span><span class="o"><</span><span class="k">typeof</span> <span class="nx">MyContext</span><span class="o">></span>
|
<span class="kr">declare</span> <span class="nx">context</span>: <span class="kt">React.ContextType</span><span class="o"><</span><span class="k">typeof</span> <span class="nx">MyContext</span><span class="o">></span>
|
||||||
</code></pre></div>
|
</code></pre></div>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html</p>
|
||||||
|
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.context</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="props">props<a class="headerlink" href="#props" title="Permanent link">#</a></h3>
|
<h3 id="props">props<a class="headerlink" href="#props" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>props</strong>: <em>Readonly‹<a href="../../interfaces/_renderer_api_index_._renderer_api_components_.drawerprops/">DrawerProps</a>› & Readonly‹object›</em></p>
|
<p>• <code>Readonly</code> <strong>props</strong>: <code>Readonly</code><<a href="../../interfaces/renderer.component.drawerprops/">DrawerProps</a>> & <code>Readonly</code><<code>Object</code>></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#props">props</a></em></p>
|
<h4 id="inherited-from_3">Inherited from<a class="headerlink" href="#inherited-from_3" title="Permanent link">#</a></h4>
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:498</p>
|
<p>React.Component.props</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="refs">refs<a class="headerlink" href="#refs" title="Permanent link">#</a></h3>
|
<h3 id="refs">refs<a class="headerlink" href="#refs" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>refs</strong>: <em>object</em></p>
|
<p>• <strong>refs</strong>: <code>Object</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#refs">refs</a></em></p>
|
<p><strong><code>deprecated</code></strong>
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:504</p>
|
|
||||||
<p><strong><code>deprecated</code></strong>
|
|
||||||
https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||||
<h4 id="type-declaration">Type declaration:<a class="headerlink" href="#type-declaration" title="Permanent link">#</a></h4>
|
<h4 id="index-signature">Index signature<a class="headerlink" href="#index-signature" title="Permanent link">#</a></h4>
|
||||||
<ul>
|
<p>▪ [key: <code>string</code>]: <code>ReactInstance</code></p>
|
||||||
<li>[ <strong>key</strong>: <em>string</em>]: ReactInstance</li>
|
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||||
</ul>
|
<p>React.Component.refs</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="state">state<a class="headerlink" href="#state" title="Permanent link">#</a></h3>
|
<h3 id="state">state<a class="headerlink" href="#state" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>state</strong>: <em>Readonly‹S›</em></p>
|
<p>• <strong>state</strong>: <code>Readonly</code><<code>Object</code>></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#state">state</a></em></p>
|
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:499</p>
|
<p>React.Component.state</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="static-optional-contexttype"><code>Static</code> <code>Optional</code> contextType<a class="headerlink" href="#static-optional-contexttype" title="Permanent link">#</a></h3>
|
<h3 id="contexttype">contextType<a class="headerlink" href="#contexttype" title="Permanent link">#</a></h3>
|
||||||
<p>▪ <strong>contextType</strong>? : <em>Context‹any›</em></p>
|
<p>▪ <code>Static</code> <code>Optional</code> <strong>contextType</strong>: <code>Context</code><any></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#static-optional-contexttype">contextType</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:455</p>
|
|
||||||
<p>If set, <code>this.context</code> will be set at runtime to the current value of the given Context.</p>
|
<p>If set, <code>this.context</code> will be set at runtime to the current value of the given Context.</p>
|
||||||
<p>Usage:</p>
|
<p>Usage:</p>
|
||||||
<div class="highlight"><pre><span></span><code><span class="kd">type</span> <span class="nx">MyContext</span> <span class="o">=</span> <span class="kt">number</span>
|
<div class="highlight"><pre><span></span><code><span class="kd">type</span> <span class="nx">MyContext</span> <span class="o">=</span> <span class="kt">number</span>
|
||||||
@ -1036,15 +1020,14 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
|||||||
<span class="p">}</span>
|
<span class="p">}</span>
|
||||||
</code></pre></div>
|
</code></pre></div>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html#classcontexttype</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||||
|
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.contextType</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="static-defaultprops"><code>Static</code> defaultProps<a class="headerlink" href="#static-defaultprops" title="Permanent link">#</a></h3>
|
<h3 id="defaultprops">defaultProps<a class="headerlink" href="#defaultprops" title="Permanent link">#</a></h3>
|
||||||
<p>▪ <strong>defaultProps</strong>: <em>object</em> = defaultProps as object</p>
|
<p>▪ <code>Static</code> <strong>defaultProps</strong>: <code>object</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/drawer/drawer.tsx#L52">src/renderer/components/drawer/drawer.tsx:52</a></em></p>
|
|
||||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||||
<h3 id="optional-unsafe_componentwillmount"><code>Optional</code> UNSAFE_componentWillMount<a class="headerlink" href="#optional-unsafe_componentwillmount" title="Permanent link">#</a></h3>
|
<h3 id="unsafe_componentwillmount">UNSAFE_componentWillMount<a class="headerlink" href="#unsafe_componentwillmount" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>UNSAFE_componentWillMount</strong>(): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>UNSAFE_componentWillMount</strong>(): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-unsafe_componentwillmount">UNSAFE_componentWillMount</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:711</p>
|
|
||||||
<p>Called immediately before mounting occurs, and before <code>Component#render</code>.
|
<p>Called immediately before mounting occurs, and before <code>Component#render</code>.
|
||||||
Avoid introducing any side-effects or subscriptions in this method.</p>
|
Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||||
<p>This method will not stop working in React 17.</p>
|
<p>This method will not stop working in React 17.</p>
|
||||||
@ -1053,12 +1036,13 @@ prevents this from being invoked.</p>
|
|||||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead</p>
|
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.UNSAFE_componentWillMount</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-unsafe_componentwillreceiveprops"><code>Optional</code> UNSAFE_componentWillReceiveProps<a class="headerlink" href="#optional-unsafe_componentwillreceiveprops" title="Permanent link">#</a></h3>
|
<h3 id="unsafe_componentwillreceiveprops">UNSAFE_componentWillReceiveProps<a class="headerlink" href="#unsafe_componentwillreceiveprops" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>UNSAFE_componentWillReceiveProps</strong>(<code>nextProps</code>: Readonly‹<a href="../../interfaces/_renderer_api_index_._renderer_api_components_.drawerprops/">DrawerProps</a>›, <code>nextContext</code>: any): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>UNSAFE_componentWillReceiveProps</strong>(<code>nextProps</code>, <code>nextContext</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-unsafe_componentwillreceiveprops">UNSAFE_componentWillReceiveProps</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:743</p>
|
|
||||||
<p>Called when the component may be receiving new props.
|
<p>Called when the component may be receiving new props.
|
||||||
React may call this even if props have not changed, so be sure to compare new and existing
|
React may call this even if props have not changed, so be sure to compare new and existing
|
||||||
props if you only want to handle changes.</p>
|
props if you only want to handle changes.</p>
|
||||||
@ -1069,31 +1053,32 @@ prevents this from being invoked.</p>
|
|||||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead</p>
|
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextProps</code></td>
|
<td align="left"><code>nextProps</code></td>
|
||||||
<td>Readonly‹<a href="../../interfaces/_renderer_api_index_._renderer_api_components_.drawerprops/">DrawerProps</a>›</td>
|
<td align="left"><code>Readonly</code><<a href="../../interfaces/renderer.component.drawerprops/">DrawerProps</a>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextContext</code></td>
|
<td align="left"><code>nextContext</code></td>
|
||||||
<td>any</td>
|
<td align="left"><code>any</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.UNSAFE_componentWillReceiveProps</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-unsafe_componentwillupdate"><code>Optional</code> UNSAFE_componentWillUpdate<a class="headerlink" href="#optional-unsafe_componentwillupdate" title="Permanent link">#</a></h3>
|
<h3 id="unsafe_componentwillupdate">UNSAFE_componentWillUpdate<a class="headerlink" href="#unsafe_componentwillupdate" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>UNSAFE_componentWillUpdate</strong>(<code>nextProps</code>: Readonly‹<a href="../../interfaces/_renderer_api_index_._renderer_api_components_.drawerprops/">DrawerProps</a>›, <code>nextState</code>: Readonly‹S›, <code>nextContext</code>: any): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>UNSAFE_componentWillUpdate</strong>(<code>nextProps</code>, <code>nextState</code>, <code>nextContext</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-unsafe_componentwillupdate">UNSAFE_componentWillUpdate</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:771</p>
|
|
||||||
<p>Called immediately before rendering when new props or state is received. Not called for the initial render.</p>
|
<p>Called immediately before rendering when new props or state is received. Not called for the initial render.</p>
|
||||||
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
||||||
<p>This method will not stop working in React 17.</p>
|
<p>This method will not stop working in React 17.</p>
|
||||||
@ -1102,104 +1087,108 @@ prevents this from being invoked.</p>
|
|||||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead</p>
|
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextProps</code></td>
|
<td align="left"><code>nextProps</code></td>
|
||||||
<td>Readonly‹<a href="../../interfaces/_renderer_api_index_._renderer_api_components_.drawerprops/">DrawerProps</a>›</td>
|
<td align="left"><code>Readonly</code><<a href="../../interfaces/renderer.component.drawerprops/">DrawerProps</a>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextState</code></td>
|
<td align="left"><code>nextState</code></td>
|
||||||
<td>Readonly‹S›</td>
|
<td align="left"><code>Readonly</code><<code>Object</code>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextContext</code></td>
|
<td align="left"><code>nextContext</code></td>
|
||||||
<td>any</td>
|
<td align="left"><code>any</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.UNSAFE_componentWillUpdate</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="close">close<a class="headerlink" href="#close" title="Permanent link">#</a></h3>
|
<h3 id="close">close<a class="headerlink" href="#close" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>close</strong>(): <em>void</em></p>
|
<p>▸ <strong>close</strong>(): <code>void</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/drawer/drawer.tsx#L122">src/renderer/components/drawer/drawer.tsx:122</a></em></p>
|
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<p><code>void</code></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-componentdidcatch"><code>Optional</code> componentDidCatch<a class="headerlink" href="#optional-componentdidcatch" title="Permanent link">#</a></h3>
|
<h3 id="componentdidcatch">componentDidCatch<a class="headerlink" href="#componentdidcatch" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>componentDidCatch</strong>(<code>error</code>: Error, <code>errorInfo</code>: ErrorInfo): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>componentDidCatch</strong>(<code>error</code>, <code>errorInfo</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-componentdidcatch">componentDidCatch</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:640</p>
|
|
||||||
<p>Catches exceptions generated in descendant components. Unhandled exceptions will cause
|
<p>Catches exceptions generated in descendant components. Unhandled exceptions will cause
|
||||||
the entire component tree to unmount.</p>
|
the entire component tree to unmount.</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>error</code></td>
|
<td align="left"><code>error</code></td>
|
||||||
<td>Error</td>
|
<td align="left"><code>Error</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>errorInfo</code></td>
|
<td align="left"><code>errorInfo</code></td>
|
||||||
<td>ErrorInfo</td>
|
<td align="left"><code>ErrorInfo</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<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_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.componentDidCatch</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="componentdidmount">componentDidMount<a class="headerlink" href="#componentdidmount" title="Permanent link">#</a></h3>
|
<h3 id="componentdidmount">componentDidMount<a class="headerlink" href="#componentdidmount" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>componentDidMount</strong>(): <em>void</em></p>
|
<p>▸ <strong>componentDidMount</strong>(): <code>void</code></p>
|
||||||
<p><em>Overrides <a href="../_renderer_api_index_._renderer_api_components_.wizardlayout/">WizardLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.wizardlayout/#optional-componentdidmount">componentDidMount</a></em></p>
|
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/drawer/drawer.tsx#L63">src/renderer/components/drawer/drawer.tsx:63</a></em></p>
|
<p><code>void</code></p>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.componentDidMount</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-componentdidupdate"><code>Optional</code> componentDidUpdate<a class="headerlink" href="#optional-componentdidupdate" title="Permanent link">#</a></h3>
|
<h3 id="componentdidupdate">componentDidUpdate<a class="headerlink" href="#componentdidupdate" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>componentDidUpdate</strong>(<code>prevProps</code>: Readonly‹<a href="../../interfaces/_renderer_api_index_._renderer_api_components_.drawerprops/">DrawerProps</a>›, <code>prevState</code>: Readonly‹S›, <code>snapshot?</code>: SS): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>componentDidUpdate</strong>(<code>prevProps</code>, <code>prevState</code>, <code>snapshot?</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-componentdidupdate">componentDidUpdate</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:682</p>
|
|
||||||
<p>Called immediately after updating occurs. Not called for the initial render.</p>
|
<p>Called immediately after updating occurs. Not called for the initial render.</p>
|
||||||
<p>The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.</p>
|
<p>The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>prevProps</code></td>
|
<td align="left"><code>prevProps</code></td>
|
||||||
<td>Readonly‹<a href="../../interfaces/_renderer_api_index_._renderer_api_components_.drawerprops/">DrawerProps</a>›</td>
|
<td align="left"><code>Readonly</code><<a href="../../interfaces/renderer.component.drawerprops/">DrawerProps</a>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>prevState</code></td>
|
<td align="left"><code>prevState</code></td>
|
||||||
<td>Readonly‹S›</td>
|
<td align="left"><code>Readonly</code><<code>Object</code>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>snapshot?</code></td>
|
<td align="left"><code>snapshot?</code></td>
|
||||||
<td>SS</td>
|
<td align="left"><code>any</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.componentDidUpdate</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-componentwillmount"><code>Optional</code> componentWillMount<a class="headerlink" href="#optional-componentwillmount" title="Permanent link">#</a></h3>
|
<h3 id="componentwillmount">componentWillMount<a class="headerlink" href="#componentwillmount" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>componentWillMount</strong>(): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>componentWillMount</strong>(): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-componentwillmount">componentWillMount</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:697</p>
|
|
||||||
<p>Called immediately before mounting occurs, and before <code>Component#render</code>.
|
<p>Called immediately before mounting occurs, and before <code>Component#render</code>.
|
||||||
Avoid introducing any side-effects or subscriptions in this method.</p>
|
Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||||
@ -1207,12 +1196,13 @@ prevents this from being invoked.</p>
|
|||||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.componentWillMount</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-componentwillreceiveprops"><code>Optional</code> componentWillReceiveProps<a class="headerlink" href="#optional-componentwillreceiveprops" title="Permanent link">#</a></h3>
|
<h3 id="componentwillreceiveprops">componentWillReceiveProps<a class="headerlink" href="#componentwillreceiveprops" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>componentWillReceiveProps</strong>(<code>nextProps</code>: Readonly‹<a href="../../interfaces/_renderer_api_index_._renderer_api_components_.drawerprops/">DrawerProps</a>›, <code>nextContext</code>: any): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>componentWillReceiveProps</strong>(<code>nextProps</code>, <code>nextContext</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-componentwillreceiveprops">componentWillReceiveProps</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:726</p>
|
|
||||||
<p>Called when the component may be receiving new props.
|
<p>Called when the component may be receiving new props.
|
||||||
React may call this even if props have not changed, so be sure to compare new and existing
|
React may call this even if props have not changed, so be sure to compare new and existing
|
||||||
props if you only want to handle changes.</p>
|
props if you only want to handle changes.</p>
|
||||||
@ -1222,37 +1212,39 @@ prevents this from being invoked.</p>
|
|||||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextProps</code></td>
|
<td align="left"><code>nextProps</code></td>
|
||||||
<td>Readonly‹<a href="../../interfaces/_renderer_api_index_._renderer_api_components_.drawerprops/">DrawerProps</a>›</td>
|
<td align="left"><code>Readonly</code><<a href="../../interfaces/renderer.component.drawerprops/">DrawerProps</a>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextContext</code></td>
|
<td align="left"><code>nextContext</code></td>
|
||||||
<td>any</td>
|
<td align="left"><code>any</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.componentWillReceiveProps</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="componentwillunmount">componentWillUnmount<a class="headerlink" href="#componentwillunmount" title="Permanent link">#</a></h3>
|
<h3 id="componentwillunmount">componentWillUnmount<a class="headerlink" href="#componentwillunmount" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>componentWillUnmount</strong>(): <em>void</em></p>
|
<p>▸ <strong>componentWillUnmount</strong>(): <code>void</code></p>
|
||||||
<p><em>Overrides <a href="../_renderer_api_index_._renderer_api_components_.wizardlayout/">WizardLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.wizardlayout/#optional-componentwillunmount">componentWillUnmount</a></em></p>
|
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/drawer/drawer.tsx#L70">src/renderer/components/drawer/drawer.tsx:70</a></em></p>
|
<p><code>void</code></p>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.componentWillUnmount</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-componentwillupdate"><code>Optional</code> componentWillUpdate<a class="headerlink" href="#optional-componentwillupdate" title="Permanent link">#</a></h3>
|
<h3 id="componentwillupdate">componentWillUpdate<a class="headerlink" href="#componentwillupdate" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>componentWillUpdate</strong>(<code>nextProps</code>: Readonly‹<a href="../../interfaces/_renderer_api_index_._renderer_api_components_.drawerprops/">DrawerProps</a>›, <code>nextState</code>: Readonly‹S›, <code>nextContext</code>: any): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>componentWillUpdate</strong>(<code>nextProps</code>, <code>nextState</code>, <code>nextContext</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-componentwillupdate">componentWillUpdate</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:756</p>
|
|
||||||
<p>Called immediately before rendering when new props or state is received. Not called for the initial render.</p>
|
<p>Called immediately before rendering when new props or state is received. Not called for the initial render.</p>
|
||||||
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
||||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||||
@ -1260,192 +1252,240 @@ prevents this from being invoked.</p>
|
|||||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextProps</code></td>
|
<td align="left"><code>nextProps</code></td>
|
||||||
<td>Readonly‹<a href="../../interfaces/_renderer_api_index_._renderer_api_components_.drawerprops/">DrawerProps</a>›</td>
|
<td align="left"><code>Readonly</code><<a href="../../interfaces/renderer.component.drawerprops/">DrawerProps</a>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextState</code></td>
|
<td align="left"><code>nextState</code></td>
|
||||||
<td>Readonly‹S›</td>
|
<td align="left"><code>Readonly</code><<code>Object</code>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextContext</code></td>
|
<td align="left"><code>nextContext</code></td>
|
||||||
<td>any</td>
|
<td align="left"><code>any</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.componentWillUpdate</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="forceupdate">forceUpdate<a class="headerlink" href="#forceupdate" title="Permanent link">#</a></h3>
|
<h3 id="forceupdate">forceUpdate<a class="headerlink" href="#forceupdate" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>forceUpdate</strong>(<code>callback?</code>: function): <em>void</em></p>
|
<p>▸ <strong>forceUpdate</strong>(<code>callback?</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#forceupdate">forceUpdate</a></em></p>
|
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:490</p>
|
<table>
|
||||||
<p><strong>Parameters:</strong></p>
|
<thead>
|
||||||
<p>▪<code>Optional</code> <strong>callback</strong>: <em>function</em></p>
|
<tr>
|
||||||
<p>▸ (): <em>void</em></p>
|
<th align="left">Name</th>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<th align="left">Type</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>callback?</code></td>
|
||||||
|
<td align="left">() => <code>void</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.forceUpdate</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-getsnapshotbeforeupdate"><code>Optional</code> getSnapshotBeforeUpdate<a class="headerlink" href="#optional-getsnapshotbeforeupdate" title="Permanent link">#</a></h3>
|
<h3 id="getsnapshotbeforeupdate">getSnapshotBeforeUpdate<a class="headerlink" href="#getsnapshotbeforeupdate" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>getSnapshotBeforeUpdate</strong>(<code>prevProps</code>: Readonly‹<a href="../../interfaces/_renderer_api_index_._renderer_api_components_.drawerprops/">DrawerProps</a>›, <code>prevState</code>: Readonly‹S›): <em>SS | null</em></p>
|
<p>▸ <code>Optional</code> <strong>getSnapshotBeforeUpdate</strong>(<code>prevProps</code>, <code>prevState</code>): <code>any</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-getsnapshotbeforeupdate">getSnapshotBeforeUpdate</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:676</p>
|
|
||||||
<p>Runs before React applies the result of <code>render</code> to the document, and
|
<p>Runs before React applies the result of <code>render</code> to the document, and
|
||||||
returns an object to be given to componentDidUpdate. Useful for saving
|
returns an object to be given to componentDidUpdate. Useful for saving
|
||||||
things such as scroll position before <code>render</code> causes changes to it.</p>
|
things such as scroll position before <code>render</code> causes changes to it.</p>
|
||||||
<p>Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated
|
<p>Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated
|
||||||
lifecycle events from running.</p>
|
lifecycle events from running.</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>prevProps</code></td>
|
<td align="left"><code>prevProps</code></td>
|
||||||
<td>Readonly‹<a href="../../interfaces/_renderer_api_index_._renderer_api_components_.drawerprops/">DrawerProps</a>›</td>
|
<td align="left"><code>Readonly</code><<a href="../../interfaces/renderer.component.drawerprops/">DrawerProps</a>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>prevState</code></td>
|
<td align="left"><code>prevState</code></td>
|
||||||
<td>Readonly‹S›</td>
|
<td align="left"><code>Readonly</code><<code>Object</code>></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>SS | null</em></p>
|
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>any</code></p>
|
||||||
|
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.getSnapshotBeforeUpdate</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="onclickoutside">onClickOutside<a class="headerlink" href="#onclickoutside" title="Permanent link">#</a></h3>
|
<h3 id="onclickoutside">onClickOutside<a class="headerlink" href="#onclickoutside" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>onClickOutside</strong>(<code>evt</code>: MouseEvent): <em>void</em></p>
|
<p>▸ <strong>onClickOutside</strong>(<code>evt</code>): <code>void</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/drawer/drawer.tsx#L101">src/renderer/components/drawer/drawer.tsx:101</a></em></p>
|
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>evt</code></td>
|
<td align="left"><code>evt</code></td>
|
||||||
<td>MouseEvent</td>
|
<td align="left"><code>MouseEvent</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="onescapekey">onEscapeKey<a class="headerlink" href="#onescapekey" title="Permanent link">#</a></h3>
|
<h3 id="onescapekey">onEscapeKey<a class="headerlink" href="#onescapekey" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>onEscapeKey</strong>(<code>evt</code>: KeyboardEvent): <em>void</em></p>
|
<p>▸ <strong>onEscapeKey</strong>(<code>evt</code>): <code>void</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/drawer/drawer.tsx#L91">src/renderer/components/drawer/drawer.tsx:91</a></em></p>
|
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>evt</code></td>
|
<td align="left"><code>evt</code></td>
|
||||||
<td>KeyboardEvent</td>
|
<td align="left"><code>KeyboardEvent</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="onmousedown">onMouseDown<a class="headerlink" href="#onmousedown" title="Permanent link">#</a></h3>
|
<h3 id="onmousedown">onMouseDown<a class="headerlink" href="#onmousedown" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>onMouseDown</strong>(<code>evt</code>: MouseEvent): <em>void</em></p>
|
<p>▸ <strong>onMouseDown</strong>(<code>evt</code>): <code>void</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/drawer/drawer.tsx#L116">src/renderer/components/drawer/drawer.tsx:116</a></em></p>
|
<h4 id="parameters_12">Parameters<a class="headerlink" href="#parameters_12" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>evt</code></td>
|
<td align="left"><code>evt</code></td>
|
||||||
<td>MouseEvent</td>
|
<td align="left"><code>MouseEvent</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="render">render<a class="headerlink" href="#render" title="Permanent link">#</a></h3>
|
<h3 id="render">render<a class="headerlink" href="#render" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>render</strong>(): <em>Element‹›</em></p>
|
<p>▸ <strong>render</strong>(): <code>Element</code></p>
|
||||||
<p><em>Overrides void</em></p>
|
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/drawer/drawer.tsx#L128">src/renderer/components/drawer/drawer.tsx:128</a></em></p>
|
<p><code>Element</code></p>
|
||||||
<p><strong>Returns:</strong> <em>Element‹›</em></p>
|
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.render</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="restorescrollpos">restoreScrollPos<a class="headerlink" href="#restorescrollpos" title="Permanent link">#</a></h3>
|
<h3 id="restorescrollpos">restoreScrollPos<a class="headerlink" href="#restorescrollpos" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>restoreScrollPos</strong>(): <em>void</em></p>
|
<p>▸ <strong>restoreScrollPos</strong>(): <code>void</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/drawer/drawer.tsx#L84">src/renderer/components/drawer/drawer.tsx:84</a></em></p>
|
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<p><code>void</code></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="savescrollpos">saveScrollPos<a class="headerlink" href="#savescrollpos" title="Permanent link">#</a></h3>
|
<h3 id="savescrollpos">saveScrollPos<a class="headerlink" href="#savescrollpos" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>saveScrollPos</strong>(): <em>void</em></p>
|
<p>▸ <strong>saveScrollPos</strong>(): <code>void</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/drawer/drawer.tsx#L77">src/renderer/components/drawer/drawer.tsx:77</a></em></p>
|
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<p><code>void</code></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="setstate">setState<a class="headerlink" href="#setstate" title="Permanent link">#</a></h3>
|
<h3 id="setstate">setState<a class="headerlink" href="#setstate" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>setState</strong>‹<strong>K</strong>›(<code>state</code>: function | S | object, <code>callback?</code>: function): <em>void</em></p>
|
<p>▸ <strong>setState</strong><K>(<code>state</code>, <code>callback?</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#setstate">setState</a></em></p>
|
<h4 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h4>
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:485</p>
|
<table>
|
||||||
<p><strong>Type parameters:</strong></p>
|
<thead>
|
||||||
<p>▪ <strong>K</strong>: <em>keyof S</em></p>
|
<tr>
|
||||||
<p><strong>Parameters:</strong></p>
|
<th align="left">Name</th>
|
||||||
<p>▪ <strong>state</strong>: <em>function | S | object</em></p>
|
<th align="left">Type</th>
|
||||||
<p>▪<code>Optional</code> <strong>callback</strong>: <em>function</em></p>
|
</tr>
|
||||||
<p>▸ (): <em>void</em></p>
|
</thead>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>K</code></td>
|
||||||
|
<td align="left"><code>K</code>: <code>never</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" 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>state</code></td>
|
||||||
|
<td align="left">{} | (<code>prevState</code>: <code>Readonly</code><<code>Object</code>>, <code>props</code>: <code>Readonly</code><<a href="../../interfaces/renderer.component.drawerprops/">DrawerProps</a>>) => {} | <code>Pick</code><<code>Object</code>, K> | <code>Pick</code><<code>Object</code>, K></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>callback?</code></td>
|
||||||
|
<td align="left">() => <code>void</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.setState</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-shouldcomponentupdate"><code>Optional</code> shouldComponentUpdate<a class="headerlink" href="#optional-shouldcomponentupdate" title="Permanent link">#</a></h3>
|
<h3 id="shouldcomponentupdate">shouldComponentUpdate<a class="headerlink" href="#shouldcomponentupdate" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>shouldComponentUpdate</strong>(<code>nextProps</code>: Readonly‹<a href="../../interfaces/_renderer_api_index_._renderer_api_components_.drawerprops/">DrawerProps</a>›, <code>nextState</code>: Readonly‹S›, <code>nextContext</code>: any): <em>boolean</em></p>
|
<p>▸ <code>Optional</code> <strong>shouldComponentUpdate</strong>(<code>nextProps</code>, <code>nextState</code>, <code>nextContext</code>): <code>boolean</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-shouldcomponentupdate">shouldComponentUpdate</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:630</p>
|
|
||||||
<p>Called to determine whether the change in props and state should trigger a re-render.</p>
|
<p>Called to determine whether the change in props and state should trigger a re-render.</p>
|
||||||
<p><code>Component</code> always returns true.
|
<p><code>Component</code> always returns true.
|
||||||
<code>PureComponent</code> implements a shallow comparison on props and state and returns true if any
|
<code>PureComponent</code> implements a shallow comparison on props and state and returns true if any
|
||||||
props or states have changed.</p>
|
props or states have changed.</p>
|
||||||
<p>If false is returned, <code>Component#render</code>, <code>componentWillUpdate</code>
|
<p>If false is returned, <code>Component#render</code>, <code>componentWillUpdate</code>
|
||||||
and <code>componentDidUpdate</code> will not be called.</p>
|
and <code>componentDidUpdate</code> will not be called.</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextProps</code></td>
|
<td align="left"><code>nextProps</code></td>
|
||||||
<td>Readonly‹<a href="../../interfaces/_renderer_api_index_._renderer_api_components_.drawerprops/">DrawerProps</a>›</td>
|
<td align="left"><code>Readonly</code><<a href="../../interfaces/renderer.component.drawerprops/">DrawerProps</a>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextState</code></td>
|
<td align="left"><code>nextState</code></td>
|
||||||
<td>Readonly‹S›</td>
|
<td align="left"><code>Readonly</code><<code>Object</code>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextContext</code></td>
|
<td align="left"><code>nextContext</code></td>
|
||||||
<td>any</td>
|
<td align="left"><code>any</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>boolean</em></p>
|
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>boolean</code></p>
|
||||||
|
<h4 id="inherited-from_18">Inherited from<a class="headerlink" href="#inherited-from_18" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.shouldComponentUpdate</p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
1537
master/extensions/api/classes/renderer.component.icon/index.html
Normal file
1537
master/extensions/api/classes/renderer.component.icon/index.html
Normal file
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -9,7 +9,7 @@
|
|||||||
<meta name="description" content="Documentation for Lens Extension API.">
|
<meta name="description" content="Documentation for Lens Extension API.">
|
||||||
|
|
||||||
|
|
||||||
<link rel="canonical" href="https://api-docs.k8slens.dev/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.kubeobjectdetails/">
|
<link rel="canonical" href="https://api-docs.k8slens.dev/master/extensions/api/classes/renderer.component.kubeobjectdetails/">
|
||||||
|
|
||||||
|
|
||||||
<meta name="author" content="Mirantis, Inc.">
|
<meta name="author" content="Mirantis, Inc.">
|
||||||
@ -19,7 +19,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<title>Class: KubeObjectDetails ‹**P, S, SS, P, S**› - Lens Extension API</title>
|
<title>Class: KubeObjectDetails - Lens Extension API</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -72,7 +72,7 @@
|
|||||||
<div data-md-component="skip">
|
<div data-md-component="skip">
|
||||||
|
|
||||||
|
|
||||||
<a href="#class-kubeobjectdetails-p-s-ss-p-s" class="md-skip">
|
<a href="#class-kubeobjectdetails" class="md-skip">
|
||||||
Skip to content
|
Skip to content
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
@ -103,7 +103,7 @@
|
|||||||
<div class="md-header-nav__topic">
|
<div class="md-header-nav__topic">
|
||||||
<span class="md-ellipsis">
|
<span class="md-ellipsis">
|
||||||
|
|
||||||
Class: KubeObjectDetails ‹**P, S, SS, P, S**›
|
Class: KubeObjectDetails
|
||||||
|
|
||||||
</span>
|
</span>
|
||||||
</div>
|
</div>
|
||||||
@ -590,13 +590,6 @@
|
|||||||
</label>
|
</label>
|
||||||
<ul class="md-nav__list" data-md-scrollfix>
|
<ul class="md-nav__list" 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">
|
<li class="md-nav__item">
|
||||||
<a href="#hierarchy" class="md-nav__link">
|
<a href="#hierarchy" class="md-nav__link">
|
||||||
Hierarchy
|
Hierarchy
|
||||||
@ -605,11 +598,11 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#index" class="md-nav__link">
|
<a href="#table-of-contents" class="md-nav__link">
|
||||||
Index
|
Table of contents
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
<nav class="md-nav" aria-label="Index">
|
<nav class="md-nav" aria-label="Table of contents">
|
||||||
<ul class="md-nav__list">
|
<ul class="md-nav__list">
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -723,8 +716,8 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#static-optional-contexttype" class="md-nav__link">
|
<a href="#contexttype" class="md-nav__link">
|
||||||
Static Optional contextType
|
contextType
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -777,71 +770,71 @@
|
|||||||
<ul class="md-nav__list">
|
<ul class="md-nav__list">
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-unsafe_componentwillmount" class="md-nav__link">
|
<a href="#unsafe_componentwillmount" class="md-nav__link">
|
||||||
Optional UNSAFE_componentWillMount
|
UNSAFE_componentWillMount
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-unsafe_componentwillreceiveprops" class="md-nav__link">
|
<a href="#unsafe_componentwillreceiveprops" class="md-nav__link">
|
||||||
Optional UNSAFE_componentWillReceiveProps
|
UNSAFE_componentWillReceiveProps
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-unsafe_componentwillupdate" class="md-nav__link">
|
<a href="#unsafe_componentwillupdate" class="md-nav__link">
|
||||||
Optional UNSAFE_componentWillUpdate
|
UNSAFE_componentWillUpdate
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-componentdidcatch" class="md-nav__link">
|
<a href="#componentdidcatch" class="md-nav__link">
|
||||||
Optional componentDidCatch
|
componentDidCatch
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-componentdidmount" class="md-nav__link">
|
<a href="#componentdidmount" class="md-nav__link">
|
||||||
Optional componentDidMount
|
componentDidMount
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-componentdidupdate" class="md-nav__link">
|
<a href="#componentdidupdate" class="md-nav__link">
|
||||||
Optional componentDidUpdate
|
componentDidUpdate
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-componentwillmount" class="md-nav__link">
|
<a href="#componentwillmount" class="md-nav__link">
|
||||||
Optional componentWillMount
|
componentWillMount
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-componentwillreceiveprops" class="md-nav__link">
|
<a href="#componentwillreceiveprops" class="md-nav__link">
|
||||||
Optional componentWillReceiveProps
|
componentWillReceiveProps
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-componentwillunmount" class="md-nav__link">
|
<a href="#componentwillunmount" class="md-nav__link">
|
||||||
Optional componentWillUnmount
|
componentWillUnmount
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-componentwillupdate" class="md-nav__link">
|
<a href="#componentwillupdate" class="md-nav__link">
|
||||||
Optional componentWillUpdate
|
componentWillUpdate
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -854,8 +847,8 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-getsnapshotbeforeupdate" class="md-nav__link">
|
<a href="#getsnapshotbeforeupdate" class="md-nav__link">
|
||||||
Optional getSnapshotBeforeUpdate
|
getSnapshotBeforeUpdate
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -875,8 +868,8 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-shouldcomponentupdate" class="md-nav__link">
|
<a href="#shouldcomponentupdate" class="md-nav__link">
|
||||||
Optional shouldComponentUpdate
|
shouldComponentUpdate
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -900,19 +893,14 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<h1 id="class-kubeobjectdetails-p-s-ss-p-s">Class: KubeObjectDetails ‹<strong>P, S, SS, P, S</strong>›<a class="headerlink" href="#class-kubeobjectdetails-p-s-ss-p-s" title="Permanent link">#</a></h1>
|
<h1 id="class-kubeobjectdetails">Class: KubeObjectDetails<a class="headerlink" href="#class-kubeobjectdetails" title="Permanent link">#</a></h1>
|
||||||
<h2 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h2>
|
<p><a href="../../modules/renderer/">Renderer</a>.<a href="../../modules/renderer.component/">Component</a>.KubeObjectDetails</p>
|
||||||
<p>▪ <strong>P</strong></p>
|
|
||||||
<p>▪ <strong>S</strong></p>
|
|
||||||
<p>▪ <strong>SS</strong></p>
|
|
||||||
<p>▪ <strong>P</strong></p>
|
|
||||||
<p>▪ <strong>S</strong></p>
|
|
||||||
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
|
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
|
||||||
<ul>
|
<ul>
|
||||||
<li>Component</li>
|
<li><code>Component</code></li>
|
||||||
</ul>
|
</ul>
|
||||||
<p>↳ <strong>KubeObjectDetails</strong></p>
|
<p>↳ <strong>KubeObjectDetails</strong></p>
|
||||||
<h2 id="index">Index<a class="headerlink" href="#index" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructors">Constructors<a class="headerlink" href="#constructors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="./#constructor">constructor</a></li>
|
<li><a href="./#constructor">constructor</a></li>
|
||||||
@ -926,7 +914,7 @@
|
|||||||
<li><a href="./#props">props</a></li>
|
<li><a href="./#props">props</a></li>
|
||||||
<li><a href="./#refs">refs</a></li>
|
<li><a href="./#refs">refs</a></li>
|
||||||
<li><a href="./#state">state</a></li>
|
<li><a href="./#state">state</a></li>
|
||||||
<li><a href="./#static-optional-contexttype">contextType</a></li>
|
<li><a href="./#contexttype">contextType</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
@ -936,48 +924,45 @@
|
|||||||
</ul>
|
</ul>
|
||||||
<h3 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">#</a></h3>
|
<h3 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="./#optional-unsafe_componentwillmount">UNSAFE_componentWillMount</a></li>
|
<li><a href="./#unsafe_componentwillmount">UNSAFE_componentWillMount</a></li>
|
||||||
<li><a href="./#optional-unsafe_componentwillreceiveprops">UNSAFE_componentWillReceiveProps</a></li>
|
<li><a href="./#unsafe_componentwillreceiveprops">UNSAFE_componentWillReceiveProps</a></li>
|
||||||
<li><a href="./#optional-unsafe_componentwillupdate">UNSAFE_componentWillUpdate</a></li>
|
<li><a href="./#unsafe_componentwillupdate">UNSAFE_componentWillUpdate</a></li>
|
||||||
<li><a href="./#optional-componentdidcatch">componentDidCatch</a></li>
|
<li><a href="./#componentdidcatch">componentDidCatch</a></li>
|
||||||
<li><a href="./#optional-componentdidmount">componentDidMount</a></li>
|
<li><a href="./#componentdidmount">componentDidMount</a></li>
|
||||||
<li><a href="./#optional-componentdidupdate">componentDidUpdate</a></li>
|
<li><a href="./#componentdidupdate">componentDidUpdate</a></li>
|
||||||
<li><a href="./#optional-componentwillmount">componentWillMount</a></li>
|
<li><a href="./#componentwillmount">componentWillMount</a></li>
|
||||||
<li><a href="./#optional-componentwillreceiveprops">componentWillReceiveProps</a></li>
|
<li><a href="./#componentwillreceiveprops">componentWillReceiveProps</a></li>
|
||||||
<li><a href="./#optional-componentwillunmount">componentWillUnmount</a></li>
|
<li><a href="./#componentwillunmount">componentWillUnmount</a></li>
|
||||||
<li><a href="./#optional-componentwillupdate">componentWillUpdate</a></li>
|
<li><a href="./#componentwillupdate">componentWillUpdate</a></li>
|
||||||
<li><a href="./#forceupdate">forceUpdate</a></li>
|
<li><a href="./#forceupdate">forceUpdate</a></li>
|
||||||
<li><a href="./#optional-getsnapshotbeforeupdate">getSnapshotBeforeUpdate</a></li>
|
<li><a href="./#getsnapshotbeforeupdate">getSnapshotBeforeUpdate</a></li>
|
||||||
<li><a href="./#render">render</a></li>
|
<li><a href="./#render">render</a></li>
|
||||||
<li><a href="./#setstate">setState</a></li>
|
<li><a href="./#setstate">setState</a></li>
|
||||||
<li><a href="./#optional-shouldcomponentupdate">shouldComponentUpdate</a></li>
|
<li><a href="./#shouldcomponentupdate">shouldComponentUpdate</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
<p>+ <strong>new KubeObjectDetails</strong>(<code>props</code>: object): <em><a href="./">KubeObjectDetails</a></em></p>
|
<p>• <strong>new KubeObjectDetails</strong>(<code>props</code>)</p>
|
||||||
<p><em>Overrides <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#constructor">constructor</a></em></p>
|
<h4 id="parameters">Parameters<a class="headerlink" href="#parameters" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/kube-object/kube-object-details.tsx#L90">src/renderer/components/kube-object/kube-object-details.tsx:90</a></em></p>
|
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>props</code></td>
|
<td align="left"><code>props</code></td>
|
||||||
<td>object</td>
|
<td align="left"><code>Object</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em><a href="./">KubeObjectDetails</a></em></p>
|
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.constructor</p>
|
||||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||||
<h3 id="context">context<a class="headerlink" href="#context" title="Permanent link">#</a></h3>
|
<h3 id="context">context<a class="headerlink" href="#context" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>context</strong>: <em>any</em></p>
|
<p>• <strong>context</strong>: <code>any</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#context">context</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:473</p>
|
|
||||||
<p>If using the new style context, re-declare this in your class to be the
|
<p>If using the new style context, re-declare this in your class to be the
|
||||||
<code>React.ContextType</code> of your <code>static contextType</code>.
|
<code>React.ContextType</code> of your <code>static contextType</code>.
|
||||||
Should be used with type annotation or static contextType.</p>
|
Should be used with type annotation or static contextType.</p>
|
||||||
@ -988,67 +973,39 @@ Should be used with type annotation or static contextType.</p>
|
|||||||
<span class="kr">declare</span> <span class="nx">context</span>: <span class="kt">React.ContextType</span><span class="o"><</span><span class="k">typeof</span> <span class="nx">MyContext</span><span class="o">></span>
|
<span class="kr">declare</span> <span class="nx">context</span>: <span class="kt">React.ContextType</span><span class="o"><</span><span class="k">typeof</span> <span class="nx">MyContext</span><span class="o">></span>
|
||||||
</code></pre></div>
|
</code></pre></div>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html</p>
|
||||||
|
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.context</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isloading">isLoading<a class="headerlink" href="#isloading" title="Permanent link">#</a></h3>
|
<h3 id="isloading">isLoading<a class="headerlink" href="#isloading" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>isLoading</strong>: <em>boolean</em> = false</p>
|
<p>• <strong>isLoading</strong>: <code>boolean</code> = false</p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/kube-object/kube-object-details.tsx#L89">src/renderer/components/kube-object/kube-object-details.tsx:89</a></em></p>
|
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="loader">loader<a class="headerlink" href="#loader" title="Permanent link">#</a></h3>
|
<h3 id="loader">loader<a class="headerlink" href="#loader" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>loader</strong>: <em>IReactionDisposer</em> = reaction(() => [
|
<p>• <strong>loader</strong>: <code>IReactionDisposer</code></p>
|
||||||
this.path,
|
|
||||||
this.object, // resource might be updated via watch-event or from already opened details
|
|
||||||
crdStore.items.length, // crd stores initialized after loading
|
|
||||||
], async () => {
|
|
||||||
this.loadingError = "";
|
|
||||||
const { path, object } = this;</p>
|
|
||||||
<div class="highlight"><pre><span></span><code>if (!object) {
|
|
||||||
const store = apiManager.getStore(path);
|
|
||||||
|
|
||||||
if (store) {
|
|
||||||
this.isLoading = true;
|
|
||||||
|
|
||||||
try {
|
|
||||||
await store.loadFromPath(path);
|
|
||||||
} catch (err) {
|
|
||||||
this.loadingError = <>Resource loading has failed: <b>{err.toString()}</b>;
|
|
||||||
} finally {
|
|
||||||
this.isLoading = false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
</code></pre></div>
|
|
||||||
<p>})</p>
|
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/kube-object/kube-object-details.tsx#L114">src/renderer/components/kube-object/kube-object-details.tsx:114</a></em></p>
|
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="loadingerror">loadingError<a class="headerlink" href="#loadingerror" title="Permanent link">#</a></h3>
|
<h3 id="loadingerror">loadingError<a class="headerlink" href="#loadingerror" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>loadingError</strong>: <em>React.ReactNode</em></p>
|
<p>• <strong>loadingError</strong>: <code>ReactNode</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/kube-object/kube-object-details.tsx#L90">src/renderer/components/kube-object/kube-object-details.tsx:90</a></em></p>
|
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="props">props<a class="headerlink" href="#props" title="Permanent link">#</a></h3>
|
<h3 id="props">props<a class="headerlink" href="#props" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>props</strong>: <em>Readonly‹P› & Readonly‹object›</em></p>
|
<p>• <code>Readonly</code> <strong>props</strong>: <code>Readonly</code><<code>Object</code>> & <code>Readonly</code><<code>Object</code>></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#props">props</a></em></p>
|
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:498</p>
|
<p>React.Component.props</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="refs">refs<a class="headerlink" href="#refs" title="Permanent link">#</a></h3>
|
<h3 id="refs">refs<a class="headerlink" href="#refs" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>refs</strong>: <em>object</em></p>
|
<p>• <strong>refs</strong>: <code>Object</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#refs">refs</a></em></p>
|
<p><strong><code>deprecated</code></strong>
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:504</p>
|
|
||||||
<p><strong><code>deprecated</code></strong>
|
|
||||||
https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||||
<h4 id="type-declaration">Type declaration:<a class="headerlink" href="#type-declaration" title="Permanent link">#</a></h4>
|
<h4 id="index-signature">Index signature<a class="headerlink" href="#index-signature" title="Permanent link">#</a></h4>
|
||||||
<ul>
|
<p>▪ [key: <code>string</code>]: <code>ReactInstance</code></p>
|
||||||
<li>[ <strong>key</strong>: <em>string</em>]: ReactInstance</li>
|
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||||
</ul>
|
<p>React.Component.refs</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="state">state<a class="headerlink" href="#state" title="Permanent link">#</a></h3>
|
<h3 id="state">state<a class="headerlink" href="#state" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>state</strong>: <em>Readonly‹S›</em></p>
|
<p>• <strong>state</strong>: <code>Readonly</code><<code>Object</code>></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#state">state</a></em></p>
|
<h4 id="inherited-from_3">Inherited from<a class="headerlink" href="#inherited-from_3" title="Permanent link">#</a></h4>
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:499</p>
|
<p>React.Component.state</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="static-optional-contexttype"><code>Static</code> <code>Optional</code> contextType<a class="headerlink" href="#static-optional-contexttype" title="Permanent link">#</a></h3>
|
<h3 id="contexttype">contextType<a class="headerlink" href="#contexttype" title="Permanent link">#</a></h3>
|
||||||
<p>▪ <strong>contextType</strong>? : <em>Context‹any›</em></p>
|
<p>▪ <code>Static</code> <code>Optional</code> <strong>contextType</strong>: <code>Context</code><any></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#static-optional-contexttype">contextType</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:455</p>
|
|
||||||
<p>If set, <code>this.context</code> will be set at runtime to the current value of the given Context.</p>
|
<p>If set, <code>this.context</code> will be set at runtime to the current value of the given Context.</p>
|
||||||
<p>Usage:</p>
|
<p>Usage:</p>
|
||||||
<div class="highlight"><pre><span></span><code><span class="kd">type</span> <span class="nx">MyContext</span> <span class="o">=</span> <span class="kt">number</span>
|
<div class="highlight"><pre><span></span><code><span class="kd">type</span> <span class="nx">MyContext</span> <span class="o">=</span> <span class="kt">number</span>
|
||||||
@ -1063,26 +1020,26 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
|||||||
<span class="p">}</span>
|
<span class="p">}</span>
|
||||||
</code></pre></div>
|
</code></pre></div>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html#classcontexttype</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||||
|
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.contextType</p>
|
||||||
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
||||||
<h3 id="iscrdinstance">isCrdInstance<a class="headerlink" href="#iscrdinstance" title="Permanent link">#</a></h3>
|
<h3 id="iscrdinstance">isCrdInstance<a class="headerlink" href="#iscrdinstance" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>get isCrdInstance</strong>(): <em>boolean</em></p>
|
<p>• <code>get</code> <strong>isCrdInstance</strong>(): <code>boolean</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/kube-object/kube-object-details.tsx#L109">src/renderer/components/kube-object/kube-object-details.tsx:109</a></em></p>
|
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Returns:</strong> <em>boolean</em></p>
|
<p><code>boolean</code></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="object">object<a class="headerlink" href="#object" title="Permanent link">#</a></h3>
|
<h3 id="object">object<a class="headerlink" href="#object" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>get object</strong>(): <em>any</em></p>
|
<p>• <code>get</code> <strong>object</strong>(): <code>any</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/kube-object/kube-object-details.tsx#L101">src/renderer/components/kube-object/kube-object-details.tsx:101</a></em></p>
|
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Returns:</strong> <em>any</em></p>
|
<p><code>any</code></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="path">path<a class="headerlink" href="#path" title="Permanent link">#</a></h3>
|
<h3 id="path">path<a class="headerlink" href="#path" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>get path</strong>(): <em>string</em></p>
|
<p>• <code>get</code> <strong>path</strong>(): <code>string</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/kube-object/kube-object-details.tsx#L97">src/renderer/components/kube-object/kube-object-details.tsx:97</a></em></p>
|
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Returns:</strong> <em>string</em></p>
|
<p><code>string</code></p>
|
||||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||||
<h3 id="optional-unsafe_componentwillmount"><code>Optional</code> UNSAFE_componentWillMount<a class="headerlink" href="#optional-unsafe_componentwillmount" title="Permanent link">#</a></h3>
|
<h3 id="unsafe_componentwillmount">UNSAFE_componentWillMount<a class="headerlink" href="#unsafe_componentwillmount" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>UNSAFE_componentWillMount</strong>(): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>UNSAFE_componentWillMount</strong>(): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-unsafe_componentwillmount">UNSAFE_componentWillMount</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:711</p>
|
|
||||||
<p>Called immediately before mounting occurs, and before <code>Component#render</code>.
|
<p>Called immediately before mounting occurs, and before <code>Component#render</code>.
|
||||||
Avoid introducing any side-effects or subscriptions in this method.</p>
|
Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||||
<p>This method will not stop working in React 17.</p>
|
<p>This method will not stop working in React 17.</p>
|
||||||
@ -1091,12 +1048,13 @@ prevents this from being invoked.</p>
|
|||||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead</p>
|
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.UNSAFE_componentWillMount</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-unsafe_componentwillreceiveprops"><code>Optional</code> UNSAFE_componentWillReceiveProps<a class="headerlink" href="#optional-unsafe_componentwillreceiveprops" title="Permanent link">#</a></h3>
|
<h3 id="unsafe_componentwillreceiveprops">UNSAFE_componentWillReceiveProps<a class="headerlink" href="#unsafe_componentwillreceiveprops" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>UNSAFE_componentWillReceiveProps</strong>(<code>nextProps</code>: Readonly‹P›, <code>nextContext</code>: any): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>UNSAFE_componentWillReceiveProps</strong>(<code>nextProps</code>, <code>nextContext</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-unsafe_componentwillreceiveprops">UNSAFE_componentWillReceiveProps</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:743</p>
|
|
||||||
<p>Called when the component may be receiving new props.
|
<p>Called when the component may be receiving new props.
|
||||||
React may call this even if props have not changed, so be sure to compare new and existing
|
React may call this even if props have not changed, so be sure to compare new and existing
|
||||||
props if you only want to handle changes.</p>
|
props if you only want to handle changes.</p>
|
||||||
@ -1107,31 +1065,32 @@ prevents this from being invoked.</p>
|
|||||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead</p>
|
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextProps</code></td>
|
<td align="left"><code>nextProps</code></td>
|
||||||
<td>Readonly‹P›</td>
|
<td align="left"><code>Readonly</code><<code>Object</code>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextContext</code></td>
|
<td align="left"><code>nextContext</code></td>
|
||||||
<td>any</td>
|
<td align="left"><code>any</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<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_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.UNSAFE_componentWillReceiveProps</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-unsafe_componentwillupdate"><code>Optional</code> UNSAFE_componentWillUpdate<a class="headerlink" href="#optional-unsafe_componentwillupdate" title="Permanent link">#</a></h3>
|
<h3 id="unsafe_componentwillupdate">UNSAFE_componentWillUpdate<a class="headerlink" href="#unsafe_componentwillupdate" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>UNSAFE_componentWillUpdate</strong>(<code>nextProps</code>: Readonly‹P›, <code>nextState</code>: Readonly‹S›, <code>nextContext</code>: any): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>UNSAFE_componentWillUpdate</strong>(<code>nextProps</code>, <code>nextState</code>, <code>nextContext</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-unsafe_componentwillupdate">UNSAFE_componentWillUpdate</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:771</p>
|
|
||||||
<p>Called immediately before rendering when new props or state is received. Not called for the initial render.</p>
|
<p>Called immediately before rendering when new props or state is received. Not called for the initial render.</p>
|
||||||
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
||||||
<p>This method will not stop working in React 17.</p>
|
<p>This method will not stop working in React 17.</p>
|
||||||
@ -1140,100 +1099,104 @@ prevents this from being invoked.</p>
|
|||||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead</p>
|
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextProps</code></td>
|
<td align="left"><code>nextProps</code></td>
|
||||||
<td>Readonly‹P›</td>
|
<td align="left"><code>Readonly</code><<code>Object</code>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextState</code></td>
|
<td align="left"><code>nextState</code></td>
|
||||||
<td>Readonly‹S›</td>
|
<td align="left"><code>Readonly</code><<code>Object</code>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextContext</code></td>
|
<td align="left"><code>nextContext</code></td>
|
||||||
<td>any</td>
|
<td align="left"><code>any</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.UNSAFE_componentWillUpdate</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-componentdidcatch"><code>Optional</code> componentDidCatch<a class="headerlink" href="#optional-componentdidcatch" title="Permanent link">#</a></h3>
|
<h3 id="componentdidcatch">componentDidCatch<a class="headerlink" href="#componentdidcatch" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>componentDidCatch</strong>(<code>error</code>: Error, <code>errorInfo</code>: ErrorInfo): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>componentDidCatch</strong>(<code>error</code>, <code>errorInfo</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-componentdidcatch">componentDidCatch</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:640</p>
|
|
||||||
<p>Catches exceptions generated in descendant components. Unhandled exceptions will cause
|
<p>Catches exceptions generated in descendant components. Unhandled exceptions will cause
|
||||||
the entire component tree to unmount.</p>
|
the entire component tree to unmount.</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>error</code></td>
|
<td align="left"><code>error</code></td>
|
||||||
<td>Error</td>
|
<td align="left"><code>Error</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>errorInfo</code></td>
|
<td align="left"><code>errorInfo</code></td>
|
||||||
<td>ErrorInfo</td>
|
<td align="left"><code>ErrorInfo</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.componentDidCatch</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-componentdidmount"><code>Optional</code> componentDidMount<a class="headerlink" href="#optional-componentdidmount" title="Permanent link">#</a></h3>
|
<h3 id="componentdidmount">componentDidMount<a class="headerlink" href="#componentdidmount" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>componentDidMount</strong>(): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>componentDidMount</strong>(): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.wizardlayout/">WizardLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.wizardlayout/#optional-componentdidmount">componentDidMount</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:619</p>
|
|
||||||
<p>Called immediately after a component is mounted. Setting state here will trigger re-rendering.</p>
|
<p>Called immediately after a component is mounted. Setting state here will trigger re-rendering.</p>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.componentDidMount</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-componentdidupdate"><code>Optional</code> componentDidUpdate<a class="headerlink" href="#optional-componentdidupdate" title="Permanent link">#</a></h3>
|
<h3 id="componentdidupdate">componentDidUpdate<a class="headerlink" href="#componentdidupdate" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>componentDidUpdate</strong>(<code>prevProps</code>: Readonly‹P›, <code>prevState</code>: Readonly‹S›, <code>snapshot?</code>: SS): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>componentDidUpdate</strong>(<code>prevProps</code>, <code>prevState</code>, <code>snapshot?</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-componentdidupdate">componentDidUpdate</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:682</p>
|
|
||||||
<p>Called immediately after updating occurs. Not called for the initial render.</p>
|
<p>Called immediately after updating occurs. Not called for the initial render.</p>
|
||||||
<p>The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.</p>
|
<p>The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>prevProps</code></td>
|
<td align="left"><code>prevProps</code></td>
|
||||||
<td>Readonly‹P›</td>
|
<td align="left"><code>Readonly</code><<code>Object</code>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>prevState</code></td>
|
<td align="left"><code>prevState</code></td>
|
||||||
<td>Readonly‹S›</td>
|
<td align="left"><code>Readonly</code><<code>Object</code>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>snapshot?</code></td>
|
<td align="left"><code>snapshot?</code></td>
|
||||||
<td>SS</td>
|
<td align="left"><code>any</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.componentDidUpdate</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-componentwillmount"><code>Optional</code> componentWillMount<a class="headerlink" href="#optional-componentwillmount" title="Permanent link">#</a></h3>
|
<h3 id="componentwillmount">componentWillMount<a class="headerlink" href="#componentwillmount" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>componentWillMount</strong>(): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>componentWillMount</strong>(): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-componentwillmount">componentWillMount</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:697</p>
|
|
||||||
<p>Called immediately before mounting occurs, and before <code>Component#render</code>.
|
<p>Called immediately before mounting occurs, and before <code>Component#render</code>.
|
||||||
Avoid introducing any side-effects or subscriptions in this method.</p>
|
Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||||
@ -1241,12 +1204,13 @@ prevents this from being invoked.</p>
|
|||||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" 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>React.Component.componentWillMount</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-componentwillreceiveprops"><code>Optional</code> componentWillReceiveProps<a class="headerlink" href="#optional-componentwillreceiveprops" title="Permanent link">#</a></h3>
|
<h3 id="componentwillreceiveprops">componentWillReceiveProps<a class="headerlink" href="#componentwillreceiveprops" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>componentWillReceiveProps</strong>(<code>nextProps</code>: Readonly‹P›, <code>nextContext</code>: any): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>componentWillReceiveProps</strong>(<code>nextProps</code>, <code>nextContext</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-componentwillreceiveprops">componentWillReceiveProps</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:726</p>
|
|
||||||
<p>Called when the component may be receiving new props.
|
<p>Called when the component may be receiving new props.
|
||||||
React may call this even if props have not changed, so be sure to compare new and existing
|
React may call this even if props have not changed, so be sure to compare new and existing
|
||||||
props if you only want to handle changes.</p>
|
props if you only want to handle changes.</p>
|
||||||
@ -1256,39 +1220,41 @@ prevents this from being invoked.</p>
|
|||||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextProps</code></td>
|
<td align="left"><code>nextProps</code></td>
|
||||||
<td>Readonly‹P›</td>
|
<td align="left"><code>Readonly</code><<code>Object</code>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextContext</code></td>
|
<td align="left"><code>nextContext</code></td>
|
||||||
<td>any</td>
|
<td align="left"><code>any</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.componentWillReceiveProps</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-componentwillunmount"><code>Optional</code> componentWillUnmount<a class="headerlink" href="#optional-componentwillunmount" title="Permanent link">#</a></h3>
|
<h3 id="componentwillunmount">componentWillUnmount<a class="headerlink" href="#componentwillunmount" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>componentWillUnmount</strong>(): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>componentWillUnmount</strong>(): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.wizardlayout/">WizardLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.wizardlayout/#optional-componentwillunmount">componentWillUnmount</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:635</p>
|
|
||||||
<p>Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as
|
<p>Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as
|
||||||
cancelled network requests, or cleaning up any DOM elements created in <code>componentDidMount</code>.</p>
|
cancelled network requests, or cleaning up any DOM elements created in <code>componentDidMount</code>.</p>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.componentWillUnmount</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-componentwillupdate"><code>Optional</code> componentWillUpdate<a class="headerlink" href="#optional-componentwillupdate" title="Permanent link">#</a></h3>
|
<h3 id="componentwillupdate">componentWillUpdate<a class="headerlink" href="#componentwillupdate" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>componentWillUpdate</strong>(<code>nextProps</code>: Readonly‹P›, <code>nextState</code>: Readonly‹S›, <code>nextContext</code>: any): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>componentWillUpdate</strong>(<code>nextProps</code>, <code>nextState</code>, <code>nextContext</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-componentwillupdate">componentWillUpdate</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:756</p>
|
|
||||||
<p>Called immediately before rendering when new props or state is received. Not called for the initial render.</p>
|
<p>Called immediately before rendering when new props or state is received. Not called for the initial render.</p>
|
||||||
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
||||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||||
@ -1296,122 +1262,170 @@ prevents this from being invoked.</p>
|
|||||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextProps</code></td>
|
<td align="left"><code>nextProps</code></td>
|
||||||
<td>Readonly‹P›</td>
|
<td align="left"><code>Readonly</code><<code>Object</code>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextState</code></td>
|
<td align="left"><code>nextState</code></td>
|
||||||
<td>Readonly‹S›</td>
|
<td align="left"><code>Readonly</code><<code>Object</code>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextContext</code></td>
|
<td align="left"><code>nextContext</code></td>
|
||||||
<td>any</td>
|
<td align="left"><code>any</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.componentWillUpdate</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="forceupdate">forceUpdate<a class="headerlink" href="#forceupdate" title="Permanent link">#</a></h3>
|
<h3 id="forceupdate">forceUpdate<a class="headerlink" href="#forceupdate" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>forceUpdate</strong>(<code>callback?</code>: function): <em>void</em></p>
|
<p>▸ <strong>forceUpdate</strong>(<code>callback?</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#forceupdate">forceUpdate</a></em></p>
|
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:490</p>
|
<table>
|
||||||
<p><strong>Parameters:</strong></p>
|
<thead>
|
||||||
<p>▪<code>Optional</code> <strong>callback</strong>: <em>function</em></p>
|
<tr>
|
||||||
<p>▸ (): <em>void</em></p>
|
<th align="left">Name</th>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<th align="left">Type</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>callback?</code></td>
|
||||||
|
<td align="left">() => <code>void</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.forceUpdate</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-getsnapshotbeforeupdate"><code>Optional</code> getSnapshotBeforeUpdate<a class="headerlink" href="#optional-getsnapshotbeforeupdate" title="Permanent link">#</a></h3>
|
<h3 id="getsnapshotbeforeupdate">getSnapshotBeforeUpdate<a class="headerlink" href="#getsnapshotbeforeupdate" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>getSnapshotBeforeUpdate</strong>(<code>prevProps</code>: Readonly‹P›, <code>prevState</code>: Readonly‹S›): <em>SS | null</em></p>
|
<p>▸ <code>Optional</code> <strong>getSnapshotBeforeUpdate</strong>(<code>prevProps</code>, <code>prevState</code>): <code>any</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-getsnapshotbeforeupdate">getSnapshotBeforeUpdate</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:676</p>
|
|
||||||
<p>Runs before React applies the result of <code>render</code> to the document, and
|
<p>Runs before React applies the result of <code>render</code> to the document, and
|
||||||
returns an object to be given to componentDidUpdate. Useful for saving
|
returns an object to be given to componentDidUpdate. Useful for saving
|
||||||
things such as scroll position before <code>render</code> causes changes to it.</p>
|
things such as scroll position before <code>render</code> causes changes to it.</p>
|
||||||
<p>Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated
|
<p>Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated
|
||||||
lifecycle events from running.</p>
|
lifecycle events from running.</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>prevProps</code></td>
|
<td align="left"><code>prevProps</code></td>
|
||||||
<td>Readonly‹P›</td>
|
<td align="left"><code>Readonly</code><<code>Object</code>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>prevState</code></td>
|
<td align="left"><code>prevState</code></td>
|
||||||
<td>Readonly‹S›</td>
|
<td align="left"><code>Readonly</code><<code>Object</code>></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>SS | null</em></p>
|
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>any</code></p>
|
||||||
|
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.getSnapshotBeforeUpdate</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="render">render<a class="headerlink" href="#render" title="Permanent link">#</a></h3>
|
<h3 id="render">render<a class="headerlink" href="#render" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>render</strong>(): <em>Element‹›</em></p>
|
<p>▸ <strong>render</strong>(): <code>Element</code></p>
|
||||||
<p><em>Overrides void</em></p>
|
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/kube-object/kube-object-details.tsx#L139">src/renderer/components/kube-object/kube-object-details.tsx:139</a></em></p>
|
<p><code>Element</code></p>
|
||||||
<p><strong>Returns:</strong> <em>Element‹›</em></p>
|
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.render</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="setstate">setState<a class="headerlink" href="#setstate" title="Permanent link">#</a></h3>
|
<h3 id="setstate">setState<a class="headerlink" href="#setstate" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>setState</strong>‹<strong>K</strong>›(<code>state</code>: function | S | object, <code>callback?</code>: function): <em>void</em></p>
|
<p>▸ <strong>setState</strong><K>(<code>state</code>, <code>callback?</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#setstate">setState</a></em></p>
|
<h4 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h4>
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:485</p>
|
<table>
|
||||||
<p><strong>Type parameters:</strong></p>
|
<thead>
|
||||||
<p>▪ <strong>K</strong>: <em>keyof S</em></p>
|
<tr>
|
||||||
<p><strong>Parameters:</strong></p>
|
<th align="left">Name</th>
|
||||||
<p>▪ <strong>state</strong>: <em>function | S | object</em></p>
|
<th align="left">Type</th>
|
||||||
<p>▪<code>Optional</code> <strong>callback</strong>: <em>function</em></p>
|
</tr>
|
||||||
<p>▸ (): <em>void</em></p>
|
</thead>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>K</code></td>
|
||||||
|
<td align="left"><code>K</code>: <code>never</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" 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>state</code></td>
|
||||||
|
<td align="left">{} | (<code>prevState</code>: <code>Readonly</code><<code>Object</code>>, <code>props</code>: <code>Readonly</code><<code>Object</code>>) => {} | <code>Pick</code><<code>Object</code>, K> | <code>Pick</code><<code>Object</code>, K></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>callback?</code></td>
|
||||||
|
<td align="left">() => <code>void</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.setState</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-shouldcomponentupdate"><code>Optional</code> shouldComponentUpdate<a class="headerlink" href="#optional-shouldcomponentupdate" title="Permanent link">#</a></h3>
|
<h3 id="shouldcomponentupdate">shouldComponentUpdate<a class="headerlink" href="#shouldcomponentupdate" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>shouldComponentUpdate</strong>(<code>nextProps</code>: Readonly‹P›, <code>nextState</code>: Readonly‹S›, <code>nextContext</code>: any): <em>boolean</em></p>
|
<p>▸ <code>Optional</code> <strong>shouldComponentUpdate</strong>(<code>nextProps</code>, <code>nextState</code>, <code>nextContext</code>): <code>boolean</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-shouldcomponentupdate">shouldComponentUpdate</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:630</p>
|
|
||||||
<p>Called to determine whether the change in props and state should trigger a re-render.</p>
|
<p>Called to determine whether the change in props and state should trigger a re-render.</p>
|
||||||
<p><code>Component</code> always returns true.
|
<p><code>Component</code> always returns true.
|
||||||
<code>PureComponent</code> implements a shallow comparison on props and state and returns true if any
|
<code>PureComponent</code> implements a shallow comparison on props and state and returns true if any
|
||||||
props or states have changed.</p>
|
props or states have changed.</p>
|
||||||
<p>If false is returned, <code>Component#render</code>, <code>componentWillUpdate</code>
|
<p>If false is returned, <code>Component#render</code>, <code>componentWillUpdate</code>
|
||||||
and <code>componentDidUpdate</code> will not be called.</p>
|
and <code>componentDidUpdate</code> will not be called.</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextProps</code></td>
|
<td align="left"><code>nextProps</code></td>
|
||||||
<td>Readonly‹P›</td>
|
<td align="left"><code>Readonly</code><<code>Object</code>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextState</code></td>
|
<td align="left"><code>nextState</code></td>
|
||||||
<td>Readonly‹S›</td>
|
<td align="left"><code>Readonly</code><<code>Object</code>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextContext</code></td>
|
<td align="left"><code>nextContext</code></td>
|
||||||
<td>any</td>
|
<td align="left"><code>any</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>boolean</em></p>
|
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>boolean</code></p>
|
||||||
|
<h4 id="inherited-from_18">Inherited from<a class="headerlink" href="#inherited-from_18" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.shouldComponentUpdate</p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -9,7 +9,7 @@
|
|||||||
<meta name="description" content="Documentation for Lens Extension API.">
|
<meta name="description" content="Documentation for Lens Extension API.">
|
||||||
|
|
||||||
|
|
||||||
<link rel="canonical" href="https://api-docs.k8slens.dev/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.menuitem/">
|
<link rel="canonical" href="https://api-docs.k8slens.dev/master/extensions/api/classes/renderer.component.menuitem/">
|
||||||
|
|
||||||
|
|
||||||
<meta name="author" content="Mirantis, Inc.">
|
<meta name="author" content="Mirantis, Inc.">
|
||||||
@ -19,7 +19,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<title>Class: MenuItem ‹**S, SS, S**› - Lens Extension API</title>
|
<title>Class: MenuItem - Lens Extension API</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -72,7 +72,7 @@
|
|||||||
<div data-md-component="skip">
|
<div data-md-component="skip">
|
||||||
|
|
||||||
|
|
||||||
<a href="#class-menuitem-s-ss-s" class="md-skip">
|
<a href="#class-menuitem" class="md-skip">
|
||||||
Skip to content
|
Skip to content
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
@ -103,7 +103,7 @@
|
|||||||
<div class="md-header-nav__topic">
|
<div class="md-header-nav__topic">
|
||||||
<span class="md-ellipsis">
|
<span class="md-ellipsis">
|
||||||
|
|
||||||
Class: MenuItem ‹**S, SS, S**›
|
Class: MenuItem
|
||||||
|
|
||||||
</span>
|
</span>
|
||||||
</div>
|
</div>
|
||||||
@ -590,13 +590,6 @@
|
|||||||
</label>
|
</label>
|
||||||
<ul class="md-nav__list" data-md-scrollfix>
|
<ul class="md-nav__list" 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">
|
<li class="md-nav__item">
|
||||||
<a href="#hierarchy" class="md-nav__link">
|
<a href="#hierarchy" class="md-nav__link">
|
||||||
Hierarchy
|
Hierarchy
|
||||||
@ -605,11 +598,11 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#index" class="md-nav__link">
|
<a href="#table-of-contents" class="md-nav__link">
|
||||||
Index
|
Table of contents
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
<nav class="md-nav" aria-label="Index">
|
<nav class="md-nav" aria-label="Table of contents">
|
||||||
<ul class="md-nav__list">
|
<ul class="md-nav__list">
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -709,15 +702,15 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#static-contexttype" class="md-nav__link">
|
<a href="#contexttype" class="md-nav__link">
|
||||||
Static contextType
|
contextType
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#static-defaultprops" class="md-nav__link">
|
<a href="#defaultprops" class="md-nav__link">
|
||||||
Static defaultProps
|
defaultProps
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -763,78 +756,78 @@
|
|||||||
<ul class="md-nav__list">
|
<ul class="md-nav__list">
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-unsafe_componentwillmount" class="md-nav__link">
|
<a href="#unsafe_componentwillmount" class="md-nav__link">
|
||||||
Optional UNSAFE_componentWillMount
|
UNSAFE_componentWillMount
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-unsafe_componentwillreceiveprops" class="md-nav__link">
|
<a href="#unsafe_componentwillreceiveprops" class="md-nav__link">
|
||||||
Optional UNSAFE_componentWillReceiveProps
|
UNSAFE_componentWillReceiveProps
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-unsafe_componentwillupdate" class="md-nav__link">
|
<a href="#unsafe_componentwillupdate" class="md-nav__link">
|
||||||
Optional UNSAFE_componentWillUpdate
|
UNSAFE_componentWillUpdate
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#protected-bindref" class="md-nav__link">
|
<a href="#bindref" class="md-nav__link">
|
||||||
Protected bindRef
|
bindRef
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-componentdidcatch" class="md-nav__link">
|
<a href="#componentdidcatch" class="md-nav__link">
|
||||||
Optional componentDidCatch
|
componentDidCatch
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-componentdidmount" class="md-nav__link">
|
<a href="#componentdidmount" class="md-nav__link">
|
||||||
Optional componentDidMount
|
componentDidMount
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-componentdidupdate" class="md-nav__link">
|
<a href="#componentdidupdate" class="md-nav__link">
|
||||||
Optional componentDidUpdate
|
componentDidUpdate
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-componentwillmount" class="md-nav__link">
|
<a href="#componentwillmount" class="md-nav__link">
|
||||||
Optional componentWillMount
|
componentWillMount
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-componentwillreceiveprops" class="md-nav__link">
|
<a href="#componentwillreceiveprops" class="md-nav__link">
|
||||||
Optional componentWillReceiveProps
|
componentWillReceiveProps
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-componentwillunmount" class="md-nav__link">
|
<a href="#componentwillunmount" class="md-nav__link">
|
||||||
Optional componentWillUnmount
|
componentWillUnmount
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-componentwillupdate" class="md-nav__link">
|
<a href="#componentwillupdate" class="md-nav__link">
|
||||||
Optional componentWillUpdate
|
componentWillUpdate
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -847,8 +840,8 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-getsnapshotbeforeupdate" class="md-nav__link">
|
<a href="#getsnapshotbeforeupdate" class="md-nav__link">
|
||||||
Optional getSnapshotBeforeUpdate
|
getSnapshotBeforeUpdate
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -875,8 +868,8 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-shouldcomponentupdate" class="md-nav__link">
|
<a href="#shouldcomponentupdate" class="md-nav__link">
|
||||||
Optional shouldComponentUpdate
|
shouldComponentUpdate
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -900,17 +893,14 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<h1 id="class-menuitem-s-ss-s">Class: MenuItem ‹<strong>S, SS, S</strong>›<a class="headerlink" href="#class-menuitem-s-ss-s" title="Permanent link">#</a></h1>
|
<h1 id="class-menuitem">Class: MenuItem<a class="headerlink" href="#class-menuitem" title="Permanent link">#</a></h1>
|
||||||
<h2 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h2>
|
<p><a href="../../modules/renderer/">Renderer</a>.<a href="../../modules/renderer.component/">Component</a>.MenuItem</p>
|
||||||
<p>▪ <strong>S</strong></p>
|
|
||||||
<p>▪ <strong>SS</strong></p>
|
|
||||||
<p>▪ <strong>S</strong></p>
|
|
||||||
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
|
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
|
||||||
<ul>
|
<ul>
|
||||||
<li>Component‹<a href="../../interfaces/_renderer_api_index_._renderer_api_components_.menuitemprops/">MenuItemProps</a>›</li>
|
<li><code>Component</code><<a href="../../interfaces/renderer.component.menuitemprops/">MenuItemProps</a>></li>
|
||||||
</ul>
|
</ul>
|
||||||
<p>↳ <strong>MenuItem</strong></p>
|
<p>↳ <strong>MenuItem</strong></p>
|
||||||
<h2 id="index">Index<a class="headerlink" href="#index" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructors">Constructors<a class="headerlink" href="#constructors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="./#constructor">constructor</a></li>
|
<li><a href="./#constructor">constructor</a></li>
|
||||||
@ -922,8 +912,8 @@
|
|||||||
<li><a href="./#props">props</a></li>
|
<li><a href="./#props">props</a></li>
|
||||||
<li><a href="./#refs">refs</a></li>
|
<li><a href="./#refs">refs</a></li>
|
||||||
<li><a href="./#state">state</a></li>
|
<li><a href="./#state">state</a></li>
|
||||||
<li><a href="./#static-contexttype">contextType</a></li>
|
<li><a href="./#contexttype">contextType</a></li>
|
||||||
<li><a href="./#static-defaultprops">defaultProps</a></li>
|
<li><a href="./#defaultprops">defaultProps</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
@ -932,99 +922,92 @@
|
|||||||
</ul>
|
</ul>
|
||||||
<h3 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">#</a></h3>
|
<h3 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="./#optional-unsafe_componentwillmount">UNSAFE_componentWillMount</a></li>
|
<li><a href="./#unsafe_componentwillmount">UNSAFE_componentWillMount</a></li>
|
||||||
<li><a href="./#optional-unsafe_componentwillreceiveprops">UNSAFE_componentWillReceiveProps</a></li>
|
<li><a href="./#unsafe_componentwillreceiveprops">UNSAFE_componentWillReceiveProps</a></li>
|
||||||
<li><a href="./#optional-unsafe_componentwillupdate">UNSAFE_componentWillUpdate</a></li>
|
<li><a href="./#unsafe_componentwillupdate">UNSAFE_componentWillUpdate</a></li>
|
||||||
<li><a href="./#protected-bindref">bindRef</a></li>
|
<li><a href="./#bindref">bindRef</a></li>
|
||||||
<li><a href="./#optional-componentdidcatch">componentDidCatch</a></li>
|
<li><a href="./#componentdidcatch">componentDidCatch</a></li>
|
||||||
<li><a href="./#optional-componentdidmount">componentDidMount</a></li>
|
<li><a href="./#componentdidmount">componentDidMount</a></li>
|
||||||
<li><a href="./#optional-componentdidupdate">componentDidUpdate</a></li>
|
<li><a href="./#componentdidupdate">componentDidUpdate</a></li>
|
||||||
<li><a href="./#optional-componentwillmount">componentWillMount</a></li>
|
<li><a href="./#componentwillmount">componentWillMount</a></li>
|
||||||
<li><a href="./#optional-componentwillreceiveprops">componentWillReceiveProps</a></li>
|
<li><a href="./#componentwillreceiveprops">componentWillReceiveProps</a></li>
|
||||||
<li><a href="./#optional-componentwillunmount">componentWillUnmount</a></li>
|
<li><a href="./#componentwillunmount">componentWillUnmount</a></li>
|
||||||
<li><a href="./#optional-componentwillupdate">componentWillUpdate</a></li>
|
<li><a href="./#componentwillupdate">componentWillUpdate</a></li>
|
||||||
<li><a href="./#forceupdate">forceUpdate</a></li>
|
<li><a href="./#forceupdate">forceUpdate</a></li>
|
||||||
<li><a href="./#optional-getsnapshotbeforeupdate">getSnapshotBeforeUpdate</a></li>
|
<li><a href="./#getsnapshotbeforeupdate">getSnapshotBeforeUpdate</a></li>
|
||||||
<li><a href="./#onclick">onClick</a></li>
|
<li><a href="./#onclick">onClick</a></li>
|
||||||
<li><a href="./#render">render</a></li>
|
<li><a href="./#render">render</a></li>
|
||||||
<li><a href="./#setstate">setState</a></li>
|
<li><a href="./#setstate">setState</a></li>
|
||||||
<li><a href="./#optional-shouldcomponentupdate">shouldComponentUpdate</a></li>
|
<li><a href="./#shouldcomponentupdate">shouldComponentUpdate</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
<p>+ <strong>new MenuItem</strong>(<code>props</code>: <a href="../../interfaces/_renderer_api_index_._renderer_api_components_.menuitemprops/">MenuItemProps</a>): <em><a href="./">MenuItem</a></em></p>
|
<p>• <strong>new MenuItem</strong>(<code>props</code>)</p>
|
||||||
<p><em>Overrides <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#constructor">constructor</a></em></p>
|
<h4 id="parameters">Parameters<a class="headerlink" href="#parameters" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/menu/menu.tsx#L351">src/renderer/components/menu/menu.tsx:351</a></em></p>
|
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>props</code></td>
|
<td align="left"><code>props</code></td>
|
||||||
<td><a href="../../interfaces/_renderer_api_index_._renderer_api_components_.menuitemprops/">MenuItemProps</a></td>
|
<td align="left"><a href="../../interfaces/renderer.component.menuitemprops/">MenuItemProps</a></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em><a href="./">MenuItem</a></em></p>
|
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component<MenuItemProps\>.constructor</p>
|
||||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||||
<h3 id="context">context<a class="headerlink" href="#context" title="Permanent link">#</a></h3>
|
<h3 id="context">context<a class="headerlink" href="#context" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>context</strong>: <em><a href="../../modules/_renderer_api_index_._renderer_api_components_/#menucontextvalue">MenuContextValue</a></em></p>
|
<p>• <strong>context</strong>: <a href="../renderer.component.menu/">Menu</a></p>
|
||||||
<p><em>Overrides <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#context">context</a></em></p>
|
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/menu/menu.tsx#L350">src/renderer/components/menu/menu.tsx:350</a></em></p>
|
<p>React.Component.context</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="elem">elem<a class="headerlink" href="#elem" title="Permanent link">#</a></h3>
|
<h3 id="elem">elem<a class="headerlink" href="#elem" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>elem</strong>: <em>HTMLElement</em></p>
|
<p>• <strong>elem</strong>: <code>HTMLElement</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/menu/menu.tsx#L351">src/renderer/components/menu/menu.tsx:351</a></em></p>
|
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="props">props<a class="headerlink" href="#props" title="Permanent link">#</a></h3>
|
<h3 id="props">props<a class="headerlink" href="#props" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>props</strong>: <em>Readonly‹<a href="../../interfaces/_renderer_api_index_._renderer_api_components_.menuitemprops/">MenuItemProps</a>› & Readonly‹object›</em></p>
|
<p>• <code>Readonly</code> <strong>props</strong>: <code>Readonly</code><<a href="../../interfaces/renderer.component.menuitemprops/">MenuItemProps</a>> & <code>Readonly</code><<code>Object</code>></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#props">props</a></em></p>
|
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:498</p>
|
<p>React.Component.props</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="refs">refs<a class="headerlink" href="#refs" title="Permanent link">#</a></h3>
|
<h3 id="refs">refs<a class="headerlink" href="#refs" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>refs</strong>: <em>object</em></p>
|
<p>• <strong>refs</strong>: <code>Object</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#refs">refs</a></em></p>
|
<p><strong><code>deprecated</code></strong>
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:504</p>
|
|
||||||
<p><strong><code>deprecated</code></strong>
|
|
||||||
https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||||
<h4 id="type-declaration">Type declaration:<a class="headerlink" href="#type-declaration" title="Permanent link">#</a></h4>
|
<h4 id="index-signature">Index signature<a class="headerlink" href="#index-signature" title="Permanent link">#</a></h4>
|
||||||
<ul>
|
<p>▪ [key: <code>string</code>]: <code>ReactInstance</code></p>
|
||||||
<li>[ <strong>key</strong>: <em>string</em>]: ReactInstance</li>
|
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||||
</ul>
|
<p>React.Component.refs</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="state">state<a class="headerlink" href="#state" title="Permanent link">#</a></h3>
|
<h3 id="state">state<a class="headerlink" href="#state" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>state</strong>: <em>Readonly‹S›</em></p>
|
<p>• <strong>state</strong>: <code>Readonly</code><<code>Object</code>></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#state">state</a></em></p>
|
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:499</p>
|
<p>React.Component.state</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="static-contexttype"><code>Static</code> contextType<a class="headerlink" href="#static-contexttype" title="Permanent link">#</a></h3>
|
<h3 id="contexttype">contextType<a class="headerlink" href="#contexttype" title="Permanent link">#</a></h3>
|
||||||
<p>▪ <strong>contextType</strong>: <em>Context‹<a href="../_renderer_api_index_._renderer_api_components_.menu/">Menu</a>‹››</em> = MenuContext</p>
|
<p>▪ <code>Static</code> <strong>contextType</strong>: <code>Context</code><<a href="../renderer.component.menu/">Menu</a>></p>
|
||||||
<p><em>Overrides <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#static-optional-contexttype">contextType</a></em></p>
|
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/menu/menu.tsx#L348">src/renderer/components/menu/menu.tsx:348</a></em></p>
|
<p>React.Component.contextType</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="static-defaultprops"><code>Static</code> defaultProps<a class="headerlink" href="#static-defaultprops" title="Permanent link">#</a></h3>
|
<h3 id="defaultprops">defaultProps<a class="headerlink" href="#defaultprops" title="Permanent link">#</a></h3>
|
||||||
<p>▪ <strong>defaultProps</strong>: <em>object</em> = defaultPropsMenuItem as object</p>
|
<p>▪ <code>Static</code> <strong>defaultProps</strong>: <code>object</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/menu/menu.tsx#L347">src/renderer/components/menu/menu.tsx:347</a></em></p>
|
|
||||||
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
||||||
<h3 id="isfocusable">isFocusable<a class="headerlink" href="#isfocusable" title="Permanent link">#</a></h3>
|
<h3 id="isfocusable">isFocusable<a class="headerlink" href="#isfocusable" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>get isFocusable</strong>(): <em>boolean</em></p>
|
<p>• <code>get</code> <strong>isFocusable</strong>(): <code>boolean</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/menu/menu.tsx#L358">src/renderer/components/menu/menu.tsx:358</a></em></p>
|
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Returns:</strong> <em>boolean</em></p>
|
<p><code>boolean</code></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="islink">isLink<a class="headerlink" href="#islink" title="Permanent link">#</a></h3>
|
<h3 id="islink">isLink<a class="headerlink" href="#islink" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>get isLink</strong>(): <em>boolean</em></p>
|
<p>• <code>get</code> <strong>isLink</strong>(): <code>boolean</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/menu/menu.tsx#L364">src/renderer/components/menu/menu.tsx:364</a></em></p>
|
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Returns:</strong> <em>boolean</em></p>
|
<p><code>boolean</code></p>
|
||||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||||
<h3 id="optional-unsafe_componentwillmount"><code>Optional</code> UNSAFE_componentWillMount<a class="headerlink" href="#optional-unsafe_componentwillmount" title="Permanent link">#</a></h3>
|
<h3 id="unsafe_componentwillmount">UNSAFE_componentWillMount<a class="headerlink" href="#unsafe_componentwillmount" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>UNSAFE_componentWillMount</strong>(): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>UNSAFE_componentWillMount</strong>(): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-unsafe_componentwillmount">UNSAFE_componentWillMount</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:711</p>
|
|
||||||
<p>Called immediately before mounting occurs, and before <code>Component#render</code>.
|
<p>Called immediately before mounting occurs, and before <code>Component#render</code>.
|
||||||
Avoid introducing any side-effects or subscriptions in this method.</p>
|
Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||||
<p>This method will not stop working in React 17.</p>
|
<p>This method will not stop working in React 17.</p>
|
||||||
@ -1033,12 +1016,13 @@ prevents this from being invoked.</p>
|
|||||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead</p>
|
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_3">Inherited from<a class="headerlink" href="#inherited-from_3" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.UNSAFE_componentWillMount</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-unsafe_componentwillreceiveprops"><code>Optional</code> UNSAFE_componentWillReceiveProps<a class="headerlink" href="#optional-unsafe_componentwillreceiveprops" title="Permanent link">#</a></h3>
|
<h3 id="unsafe_componentwillreceiveprops">UNSAFE_componentWillReceiveProps<a class="headerlink" href="#unsafe_componentwillreceiveprops" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>UNSAFE_componentWillReceiveProps</strong>(<code>nextProps</code>: Readonly‹<a href="../../interfaces/_renderer_api_index_._renderer_api_components_.menuitemprops/">MenuItemProps</a>›, <code>nextContext</code>: any): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>UNSAFE_componentWillReceiveProps</strong>(<code>nextProps</code>, <code>nextContext</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-unsafe_componentwillreceiveprops">UNSAFE_componentWillReceiveProps</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:743</p>
|
|
||||||
<p>Called when the component may be receiving new props.
|
<p>Called when the component may be receiving new props.
|
||||||
React may call this even if props have not changed, so be sure to compare new and existing
|
React may call this even if props have not changed, so be sure to compare new and existing
|
||||||
props if you only want to handle changes.</p>
|
props if you only want to handle changes.</p>
|
||||||
@ -1049,31 +1033,32 @@ prevents this from being invoked.</p>
|
|||||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead</p>
|
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextProps</code></td>
|
<td align="left"><code>nextProps</code></td>
|
||||||
<td>Readonly‹<a href="../../interfaces/_renderer_api_index_._renderer_api_components_.menuitemprops/">MenuItemProps</a>›</td>
|
<td align="left"><code>Readonly</code><<a href="../../interfaces/renderer.component.menuitemprops/">MenuItemProps</a>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextContext</code></td>
|
<td align="left"><code>nextContext</code></td>
|
||||||
<td>any</td>
|
<td align="left"><code>any</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.UNSAFE_componentWillReceiveProps</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-unsafe_componentwillupdate"><code>Optional</code> UNSAFE_componentWillUpdate<a class="headerlink" href="#optional-unsafe_componentwillupdate" title="Permanent link">#</a></h3>
|
<h3 id="unsafe_componentwillupdate">UNSAFE_componentWillUpdate<a class="headerlink" href="#unsafe_componentwillupdate" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>UNSAFE_componentWillUpdate</strong>(<code>nextProps</code>: Readonly‹<a href="../../interfaces/_renderer_api_index_._renderer_api_components_.menuitemprops/">MenuItemProps</a>›, <code>nextState</code>: Readonly‹S›, <code>nextContext</code>: any): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>UNSAFE_componentWillUpdate</strong>(<code>nextProps</code>, <code>nextState</code>, <code>nextContext</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-unsafe_componentwillupdate">UNSAFE_componentWillUpdate</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:771</p>
|
|
||||||
<p>Called immediately before rendering when new props or state is received. Not called for the initial render.</p>
|
<p>Called immediately before rendering when new props or state is received. Not called for the initial render.</p>
|
||||||
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
||||||
<p>This method will not stop working in React 17.</p>
|
<p>This method will not stop working in React 17.</p>
|
||||||
@ -1082,120 +1067,124 @@ prevents this from being invoked.</p>
|
|||||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead</p>
|
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextProps</code></td>
|
<td align="left"><code>nextProps</code></td>
|
||||||
<td>Readonly‹<a href="../../interfaces/_renderer_api_index_._renderer_api_components_.menuitemprops/">MenuItemProps</a>›</td>
|
<td align="left"><code>Readonly</code><<a href="../../interfaces/renderer.component.menuitemprops/">MenuItemProps</a>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextState</code></td>
|
<td align="left"><code>nextState</code></td>
|
||||||
<td>Readonly‹S›</td>
|
<td align="left"><code>Readonly</code><<code>Object</code>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextContext</code></td>
|
<td align="left"><code>nextContext</code></td>
|
||||||
<td>any</td>
|
<td align="left"><code>any</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<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_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.UNSAFE_componentWillUpdate</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="protected-bindref"><code>Protected</code> bindRef<a class="headerlink" href="#protected-bindref" title="Permanent link">#</a></h3>
|
<h3 id="bindref">bindRef<a class="headerlink" href="#bindref" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>bindRef</strong>(<code>elem</code>: HTMLElement): <em>void</em></p>
|
<p>▸ <code>Protected</code> <strong>bindRef</strong>(<code>elem</code>): <code>void</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/menu/menu.tsx#L380">src/renderer/components/menu/menu.tsx:380</a></em></p>
|
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>elem</code></td>
|
<td align="left"><code>elem</code></td>
|
||||||
<td>HTMLElement</td>
|
<td align="left"><code>HTMLElement</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-componentdidcatch"><code>Optional</code> componentDidCatch<a class="headerlink" href="#optional-componentdidcatch" title="Permanent link">#</a></h3>
|
<h3 id="componentdidcatch">componentDidCatch<a class="headerlink" href="#componentdidcatch" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>componentDidCatch</strong>(<code>error</code>: Error, <code>errorInfo</code>: ErrorInfo): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>componentDidCatch</strong>(<code>error</code>, <code>errorInfo</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-componentdidcatch">componentDidCatch</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:640</p>
|
|
||||||
<p>Catches exceptions generated in descendant components. Unhandled exceptions will cause
|
<p>Catches exceptions generated in descendant components. Unhandled exceptions will cause
|
||||||
the entire component tree to unmount.</p>
|
the entire component tree to unmount.</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>error</code></td>
|
<td align="left"><code>error</code></td>
|
||||||
<td>Error</td>
|
<td align="left"><code>Error</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>errorInfo</code></td>
|
<td align="left"><code>errorInfo</code></td>
|
||||||
<td>ErrorInfo</td>
|
<td align="left"><code>ErrorInfo</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.componentDidCatch</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-componentdidmount"><code>Optional</code> componentDidMount<a class="headerlink" href="#optional-componentdidmount" title="Permanent link">#</a></h3>
|
<h3 id="componentdidmount">componentDidMount<a class="headerlink" href="#componentdidmount" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>componentDidMount</strong>(): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>componentDidMount</strong>(): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.wizardlayout/">WizardLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.wizardlayout/#optional-componentdidmount">componentDidMount</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:619</p>
|
|
||||||
<p>Called immediately after a component is mounted. Setting state here will trigger re-rendering.</p>
|
<p>Called immediately after a component is mounted. Setting state here will trigger re-rendering.</p>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.componentDidMount</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-componentdidupdate"><code>Optional</code> componentDidUpdate<a class="headerlink" href="#optional-componentdidupdate" title="Permanent link">#</a></h3>
|
<h3 id="componentdidupdate">componentDidUpdate<a class="headerlink" href="#componentdidupdate" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>componentDidUpdate</strong>(<code>prevProps</code>: Readonly‹<a href="../../interfaces/_renderer_api_index_._renderer_api_components_.menuitemprops/">MenuItemProps</a>›, <code>prevState</code>: Readonly‹S›, <code>snapshot?</code>: SS): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>componentDidUpdate</strong>(<code>prevProps</code>, <code>prevState</code>, <code>snapshot?</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-componentdidupdate">componentDidUpdate</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:682</p>
|
|
||||||
<p>Called immediately after updating occurs. Not called for the initial render.</p>
|
<p>Called immediately after updating occurs. Not called for the initial render.</p>
|
||||||
<p>The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.</p>
|
<p>The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>prevProps</code></td>
|
<td align="left"><code>prevProps</code></td>
|
||||||
<td>Readonly‹<a href="../../interfaces/_renderer_api_index_._renderer_api_components_.menuitemprops/">MenuItemProps</a>›</td>
|
<td align="left"><code>Readonly</code><<a href="../../interfaces/renderer.component.menuitemprops/">MenuItemProps</a>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>prevState</code></td>
|
<td align="left"><code>prevState</code></td>
|
||||||
<td>Readonly‹S›</td>
|
<td align="left"><code>Readonly</code><<code>Object</code>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>snapshot?</code></td>
|
<td align="left"><code>snapshot?</code></td>
|
||||||
<td>SS</td>
|
<td align="left"><code>any</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.componentDidUpdate</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-componentwillmount"><code>Optional</code> componentWillMount<a class="headerlink" href="#optional-componentwillmount" title="Permanent link">#</a></h3>
|
<h3 id="componentwillmount">componentWillMount<a class="headerlink" href="#componentwillmount" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>componentWillMount</strong>(): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>componentWillMount</strong>(): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-componentwillmount">componentWillMount</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:697</p>
|
|
||||||
<p>Called immediately before mounting occurs, and before <code>Component#render</code>.
|
<p>Called immediately before mounting occurs, and before <code>Component#render</code>.
|
||||||
Avoid introducing any side-effects or subscriptions in this method.</p>
|
Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||||
@ -1203,12 +1192,13 @@ prevents this from being invoked.</p>
|
|||||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.componentWillMount</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-componentwillreceiveprops"><code>Optional</code> componentWillReceiveProps<a class="headerlink" href="#optional-componentwillreceiveprops" title="Permanent link">#</a></h3>
|
<h3 id="componentwillreceiveprops">componentWillReceiveProps<a class="headerlink" href="#componentwillreceiveprops" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>componentWillReceiveProps</strong>(<code>nextProps</code>: Readonly‹<a href="../../interfaces/_renderer_api_index_._renderer_api_components_.menuitemprops/">MenuItemProps</a>›, <code>nextContext</code>: any): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>componentWillReceiveProps</strong>(<code>nextProps</code>, <code>nextContext</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-componentwillreceiveprops">componentWillReceiveProps</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:726</p>
|
|
||||||
<p>Called when the component may be receiving new props.
|
<p>Called when the component may be receiving new props.
|
||||||
React may call this even if props have not changed, so be sure to compare new and existing
|
React may call this even if props have not changed, so be sure to compare new and existing
|
||||||
props if you only want to handle changes.</p>
|
props if you only want to handle changes.</p>
|
||||||
@ -1218,39 +1208,41 @@ prevents this from being invoked.</p>
|
|||||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextProps</code></td>
|
<td align="left"><code>nextProps</code></td>
|
||||||
<td>Readonly‹<a href="../../interfaces/_renderer_api_index_._renderer_api_components_.menuitemprops/">MenuItemProps</a>›</td>
|
<td align="left"><code>Readonly</code><<a href="../../interfaces/renderer.component.menuitemprops/">MenuItemProps</a>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextContext</code></td>
|
<td align="left"><code>nextContext</code></td>
|
||||||
<td>any</td>
|
<td align="left"><code>any</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.componentWillReceiveProps</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-componentwillunmount"><code>Optional</code> componentWillUnmount<a class="headerlink" href="#optional-componentwillunmount" title="Permanent link">#</a></h3>
|
<h3 id="componentwillunmount">componentWillUnmount<a class="headerlink" href="#componentwillunmount" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>componentWillUnmount</strong>(): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>componentWillUnmount</strong>(): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.wizardlayout/">WizardLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.wizardlayout/#optional-componentwillunmount">componentWillUnmount</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:635</p>
|
|
||||||
<p>Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as
|
<p>Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as
|
||||||
cancelled network requests, or cleaning up any DOM elements created in <code>componentDidMount</code>.</p>
|
cancelled network requests, or cleaning up any DOM elements created in <code>componentDidMount</code>.</p>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.componentWillUnmount</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-componentwillupdate"><code>Optional</code> componentWillUpdate<a class="headerlink" href="#optional-componentwillupdate" title="Permanent link">#</a></h3>
|
<h3 id="componentwillupdate">componentWillUpdate<a class="headerlink" href="#componentwillupdate" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>componentWillUpdate</strong>(<code>nextProps</code>: Readonly‹<a href="../../interfaces/_renderer_api_index_._renderer_api_components_.menuitemprops/">MenuItemProps</a>›, <code>nextState</code>: Readonly‹S›, <code>nextContext</code>: any): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>componentWillUpdate</strong>(<code>nextProps</code>, <code>nextState</code>, <code>nextContext</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-componentwillupdate">componentWillUpdate</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:756</p>
|
|
||||||
<p>Called immediately before rendering when new props or state is received. Not called for the initial render.</p>
|
<p>Called immediately before rendering when new props or state is received. Not called for the initial render.</p>
|
||||||
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
||||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||||
@ -1258,142 +1250,190 @@ prevents this from being invoked.</p>
|
|||||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextProps</code></td>
|
<td align="left"><code>nextProps</code></td>
|
||||||
<td>Readonly‹<a href="../../interfaces/_renderer_api_index_._renderer_api_components_.menuitemprops/">MenuItemProps</a>›</td>
|
<td align="left"><code>Readonly</code><<a href="../../interfaces/renderer.component.menuitemprops/">MenuItemProps</a>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextState</code></td>
|
<td align="left"><code>nextState</code></td>
|
||||||
<td>Readonly‹S›</td>
|
<td align="left"><code>Readonly</code><<code>Object</code>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextContext</code></td>
|
<td align="left"><code>nextContext</code></td>
|
||||||
<td>any</td>
|
<td align="left"><code>any</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.componentWillUpdate</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="forceupdate">forceUpdate<a class="headerlink" href="#forceupdate" title="Permanent link">#</a></h3>
|
<h3 id="forceupdate">forceUpdate<a class="headerlink" href="#forceupdate" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>forceUpdate</strong>(<code>callback?</code>: function): <em>void</em></p>
|
<p>▸ <strong>forceUpdate</strong>(<code>callback?</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#forceupdate">forceUpdate</a></em></p>
|
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:490</p>
|
<table>
|
||||||
<p><strong>Parameters:</strong></p>
|
<thead>
|
||||||
<p>▪<code>Optional</code> <strong>callback</strong>: <em>function</em></p>
|
<tr>
|
||||||
<p>▸ (): <em>void</em></p>
|
<th align="left">Name</th>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<th align="left">Type</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>callback?</code></td>
|
||||||
|
<td align="left">() => <code>void</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.forceUpdate</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-getsnapshotbeforeupdate"><code>Optional</code> getSnapshotBeforeUpdate<a class="headerlink" href="#optional-getsnapshotbeforeupdate" title="Permanent link">#</a></h3>
|
<h3 id="getsnapshotbeforeupdate">getSnapshotBeforeUpdate<a class="headerlink" href="#getsnapshotbeforeupdate" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>getSnapshotBeforeUpdate</strong>(<code>prevProps</code>: Readonly‹<a href="../../interfaces/_renderer_api_index_._renderer_api_components_.menuitemprops/">MenuItemProps</a>›, <code>prevState</code>: Readonly‹S›): <em>SS | null</em></p>
|
<p>▸ <code>Optional</code> <strong>getSnapshotBeforeUpdate</strong>(<code>prevProps</code>, <code>prevState</code>): <code>any</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-getsnapshotbeforeupdate">getSnapshotBeforeUpdate</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:676</p>
|
|
||||||
<p>Runs before React applies the result of <code>render</code> to the document, and
|
<p>Runs before React applies the result of <code>render</code> to the document, and
|
||||||
returns an object to be given to componentDidUpdate. Useful for saving
|
returns an object to be given to componentDidUpdate. Useful for saving
|
||||||
things such as scroll position before <code>render</code> causes changes to it.</p>
|
things such as scroll position before <code>render</code> causes changes to it.</p>
|
||||||
<p>Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated
|
<p>Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated
|
||||||
lifecycle events from running.</p>
|
lifecycle events from running.</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>prevProps</code></td>
|
<td align="left"><code>prevProps</code></td>
|
||||||
<td>Readonly‹<a href="../../interfaces/_renderer_api_index_._renderer_api_components_.menuitemprops/">MenuItemProps</a>›</td>
|
<td align="left"><code>Readonly</code><<a href="../../interfaces/renderer.component.menuitemprops/">MenuItemProps</a>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>prevState</code></td>
|
<td align="left"><code>prevState</code></td>
|
||||||
<td>Readonly‹S›</td>
|
<td align="left"><code>Readonly</code><<code>Object</code>></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>SS | null</em></p>
|
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>any</code></p>
|
||||||
|
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.getSnapshotBeforeUpdate</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="onclick">onClick<a class="headerlink" href="#onclick" title="Permanent link">#</a></h3>
|
<h3 id="onclick">onClick<a class="headerlink" href="#onclick" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>onClick</strong>(<code>evt</code>: MouseEvent): <em>void</em></p>
|
<p>▸ <strong>onClick</strong>(<code>evt</code>): <code>void</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/menu/menu.tsx#L368">src/renderer/components/menu/menu.tsx:368</a></em></p>
|
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>evt</code></td>
|
<td align="left"><code>evt</code></td>
|
||||||
<td>MouseEvent</td>
|
<td align="left"><code>MouseEvent</code><Element, MouseEvent></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="render">render<a class="headerlink" href="#render" title="Permanent link">#</a></h3>
|
<h3 id="render">render<a class="headerlink" href="#render" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>render</strong>(): <em>Element‹›</em></p>
|
<p>▸ <strong>render</strong>(): <code>Element</code></p>
|
||||||
<p><em>Overrides void</em></p>
|
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/menu/menu.tsx#L384">src/renderer/components/menu/menu.tsx:384</a></em></p>
|
<p><code>Element</code></p>
|
||||||
<p><strong>Returns:</strong> <em>Element‹›</em></p>
|
<h4 id="overrides_3">Overrides<a class="headerlink" href="#overrides_3" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.render</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="setstate">setState<a class="headerlink" href="#setstate" title="Permanent link">#</a></h3>
|
<h3 id="setstate">setState<a class="headerlink" href="#setstate" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>setState</strong>‹<strong>K</strong>›(<code>state</code>: function | S | object, <code>callback?</code>: function): <em>void</em></p>
|
<p>▸ <strong>setState</strong><K>(<code>state</code>, <code>callback?</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#setstate">setState</a></em></p>
|
<h4 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h4>
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:485</p>
|
<table>
|
||||||
<p><strong>Type parameters:</strong></p>
|
<thead>
|
||||||
<p>▪ <strong>K</strong>: <em>keyof S</em></p>
|
<tr>
|
||||||
<p><strong>Parameters:</strong></p>
|
<th align="left">Name</th>
|
||||||
<p>▪ <strong>state</strong>: <em>function | S | object</em></p>
|
<th align="left">Type</th>
|
||||||
<p>▪<code>Optional</code> <strong>callback</strong>: <em>function</em></p>
|
</tr>
|
||||||
<p>▸ (): <em>void</em></p>
|
</thead>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>K</code></td>
|
||||||
|
<td align="left"><code>K</code>: <code>never</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" 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>state</code></td>
|
||||||
|
<td align="left">{} | (<code>prevState</code>: <code>Readonly</code><<code>Object</code>>, <code>props</code>: <code>Readonly</code><<a href="../../interfaces/renderer.component.menuitemprops/">MenuItemProps</a>>) => {} | <code>Pick</code><<code>Object</code>, K> | <code>Pick</code><<code>Object</code>, K></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>callback?</code></td>
|
||||||
|
<td align="left">() => <code>void</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.setState</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-shouldcomponentupdate"><code>Optional</code> shouldComponentUpdate<a class="headerlink" href="#optional-shouldcomponentupdate" title="Permanent link">#</a></h3>
|
<h3 id="shouldcomponentupdate">shouldComponentUpdate<a class="headerlink" href="#shouldcomponentupdate" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>shouldComponentUpdate</strong>(<code>nextProps</code>: Readonly‹<a href="../../interfaces/_renderer_api_index_._renderer_api_components_.menuitemprops/">MenuItemProps</a>›, <code>nextState</code>: Readonly‹S›, <code>nextContext</code>: any): <em>boolean</em></p>
|
<p>▸ <code>Optional</code> <strong>shouldComponentUpdate</strong>(<code>nextProps</code>, <code>nextState</code>, <code>nextContext</code>): <code>boolean</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-shouldcomponentupdate">shouldComponentUpdate</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:630</p>
|
|
||||||
<p>Called to determine whether the change in props and state should trigger a re-render.</p>
|
<p>Called to determine whether the change in props and state should trigger a re-render.</p>
|
||||||
<p><code>Component</code> always returns true.
|
<p><code>Component</code> always returns true.
|
||||||
<code>PureComponent</code> implements a shallow comparison on props and state and returns true if any
|
<code>PureComponent</code> implements a shallow comparison on props and state and returns true if any
|
||||||
props or states have changed.</p>
|
props or states have changed.</p>
|
||||||
<p>If false is returned, <code>Component#render</code>, <code>componentWillUpdate</code>
|
<p>If false is returned, <code>Component#render</code>, <code>componentWillUpdate</code>
|
||||||
and <code>componentDidUpdate</code> will not be called.</p>
|
and <code>componentDidUpdate</code> will not be called.</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_12">Parameters<a class="headerlink" href="#parameters_12" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextProps</code></td>
|
<td align="left"><code>nextProps</code></td>
|
||||||
<td>Readonly‹<a href="../../interfaces/_renderer_api_index_._renderer_api_components_.menuitemprops/">MenuItemProps</a>›</td>
|
<td align="left"><code>Readonly</code><<a href="../../interfaces/renderer.component.menuitemprops/">MenuItemProps</a>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextState</code></td>
|
<td align="left"><code>nextState</code></td>
|
||||||
<td>Readonly‹S›</td>
|
<td align="left"><code>Readonly</code><<code>Object</code>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextContext</code></td>
|
<td align="left"><code>nextContext</code></td>
|
||||||
<td>any</td>
|
<td align="left"><code>any</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>boolean</em></p>
|
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>boolean</code></p>
|
||||||
|
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.shouldComponentUpdate</p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -9,7 +9,7 @@
|
|||||||
<meta name="description" content="Documentation for Lens Extension API.">
|
<meta name="description" content="Documentation for Lens Extension API.">
|
||||||
|
|
||||||
|
|
||||||
<link rel="canonical" href="https://api-docs.k8slens.dev/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.namespaceselect/">
|
<link rel="canonical" href="https://api-docs.k8slens.dev/master/extensions/api/classes/renderer.component.namespaceselect/">
|
||||||
|
|
||||||
|
|
||||||
<meta name="author" content="Mirantis, Inc.">
|
<meta name="author" content="Mirantis, Inc.">
|
||||||
@ -19,7 +19,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<title>Class: NamespaceSelect ‹**S, SS, S**› - Lens Extension API</title>
|
<title>Class: NamespaceSelect - Lens Extension API</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -72,7 +72,7 @@
|
|||||||
<div data-md-component="skip">
|
<div data-md-component="skip">
|
||||||
|
|
||||||
|
|
||||||
<a href="#class-namespaceselect-s-ss-s" class="md-skip">
|
<a href="#class-namespaceselect" class="md-skip">
|
||||||
Skip to content
|
Skip to content
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
@ -103,7 +103,7 @@
|
|||||||
<div class="md-header-nav__topic">
|
<div class="md-header-nav__topic">
|
||||||
<span class="md-ellipsis">
|
<span class="md-ellipsis">
|
||||||
|
|
||||||
Class: NamespaceSelect ‹**S, SS, S**›
|
Class: NamespaceSelect
|
||||||
|
|
||||||
</span>
|
</span>
|
||||||
</div>
|
</div>
|
||||||
@ -590,13 +590,6 @@
|
|||||||
</label>
|
</label>
|
||||||
<ul class="md-nav__list" data-md-scrollfix>
|
<ul class="md-nav__list" 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">
|
<li class="md-nav__item">
|
||||||
<a href="#hierarchy" class="md-nav__link">
|
<a href="#hierarchy" class="md-nav__link">
|
||||||
Hierarchy
|
Hierarchy
|
||||||
@ -605,11 +598,11 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#index" class="md-nav__link">
|
<a href="#table-of-contents" class="md-nav__link">
|
||||||
Index
|
Table of contents
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
<nav class="md-nav" aria-label="Index">
|
<nav class="md-nav" aria-label="Table of contents">
|
||||||
<ul class="md-nav__list">
|
<ul class="md-nav__list">
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -702,15 +695,15 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#static-optional-contexttype" class="md-nav__link">
|
<a href="#contexttype" class="md-nav__link">
|
||||||
Static Optional contextType
|
contextType
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#static-defaultprops" class="md-nav__link">
|
<a href="#defaultprops" class="md-nav__link">
|
||||||
Static defaultProps
|
defaultProps
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -749,29 +742,29 @@
|
|||||||
<ul class="md-nav__list">
|
<ul class="md-nav__list">
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-unsafe_componentwillmount" class="md-nav__link">
|
<a href="#unsafe_componentwillmount" class="md-nav__link">
|
||||||
Optional UNSAFE_componentWillMount
|
UNSAFE_componentWillMount
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-unsafe_componentwillreceiveprops" class="md-nav__link">
|
<a href="#unsafe_componentwillreceiveprops" class="md-nav__link">
|
||||||
Optional UNSAFE_componentWillReceiveProps
|
UNSAFE_componentWillReceiveProps
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-unsafe_componentwillupdate" class="md-nav__link">
|
<a href="#unsafe_componentwillupdate" class="md-nav__link">
|
||||||
Optional UNSAFE_componentWillUpdate
|
UNSAFE_componentWillUpdate
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-componentdidcatch" class="md-nav__link">
|
<a href="#componentdidcatch" class="md-nav__link">
|
||||||
Optional componentDidCatch
|
componentDidCatch
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -784,36 +777,36 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-componentdidupdate" class="md-nav__link">
|
<a href="#componentdidupdate" class="md-nav__link">
|
||||||
Optional componentDidUpdate
|
componentDidUpdate
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-componentwillmount" class="md-nav__link">
|
<a href="#componentwillmount" class="md-nav__link">
|
||||||
Optional componentWillMount
|
componentWillMount
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-componentwillreceiveprops" class="md-nav__link">
|
<a href="#componentwillreceiveprops" class="md-nav__link">
|
||||||
Optional componentWillReceiveProps
|
componentWillReceiveProps
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-componentwillunmount" class="md-nav__link">
|
<a href="#componentwillunmount" class="md-nav__link">
|
||||||
Optional componentWillUnmount
|
componentWillUnmount
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-componentwillupdate" class="md-nav__link">
|
<a href="#componentwillupdate" class="md-nav__link">
|
||||||
Optional componentWillUpdate
|
componentWillUpdate
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -833,8 +826,8 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-getsnapshotbeforeupdate" class="md-nav__link">
|
<a href="#getsnapshotbeforeupdate" class="md-nav__link">
|
||||||
Optional getSnapshotBeforeUpdate
|
getSnapshotBeforeUpdate
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -854,8 +847,8 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#optional-shouldcomponentupdate" class="md-nav__link">
|
<a href="#shouldcomponentupdate" class="md-nav__link">
|
||||||
Optional shouldComponentUpdate
|
shouldComponentUpdate
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -879,17 +872,14 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<h1 id="class-namespaceselect-s-ss-s">Class: NamespaceSelect ‹<strong>S, SS, S</strong>›<a class="headerlink" href="#class-namespaceselect-s-ss-s" title="Permanent link">#</a></h1>
|
<h1 id="class-namespaceselect">Class: NamespaceSelect<a class="headerlink" href="#class-namespaceselect" title="Permanent link">#</a></h1>
|
||||||
<h2 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h2>
|
<p><a href="../../modules/renderer/">Renderer</a>.<a href="../../modules/renderer.component/">Component</a>.NamespaceSelect</p>
|
||||||
<p>▪ <strong>S</strong></p>
|
|
||||||
<p>▪ <strong>SS</strong></p>
|
|
||||||
<p>▪ <strong>S</strong></p>
|
|
||||||
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
|
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
|
||||||
<ul>
|
<ul>
|
||||||
<li>Component‹Props›</li>
|
<li><code>Component</code><Props></li>
|
||||||
</ul>
|
</ul>
|
||||||
<p>↳ <strong>NamespaceSelect</strong></p>
|
<p>↳ <strong>NamespaceSelect</strong></p>
|
||||||
<h2 id="index">Index<a class="headerlink" href="#index" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructors">Constructors<a class="headerlink" href="#constructors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="./#constructor">constructor</a></li>
|
<li><a href="./#constructor">constructor</a></li>
|
||||||
@ -900,8 +890,8 @@
|
|||||||
<li><a href="./#props">props</a></li>
|
<li><a href="./#props">props</a></li>
|
||||||
<li><a href="./#refs">refs</a></li>
|
<li><a href="./#refs">refs</a></li>
|
||||||
<li><a href="./#state">state</a></li>
|
<li><a href="./#state">state</a></li>
|
||||||
<li><a href="./#static-optional-contexttype">contextType</a></li>
|
<li><a href="./#contexttype">contextType</a></li>
|
||||||
<li><a href="./#static-defaultprops">defaultProps</a></li>
|
<li><a href="./#defaultprops">defaultProps</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
@ -909,49 +899,46 @@
|
|||||||
</ul>
|
</ul>
|
||||||
<h3 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">#</a></h3>
|
<h3 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="./#optional-unsafe_componentwillmount">UNSAFE_componentWillMount</a></li>
|
<li><a href="./#unsafe_componentwillmount">UNSAFE_componentWillMount</a></li>
|
||||||
<li><a href="./#optional-unsafe_componentwillreceiveprops">UNSAFE_componentWillReceiveProps</a></li>
|
<li><a href="./#unsafe_componentwillreceiveprops">UNSAFE_componentWillReceiveProps</a></li>
|
||||||
<li><a href="./#optional-unsafe_componentwillupdate">UNSAFE_componentWillUpdate</a></li>
|
<li><a href="./#unsafe_componentwillupdate">UNSAFE_componentWillUpdate</a></li>
|
||||||
<li><a href="./#optional-componentdidcatch">componentDidCatch</a></li>
|
<li><a href="./#componentdidcatch">componentDidCatch</a></li>
|
||||||
<li><a href="./#componentdidmount">componentDidMount</a></li>
|
<li><a href="./#componentdidmount">componentDidMount</a></li>
|
||||||
<li><a href="./#optional-componentdidupdate">componentDidUpdate</a></li>
|
<li><a href="./#componentdidupdate">componentDidUpdate</a></li>
|
||||||
<li><a href="./#optional-componentwillmount">componentWillMount</a></li>
|
<li><a href="./#componentwillmount">componentWillMount</a></li>
|
||||||
<li><a href="./#optional-componentwillreceiveprops">componentWillReceiveProps</a></li>
|
<li><a href="./#componentwillreceiveprops">componentWillReceiveProps</a></li>
|
||||||
<li><a href="./#optional-componentwillunmount">componentWillUnmount</a></li>
|
<li><a href="./#componentwillunmount">componentWillUnmount</a></li>
|
||||||
<li><a href="./#optional-componentwillupdate">componentWillUpdate</a></li>
|
<li><a href="./#componentwillupdate">componentWillUpdate</a></li>
|
||||||
<li><a href="./#forceupdate">forceUpdate</a></li>
|
<li><a href="./#forceupdate">forceUpdate</a></li>
|
||||||
<li><a href="./#formatoptionlabel">formatOptionLabel</a></li>
|
<li><a href="./#formatoptionlabel">formatOptionLabel</a></li>
|
||||||
<li><a href="./#optional-getsnapshotbeforeupdate">getSnapshotBeforeUpdate</a></li>
|
<li><a href="./#getsnapshotbeforeupdate">getSnapshotBeforeUpdate</a></li>
|
||||||
<li><a href="./#render">render</a></li>
|
<li><a href="./#render">render</a></li>
|
||||||
<li><a href="./#setstate">setState</a></li>
|
<li><a href="./#setstate">setState</a></li>
|
||||||
<li><a href="./#optional-shouldcomponentupdate">shouldComponentUpdate</a></li>
|
<li><a href="./#shouldcomponentupdate">shouldComponentUpdate</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
<p>+ <strong>new NamespaceSelect</strong>(<code>props</code>: Props): <em><a href="./">NamespaceSelect</a></em></p>
|
<p>• <strong>new NamespaceSelect</strong>(<code>props</code>)</p>
|
||||||
<p><em>Overrides <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#constructor">constructor</a></em></p>
|
<h4 id="parameters">Parameters<a class="headerlink" href="#parameters" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/+namespaces/namespace-select.tsx#L47">src/renderer/components/+namespaces/namespace-select.tsx:47</a></em></p>
|
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>props</code></td>
|
<td align="left"><code>props</code></td>
|
||||||
<td>Props</td>
|
<td align="left"><code>Props</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em><a href="./">NamespaceSelect</a></em></p>
|
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component<Props\>.constructor</p>
|
||||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||||
<h3 id="context">context<a class="headerlink" href="#context" title="Permanent link">#</a></h3>
|
<h3 id="context">context<a class="headerlink" href="#context" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>context</strong>: <em>any</em></p>
|
<p>• <strong>context</strong>: <code>any</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#context">context</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:473</p>
|
|
||||||
<p>If using the new style context, re-declare this in your class to be the
|
<p>If using the new style context, re-declare this in your class to be the
|
||||||
<code>React.ContextType</code> of your <code>static contextType</code>.
|
<code>React.ContextType</code> of your <code>static contextType</code>.
|
||||||
Should be used with type annotation or static contextType.</p>
|
Should be used with type annotation or static contextType.</p>
|
||||||
@ -962,32 +949,30 @@ Should be used with type annotation or static contextType.</p>
|
|||||||
<span class="kr">declare</span> <span class="nx">context</span>: <span class="kt">React.ContextType</span><span class="o"><</span><span class="k">typeof</span> <span class="nx">MyContext</span><span class="o">></span>
|
<span class="kr">declare</span> <span class="nx">context</span>: <span class="kt">React.ContextType</span><span class="o"><</span><span class="k">typeof</span> <span class="nx">MyContext</span><span class="o">></span>
|
||||||
</code></pre></div>
|
</code></pre></div>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html</p>
|
||||||
|
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.context</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="props">props<a class="headerlink" href="#props" title="Permanent link">#</a></h3>
|
<h3 id="props">props<a class="headerlink" href="#props" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>props</strong>: <em>Readonly‹Props› & Readonly‹object›</em></p>
|
<p>• <code>Readonly</code> <strong>props</strong>: <code>Readonly</code><Props> & <code>Readonly</code><<code>Object</code>></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#props">props</a></em></p>
|
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:498</p>
|
<p>React.Component.props</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="refs">refs<a class="headerlink" href="#refs" title="Permanent link">#</a></h3>
|
<h3 id="refs">refs<a class="headerlink" href="#refs" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>refs</strong>: <em>object</em></p>
|
<p>• <strong>refs</strong>: <code>Object</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#refs">refs</a></em></p>
|
<p><strong><code>deprecated</code></strong>
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:504</p>
|
|
||||||
<p><strong><code>deprecated</code></strong>
|
|
||||||
https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||||
<h4 id="type-declaration">Type declaration:<a class="headerlink" href="#type-declaration" title="Permanent link">#</a></h4>
|
<h4 id="index-signature">Index signature<a class="headerlink" href="#index-signature" title="Permanent link">#</a></h4>
|
||||||
<ul>
|
<p>▪ [key: <code>string</code>]: <code>ReactInstance</code></p>
|
||||||
<li>[ <strong>key</strong>: <em>string</em>]: ReactInstance</li>
|
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||||
</ul>
|
<p>React.Component.refs</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="state">state<a class="headerlink" href="#state" title="Permanent link">#</a></h3>
|
<h3 id="state">state<a class="headerlink" href="#state" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>state</strong>: <em>Readonly‹S›</em></p>
|
<p>• <strong>state</strong>: <code>Readonly</code><<code>Object</code>></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#state">state</a></em></p>
|
<h4 id="inherited-from_3">Inherited from<a class="headerlink" href="#inherited-from_3" title="Permanent link">#</a></h4>
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:499</p>
|
<p>React.Component.state</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="static-optional-contexttype"><code>Static</code> <code>Optional</code> contextType<a class="headerlink" href="#static-optional-contexttype" title="Permanent link">#</a></h3>
|
<h3 id="contexttype">contextType<a class="headerlink" href="#contexttype" title="Permanent link">#</a></h3>
|
||||||
<p>▪ <strong>contextType</strong>? : <em>Context‹any›</em></p>
|
<p>▪ <code>Static</code> <code>Optional</code> <strong>contextType</strong>: <code>Context</code><any></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#static-optional-contexttype">contextType</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:455</p>
|
|
||||||
<p>If set, <code>this.context</code> will be set at runtime to the current value of the given Context.</p>
|
<p>If set, <code>this.context</code> will be set at runtime to the current value of the given Context.</p>
|
||||||
<p>Usage:</p>
|
<p>Usage:</p>
|
||||||
<div class="highlight"><pre><span></span><code><span class="kd">type</span> <span class="nx">MyContext</span> <span class="o">=</span> <span class="kt">number</span>
|
<div class="highlight"><pre><span></span><code><span class="kd">type</span> <span class="nx">MyContext</span> <span class="o">=</span> <span class="kt">number</span>
|
||||||
@ -1002,20 +987,19 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
|||||||
<span class="p">}</span>
|
<span class="p">}</span>
|
||||||
</code></pre></div>
|
</code></pre></div>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html#classcontexttype</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||||
|
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.contextType</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="static-defaultprops"><code>Static</code> defaultProps<a class="headerlink" href="#static-defaultprops" title="Permanent link">#</a></h3>
|
<h3 id="defaultprops">defaultProps<a class="headerlink" href="#defaultprops" title="Permanent link">#</a></h3>
|
||||||
<p>▪ <strong>defaultProps</strong>: <em>object</em> = defaultProps as object</p>
|
<p>▪ <code>Static</code> <strong>defaultProps</strong>: <code>object</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/+namespaces/namespace-select.tsx#L47">src/renderer/components/+namespaces/namespace-select.tsx:47</a></em></p>
|
|
||||||
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
||||||
<h3 id="options">options<a class="headerlink" href="#options" title="Permanent link">#</a></h3>
|
<h3 id="options">options<a class="headerlink" href="#options" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>get options</strong>(): <em><a href="../../interfaces/_renderer_api_index_._renderer_api_components_.selectoption/">SelectOption</a>[]</em></p>
|
<p>• <code>get</code> <strong>options</strong>(): <a href="../../interfaces/renderer.component.selectoption/">SelectOption</a><any>[]</p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/+namespaces/namespace-select.tsx#L63">src/renderer/components/+namespaces/namespace-select.tsx:63</a></em></p>
|
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Returns:</strong> <em><a href="../../interfaces/_renderer_api_index_._renderer_api_components_.selectoption/">SelectOption</a>[]</em></p>
|
<p><a href="../../interfaces/renderer.component.selectoption/">SelectOption</a><any>[]</p>
|
||||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||||
<h3 id="optional-unsafe_componentwillmount"><code>Optional</code> UNSAFE_componentWillMount<a class="headerlink" href="#optional-unsafe_componentwillmount" title="Permanent link">#</a></h3>
|
<h3 id="unsafe_componentwillmount">UNSAFE_componentWillMount<a class="headerlink" href="#unsafe_componentwillmount" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>UNSAFE_componentWillMount</strong>(): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>UNSAFE_componentWillMount</strong>(): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-unsafe_componentwillmount">UNSAFE_componentWillMount</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:711</p>
|
|
||||||
<p>Called immediately before mounting occurs, and before <code>Component#render</code>.
|
<p>Called immediately before mounting occurs, and before <code>Component#render</code>.
|
||||||
Avoid introducing any side-effects or subscriptions in this method.</p>
|
Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||||
<p>This method will not stop working in React 17.</p>
|
<p>This method will not stop working in React 17.</p>
|
||||||
@ -1024,12 +1008,13 @@ prevents this from being invoked.</p>
|
|||||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead</p>
|
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.UNSAFE_componentWillMount</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-unsafe_componentwillreceiveprops"><code>Optional</code> UNSAFE_componentWillReceiveProps<a class="headerlink" href="#optional-unsafe_componentwillreceiveprops" title="Permanent link">#</a></h3>
|
<h3 id="unsafe_componentwillreceiveprops">UNSAFE_componentWillReceiveProps<a class="headerlink" href="#unsafe_componentwillreceiveprops" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>UNSAFE_componentWillReceiveProps</strong>(<code>nextProps</code>: Readonly‹Props›, <code>nextContext</code>: any): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>UNSAFE_componentWillReceiveProps</strong>(<code>nextProps</code>, <code>nextContext</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-unsafe_componentwillreceiveprops">UNSAFE_componentWillReceiveProps</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:743</p>
|
|
||||||
<p>Called when the component may be receiving new props.
|
<p>Called when the component may be receiving new props.
|
||||||
React may call this even if props have not changed, so be sure to compare new and existing
|
React may call this even if props have not changed, so be sure to compare new and existing
|
||||||
props if you only want to handle changes.</p>
|
props if you only want to handle changes.</p>
|
||||||
@ -1040,31 +1025,32 @@ prevents this from being invoked.</p>
|
|||||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead</p>
|
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextProps</code></td>
|
<td align="left"><code>nextProps</code></td>
|
||||||
<td>Readonly‹Props›</td>
|
<td align="left"><code>Readonly</code><Props></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextContext</code></td>
|
<td align="left"><code>nextContext</code></td>
|
||||||
<td>any</td>
|
<td align="left"><code>any</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.UNSAFE_componentWillReceiveProps</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-unsafe_componentwillupdate"><code>Optional</code> UNSAFE_componentWillUpdate<a class="headerlink" href="#optional-unsafe_componentwillupdate" title="Permanent link">#</a></h3>
|
<h3 id="unsafe_componentwillupdate">UNSAFE_componentWillUpdate<a class="headerlink" href="#unsafe_componentwillupdate" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>UNSAFE_componentWillUpdate</strong>(<code>nextProps</code>: Readonly‹Props›, <code>nextState</code>: Readonly‹S›, <code>nextContext</code>: any): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>UNSAFE_componentWillUpdate</strong>(<code>nextProps</code>, <code>nextState</code>, <code>nextContext</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-unsafe_componentwillupdate">UNSAFE_componentWillUpdate</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:771</p>
|
|
||||||
<p>Called immediately before rendering when new props or state is received. Not called for the initial render.</p>
|
<p>Called immediately before rendering when new props or state is received. Not called for the initial render.</p>
|
||||||
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
||||||
<p>This method will not stop working in React 17.</p>
|
<p>This method will not stop working in React 17.</p>
|
||||||
@ -1073,99 +1059,103 @@ prevents this from being invoked.</p>
|
|||||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead</p>
|
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextProps</code></td>
|
<td align="left"><code>nextProps</code></td>
|
||||||
<td>Readonly‹Props›</td>
|
<td align="left"><code>Readonly</code><Props></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextState</code></td>
|
<td align="left"><code>nextState</code></td>
|
||||||
<td>Readonly‹S›</td>
|
<td align="left"><code>Readonly</code><<code>Object</code>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextContext</code></td>
|
<td align="left"><code>nextContext</code></td>
|
||||||
<td>any</td>
|
<td align="left"><code>any</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.UNSAFE_componentWillUpdate</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-componentdidcatch"><code>Optional</code> componentDidCatch<a class="headerlink" href="#optional-componentdidcatch" title="Permanent link">#</a></h3>
|
<h3 id="componentdidcatch">componentDidCatch<a class="headerlink" href="#componentdidcatch" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>componentDidCatch</strong>(<code>error</code>: Error, <code>errorInfo</code>: ErrorInfo): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>componentDidCatch</strong>(<code>error</code>, <code>errorInfo</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-componentdidcatch">componentDidCatch</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:640</p>
|
|
||||||
<p>Catches exceptions generated in descendant components. Unhandled exceptions will cause
|
<p>Catches exceptions generated in descendant components. Unhandled exceptions will cause
|
||||||
the entire component tree to unmount.</p>
|
the entire component tree to unmount.</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>error</code></td>
|
<td align="left"><code>error</code></td>
|
||||||
<td>Error</td>
|
<td align="left"><code>Error</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>errorInfo</code></td>
|
<td align="left"><code>errorInfo</code></td>
|
||||||
<td>ErrorInfo</td>
|
<td align="left"><code>ErrorInfo</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.componentDidCatch</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="componentdidmount">componentDidMount<a class="headerlink" href="#componentdidmount" title="Permanent link">#</a></h3>
|
<h3 id="componentdidmount">componentDidMount<a class="headerlink" href="#componentdidmount" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>componentDidMount</strong>(): <em>void</em></p>
|
<p>▸ <strong>componentDidMount</strong>(): <code>void</code></p>
|
||||||
<p><em>Overrides <a href="../_renderer_api_index_._renderer_api_components_.wizardlayout/">WizardLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.wizardlayout/#optional-componentdidmount">componentDidMount</a></em></p>
|
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/+namespaces/namespace-select.tsx#L54">src/renderer/components/+namespaces/namespace-select.tsx:54</a></em></p>
|
<p><code>void</code></p>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.componentDidMount</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-componentdidupdate"><code>Optional</code> componentDidUpdate<a class="headerlink" href="#optional-componentdidupdate" title="Permanent link">#</a></h3>
|
<h3 id="componentdidupdate">componentDidUpdate<a class="headerlink" href="#componentdidupdate" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>componentDidUpdate</strong>(<code>prevProps</code>: Readonly‹Props›, <code>prevState</code>: Readonly‹S›, <code>snapshot?</code>: SS): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>componentDidUpdate</strong>(<code>prevProps</code>, <code>prevState</code>, <code>snapshot?</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-componentdidupdate">componentDidUpdate</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:682</p>
|
|
||||||
<p>Called immediately after updating occurs. Not called for the initial render.</p>
|
<p>Called immediately after updating occurs. Not called for the initial render.</p>
|
||||||
<p>The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.</p>
|
<p>The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>prevProps</code></td>
|
<td align="left"><code>prevProps</code></td>
|
||||||
<td>Readonly‹Props›</td>
|
<td align="left"><code>Readonly</code><Props></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>prevState</code></td>
|
<td align="left"><code>prevState</code></td>
|
||||||
<td>Readonly‹S›</td>
|
<td align="left"><code>Readonly</code><<code>Object</code>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>snapshot?</code></td>
|
<td align="left"><code>snapshot?</code></td>
|
||||||
<td>SS</td>
|
<td align="left"><code>any</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.componentDidUpdate</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-componentwillmount"><code>Optional</code> componentWillMount<a class="headerlink" href="#optional-componentwillmount" title="Permanent link">#</a></h3>
|
<h3 id="componentwillmount">componentWillMount<a class="headerlink" href="#componentwillmount" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>componentWillMount</strong>(): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>componentWillMount</strong>(): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-componentwillmount">componentWillMount</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:697</p>
|
|
||||||
<p>Called immediately before mounting occurs, and before <code>Component#render</code>.
|
<p>Called immediately before mounting occurs, and before <code>Component#render</code>.
|
||||||
Avoid introducing any side-effects or subscriptions in this method.</p>
|
Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||||
@ -1173,12 +1163,13 @@ prevents this from being invoked.</p>
|
|||||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.componentWillMount</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-componentwillreceiveprops"><code>Optional</code> componentWillReceiveProps<a class="headerlink" href="#optional-componentwillreceiveprops" title="Permanent link">#</a></h3>
|
<h3 id="componentwillreceiveprops">componentWillReceiveProps<a class="headerlink" href="#componentwillreceiveprops" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>componentWillReceiveProps</strong>(<code>nextProps</code>: Readonly‹Props›, <code>nextContext</code>: any): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>componentWillReceiveProps</strong>(<code>nextProps</code>, <code>nextContext</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-componentwillreceiveprops">componentWillReceiveProps</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:726</p>
|
|
||||||
<p>Called when the component may be receiving new props.
|
<p>Called when the component may be receiving new props.
|
||||||
React may call this even if props have not changed, so be sure to compare new and existing
|
React may call this even if props have not changed, so be sure to compare new and existing
|
||||||
props if you only want to handle changes.</p>
|
props if you only want to handle changes.</p>
|
||||||
@ -1188,39 +1179,41 @@ prevents this from being invoked.</p>
|
|||||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextProps</code></td>
|
<td align="left"><code>nextProps</code></td>
|
||||||
<td>Readonly‹Props›</td>
|
<td align="left"><code>Readonly</code><Props></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextContext</code></td>
|
<td align="left"><code>nextContext</code></td>
|
||||||
<td>any</td>
|
<td align="left"><code>any</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.componentWillReceiveProps</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-componentwillunmount"><code>Optional</code> componentWillUnmount<a class="headerlink" href="#optional-componentwillunmount" title="Permanent link">#</a></h3>
|
<h3 id="componentwillunmount">componentWillUnmount<a class="headerlink" href="#componentwillunmount" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>componentWillUnmount</strong>(): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>componentWillUnmount</strong>(): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.wizardlayout/">WizardLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.wizardlayout/#optional-componentwillunmount">componentWillUnmount</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:635</p>
|
|
||||||
<p>Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as
|
<p>Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as
|
||||||
cancelled network requests, or cleaning up any DOM elements created in <code>componentDidMount</code>.</p>
|
cancelled network requests, or cleaning up any DOM elements created in <code>componentDidMount</code>.</p>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.componentWillUnmount</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-componentwillupdate"><code>Optional</code> componentWillUpdate<a class="headerlink" href="#optional-componentwillupdate" title="Permanent link">#</a></h3>
|
<h3 id="componentwillupdate">componentWillUpdate<a class="headerlink" href="#componentwillupdate" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>componentWillUpdate</strong>(<code>nextProps</code>: Readonly‹Props›, <code>nextState</code>: Readonly‹S›, <code>nextContext</code>: any): <em>void</em></p>
|
<p>▸ <code>Optional</code> <strong>componentWillUpdate</strong>(<code>nextProps</code>, <code>nextState</code>, <code>nextContext</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-componentwillupdate">componentWillUpdate</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:756</p>
|
|
||||||
<p>Called immediately before rendering when new props or state is received. Not called for the initial render.</p>
|
<p>Called immediately before rendering when new props or state is received. Not called for the initial render.</p>
|
||||||
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
||||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||||
@ -1228,142 +1221,190 @@ prevents this from being invoked.</p>
|
|||||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</p>
|
||||||
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
<p><strong><code>see</code></strong> https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextProps</code></td>
|
<td align="left"><code>nextProps</code></td>
|
||||||
<td>Readonly‹Props›</td>
|
<td align="left"><code>Readonly</code><Props></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextState</code></td>
|
<td align="left"><code>nextState</code></td>
|
||||||
<td>Readonly‹S›</td>
|
<td align="left"><code>Readonly</code><<code>Object</code>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextContext</code></td>
|
<td align="left"><code>nextContext</code></td>
|
||||||
<td>any</td>
|
<td align="left"><code>any</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.componentWillUpdate</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="forceupdate">forceUpdate<a class="headerlink" href="#forceupdate" title="Permanent link">#</a></h3>
|
<h3 id="forceupdate">forceUpdate<a class="headerlink" href="#forceupdate" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>forceUpdate</strong>(<code>callback?</code>: function): <em>void</em></p>
|
<p>▸ <strong>forceUpdate</strong>(<code>callback?</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#forceupdate">forceUpdate</a></em></p>
|
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:490</p>
|
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<p>▪<code>Optional</code> <strong>callback</strong>: <em>function</em></p>
|
|
||||||
<p>▸ (): <em>void</em></p>
|
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="formatoptionlabel">formatOptionLabel<a class="headerlink" href="#formatoptionlabel" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>formatOptionLabel</strong>(<code>option</code>: <a href="../../interfaces/_renderer_api_index_._renderer_api_components_.selectoption/">SelectOption</a>): <em>object</em></p>
|
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/+namespaces/namespace-select.tsx#L80">src/renderer/components/+namespaces/namespace-select.tsx:80</a></em></p>
|
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>option</code></td>
|
<td align="left"><code>callback?</code></td>
|
||||||
<td><a href="../../interfaces/_renderer_api_index_._renderer_api_components_.selectoption/">SelectOption</a></td>
|
<td align="left">() => <code>void</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>object</em></p>
|
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.forceUpdate</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-getsnapshotbeforeupdate"><code>Optional</code> getSnapshotBeforeUpdate<a class="headerlink" href="#optional-getsnapshotbeforeupdate" title="Permanent link">#</a></h3>
|
<h3 id="formatoptionlabel">formatOptionLabel<a class="headerlink" href="#formatoptionlabel" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>getSnapshotBeforeUpdate</strong>(<code>prevProps</code>: Readonly‹Props›, <code>prevState</code>: Readonly‹S›): <em>SS | null</em></p>
|
<p>▸ <strong>formatOptionLabel</strong>(<code>option</code>): <code>Object</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-getsnapshotbeforeupdate">getSnapshotBeforeUpdate</a></em></p>
|
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:676</p>
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th align="left">Name</th>
|
||||||
|
<th align="left">Type</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>option</code></td>
|
||||||
|
<td align="left"><a href="../../interfaces/renderer.component.selectoption/">SelectOption</a><any></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Object</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getsnapshotbeforeupdate">getSnapshotBeforeUpdate<a class="headerlink" href="#getsnapshotbeforeupdate" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <code>Optional</code> <strong>getSnapshotBeforeUpdate</strong>(<code>prevProps</code>, <code>prevState</code>): <code>any</code></p>
|
||||||
<p>Runs before React applies the result of <code>render</code> to the document, and
|
<p>Runs before React applies the result of <code>render</code> to the document, and
|
||||||
returns an object to be given to componentDidUpdate. Useful for saving
|
returns an object to be given to componentDidUpdate. Useful for saving
|
||||||
things such as scroll position before <code>render</code> causes changes to it.</p>
|
things such as scroll position before <code>render</code> causes changes to it.</p>
|
||||||
<p>Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated
|
<p>Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated
|
||||||
lifecycle events from running.</p>
|
lifecycle events from running.</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>prevProps</code></td>
|
<td align="left"><code>prevProps</code></td>
|
||||||
<td>Readonly‹Props›</td>
|
<td align="left"><code>Readonly</code><Props></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>prevState</code></td>
|
<td align="left"><code>prevState</code></td>
|
||||||
<td>Readonly‹S›</td>
|
<td align="left"><code>Readonly</code><<code>Object</code>></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>SS | null</em></p>
|
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>any</code></p>
|
||||||
|
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.getSnapshotBeforeUpdate</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="render">render<a class="headerlink" href="#render" title="Permanent link">#</a></h3>
|
<h3 id="render">render<a class="headerlink" href="#render" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>render</strong>(): <em>Element‹›</em></p>
|
<p>▸ <strong>render</strong>(): <code>Element</code></p>
|
||||||
<p><em>Overrides void</em></p>
|
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/+namespaces/namespace-select.tsx#L92">src/renderer/components/+namespaces/namespace-select.tsx:92</a></em></p>
|
<p><code>Element</code></p>
|
||||||
<p><strong>Returns:</strong> <em>Element‹›</em></p>
|
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.render</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="setstate">setState<a class="headerlink" href="#setstate" title="Permanent link">#</a></h3>
|
<h3 id="setstate">setState<a class="headerlink" href="#setstate" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>setState</strong>‹<strong>K</strong>›(<code>state</code>: function | S | object, <code>callback?</code>: function): <em>void</em></p>
|
<p>▸ <strong>setState</strong><K>(<code>state</code>, <code>callback?</code>): <code>void</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#setstate">setState</a></em></p>
|
<h4 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h4>
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:485</p>
|
<table>
|
||||||
<p><strong>Type parameters:</strong></p>
|
<thead>
|
||||||
<p>▪ <strong>K</strong>: <em>keyof S</em></p>
|
<tr>
|
||||||
<p><strong>Parameters:</strong></p>
|
<th align="left">Name</th>
|
||||||
<p>▪ <strong>state</strong>: <em>function | S | object</em></p>
|
<th align="left">Type</th>
|
||||||
<p>▪<code>Optional</code> <strong>callback</strong>: <em>function</em></p>
|
</tr>
|
||||||
<p>▸ (): <em>void</em></p>
|
</thead>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>K</code></td>
|
||||||
|
<td align="left"><code>K</code>: <code>never</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" 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>state</code></td>
|
||||||
|
<td align="left">{} | (<code>prevState</code>: <code>Readonly</code><<code>Object</code>>, <code>props</code>: <code>Readonly</code><Props\>) => {} | <code>Pick</code><<code>Object</code>, K> | <code>Pick</code><<code>Object</code>, K></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>callback?</code></td>
|
||||||
|
<td align="left">() => <code>void</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.setState</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="optional-shouldcomponentupdate"><code>Optional</code> shouldComponentUpdate<a class="headerlink" href="#optional-shouldcomponentupdate" title="Permanent link">#</a></h3>
|
<h3 id="shouldcomponentupdate">shouldComponentUpdate<a class="headerlink" href="#shouldcomponentupdate" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>shouldComponentUpdate</strong>(<code>nextProps</code>: Readonly‹Props›, <code>nextState</code>: Readonly‹S›, <code>nextContext</code>: any): <em>boolean</em></p>
|
<p>▸ <code>Optional</code> <strong>shouldComponentUpdate</strong>(<code>nextProps</code>, <code>nextState</code>, <code>nextContext</code>): <code>boolean</code></p>
|
||||||
<p><em>Inherited from <a href="../_renderer_api_index_._renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_index_._renderer_api_components_.pagelayout/#optional-shouldcomponentupdate">shouldComponentUpdate</a></em></p>
|
|
||||||
<p>Defined in node_modules/@types/react/index.d.ts:630</p>
|
|
||||||
<p>Called to determine whether the change in props and state should trigger a re-render.</p>
|
<p>Called to determine whether the change in props and state should trigger a re-render.</p>
|
||||||
<p><code>Component</code> always returns true.
|
<p><code>Component</code> always returns true.
|
||||||
<code>PureComponent</code> implements a shallow comparison on props and state and returns true if any
|
<code>PureComponent</code> implements a shallow comparison on props and state and returns true if any
|
||||||
props or states have changed.</p>
|
props or states have changed.</p>
|
||||||
<p>If false is returned, <code>Component#render</code>, <code>componentWillUpdate</code>
|
<p>If false is returned, <code>Component#render</code>, <code>componentWillUpdate</code>
|
||||||
and <code>componentDidUpdate</code> will not be called.</p>
|
and <code>componentDidUpdate</code> will not be called.</p>
|
||||||
<p><strong>Parameters:</strong></p>
|
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextProps</code></td>
|
<td align="left"><code>nextProps</code></td>
|
||||||
<td>Readonly‹Props›</td>
|
<td align="left"><code>Readonly</code><Props></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextState</code></td>
|
<td align="left"><code>nextState</code></td>
|
||||||
<td>Readonly‹S›</td>
|
<td align="left"><code>Readonly</code><<code>Object</code>></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>nextContext</code></td>
|
<td align="left"><code>nextContext</code></td>
|
||||||
<td>any</td>
|
<td align="left"><code>any</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>boolean</em></p>
|
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>boolean</code></p>
|
||||||
|
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||||
|
<p>React.Component.shouldComponentUpdate</p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -9,7 +9,7 @@
|
|||||||
<meta name="description" content="Documentation for Lens Extension API.">
|
<meta name="description" content="Documentation for Lens Extension API.">
|
||||||
|
|
||||||
|
|
||||||
<link rel="canonical" href="https://api-docs.k8slens.dev/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.notificationsstore/">
|
<link rel="canonical" href="https://api-docs.k8slens.dev/master/extensions/api/classes/renderer.component.notificationsstore/">
|
||||||
|
|
||||||
|
|
||||||
<meta name="author" content="Mirantis, Inc.">
|
<meta name="author" content="Mirantis, Inc.">
|
||||||
@ -591,18 +591,11 @@
|
|||||||
<ul class="md-nav__list" data-md-scrollfix>
|
<ul class="md-nav__list" data-md-scrollfix>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#hierarchy" class="md-nav__link">
|
<a href="#table-of-contents" class="md-nav__link">
|
||||||
Hierarchy
|
Table of contents
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
<nav class="md-nav" aria-label="Table of contents">
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#index" class="md-nav__link">
|
|
||||||
Index
|
|
||||||
</a>
|
|
||||||
|
|
||||||
<nav class="md-nav" aria-label="Index">
|
|
||||||
<ul class="md-nav__list">
|
<ul class="md-nav__list">
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -660,8 +653,8 @@
|
|||||||
<ul class="md-nav__list">
|
<ul class="md-nav__list">
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#protected-autohidetimers" class="md-nav__link">
|
<a href="#autohidetimers" class="md-nav__link">
|
||||||
Protected autoHideTimers
|
autoHideTimers
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
@ -741,18 +734,15 @@
|
|||||||
|
|
||||||
|
|
||||||
<h1 id="class-notificationsstore">Class: NotificationsStore<a class="headerlink" href="#class-notificationsstore" title="Permanent link">#</a></h1>
|
<h1 id="class-notificationsstore">Class: NotificationsStore<a class="headerlink" href="#class-notificationsstore" title="Permanent link">#</a></h1>
|
||||||
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
|
<p><a href="../../modules/renderer/">Renderer</a>.<a href="../../modules/renderer.component/">Component</a>.NotificationsStore</p>
|
||||||
<ul>
|
<h2 id="table-of-contents">Table of contents<a class="headerlink" href="#table-of-contents" title="Permanent link">#</a></h2>
|
||||||
<li><strong>NotificationsStore</strong></li>
|
|
||||||
</ul>
|
|
||||||
<h2 id="index">Index<a class="headerlink" href="#index" title="Permanent link">#</a></h2>
|
|
||||||
<h3 id="constructors">Constructors<a class="headerlink" href="#constructors" title="Permanent link">#</a></h3>
|
<h3 id="constructors">Constructors<a class="headerlink" href="#constructors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="./#constructor">constructor</a></li>
|
<li><a href="./#constructor">constructor</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="properties">Properties<a class="headerlink" href="#properties" title="Permanent link">#</a></h3>
|
<h3 id="properties">Properties<a class="headerlink" href="#properties" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="./#protected-autohidetimers">autoHideTimers</a></li>
|
<li><a href="./#autohidetimers">autoHideTimers</a></li>
|
||||||
<li><a href="./#notifications">notifications</a></li>
|
<li><a href="./#notifications">notifications</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">#</a></h3>
|
<h3 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">#</a></h3>
|
||||||
@ -765,118 +755,116 @@
|
|||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
<p>+ <strong>new NotificationsStore</strong>(): <em><a href="./">NotificationsStore</a></em></p>
|
<p>• <strong>new NotificationsStore</strong>()</p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/notifications/notifications.store.tsx#L48">src/renderer/components/notifications/notifications.store.tsx:48</a></em></p>
|
|
||||||
<p><strong>Returns:</strong> <em><a href="./">NotificationsStore</a></em></p>
|
|
||||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||||
<h3 id="protected-autohidetimers"><code>Protected</code> autoHideTimers<a class="headerlink" href="#protected-autohidetimers" title="Permanent link">#</a></h3>
|
<h3 id="autohidetimers">autoHideTimers<a class="headerlink" href="#autohidetimers" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>autoHideTimers</strong>: <em>Map‹string | number, number›</em> = new Map<NotificationId, number>()</p>
|
<p>• <code>Protected</code> <strong>autoHideTimers</strong>: <code>Map</code><<a href="../../modules/renderer.component/#notificationid">NotificationId</a>, number></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/notifications/notifications.store.tsx#L48">src/renderer/components/notifications/notifications.store.tsx:48</a></em></p>
|
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="notifications">notifications<a class="headerlink" href="#notifications" title="Permanent link">#</a></h3>
|
<h3 id="notifications">notifications<a class="headerlink" href="#notifications" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>notifications</strong>: <em>IObservableArray‹<a href="../../interfaces/_renderer_api_index_._renderer_api_components_.notification/">Notification</a>›</em> = observable.array<Notification>([], { deep: false })</p>
|
<p>• <strong>notifications</strong>: <code>IObservableArray</code><<a href="../../interfaces/renderer.component.notification/">Notification</a>></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/notifications/notifications.store.tsx#L46">src/renderer/components/notifications/notifications.store.tsx:46</a></em></p>
|
|
||||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||||
<h3 id="add">add<a class="headerlink" href="#add" title="Permanent link">#</a></h3>
|
<h3 id="add">add<a class="headerlink" href="#add" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>add</strong>(<code>notification</code>: <a href="../../interfaces/_renderer_api_index_._renderer_api_components_.notification/">Notification</a>): <em>function</em></p>
|
<p>▸ <strong>add</strong>(<code>notification</code>): () => <code>void</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/notifications/notifications.store.tsx#L80">src/renderer/components/notifications/notifications.store.tsx:80</a></em></p>
|
<h4 id="parameters">Parameters<a class="headerlink" href="#parameters" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>notification</code></td>
|
<td align="left"><code>notification</code></td>
|
||||||
<td><a href="../../interfaces/_renderer_api_index_._renderer_api_components_.notification/">Notification</a></td>
|
<td align="left"><a href="../../interfaces/renderer.component.notification/">Notification</a></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>function</em></p>
|
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||||
<p>▸ (): <em>void</em></p>
|
<p><code>fn</code></p>
|
||||||
|
<p>▸ (): <code>void</code></p>
|
||||||
|
<h5 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h5>
|
||||||
|
<p><code>void</code></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="addautohidetimer">addAutoHideTimer<a class="headerlink" href="#addautohidetimer" title="Permanent link">#</a></h3>
|
<h3 id="addautohidetimer">addAutoHideTimer<a class="headerlink" href="#addautohidetimer" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>addAutoHideTimer</strong>(<code>id</code>: <a href="../../modules/_renderer_api_index_._renderer_api_components_/#notificationid">NotificationId</a>): <em>void</em></p>
|
<p>▸ <strong>addAutoHideTimer</strong>(<code>id</code>): <code>void</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/notifications/notifications.store.tsx#L59">src/renderer/components/notifications/notifications.store.tsx:59</a></em></p>
|
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>id</code></td>
|
<td align="left"><code>id</code></td>
|
||||||
<td><a href="../../modules/_renderer_api_index_._renderer_api_components_/#notificationid">NotificationId</a></td>
|
<td align="left"><a href="../../modules/renderer.component/#notificationid">NotificationId</a></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="getbyid">getById<a class="headerlink" href="#getbyid" title="Permanent link">#</a></h3>
|
<h3 id="getbyid">getById<a class="headerlink" href="#getbyid" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>getById</strong>(<code>id</code>: <a href="../../modules/_renderer_api_index_._renderer_api_components_/#notificationid">NotificationId</a>): <em><a href="../../interfaces/_renderer_api_index_._renderer_api_components_.notification/">Notification</a> | null</em></p>
|
<p>▸ <strong>getById</strong>(<code>id</code>): <a href="../../interfaces/renderer.component.notification/">Notification</a></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/notifications/notifications.store.tsx#L55">src/renderer/components/notifications/notifications.store.tsx:55</a></em></p>
|
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>id</code></td>
|
<td align="left"><code>id</code></td>
|
||||||
<td><a href="../../modules/_renderer_api_index_._renderer_api_components_/#notificationid">NotificationId</a></td>
|
<td align="left"><a href="../../modules/renderer.component/#notificationid">NotificationId</a></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em><a href="../../interfaces/_renderer_api_index_._renderer_api_components_.notification/">Notification</a> | null</em></p>
|
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../../interfaces/renderer.component.notification/">Notification</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="remove">remove<a class="headerlink" href="#remove" title="Permanent link">#</a></h3>
|
<h3 id="remove">remove<a class="headerlink" href="#remove" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>remove</strong>(<code>id</code>: <a href="../../modules/_renderer_api_index_._renderer_api_components_/#notificationid">NotificationId</a>): <em>void</em></p>
|
<p>▸ <strong>remove</strong>(<code>id</code>): <code>void</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/notifications/notifications.store.tsx#L97">src/renderer/components/notifications/notifications.store.tsx:97</a></em></p>
|
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>id</code></td>
|
<td align="left"><code>id</code></td>
|
||||||
<td><a href="../../modules/_renderer_api_index_._renderer_api_components_/#notificationid">NotificationId</a></td>
|
<td align="left"><a href="../../modules/renderer.component/#notificationid">NotificationId</a></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="removeautohidetimer">removeAutoHideTimer<a class="headerlink" href="#removeautohidetimer" title="Permanent link">#</a></h3>
|
<h3 id="removeautohidetimer">removeAutoHideTimer<a class="headerlink" href="#removeautohidetimer" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>removeAutoHideTimer</strong>(<code>id</code>: <a href="../../modules/_renderer_api_index_._renderer_api_components_/#notificationid">NotificationId</a>): <em>void</em></p>
|
<p>▸ <strong>removeAutoHideTimer</strong>(<code>id</code>): <code>void</code></p>
|
||||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6919aba37e/src/renderer/components/notifications/notifications.store.tsx#L72">src/renderer/components/notifications/notifications.store.tsx:72</a></em></p>
|
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||||
<p><strong>Parameters:</strong></p>
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th align="left">Name</th>
|
||||||
<th>Type</th>
|
<th align="left">Type</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>id</code></td>
|
<td align="left"><code>id</code></td>
|
||||||
<td><a href="../../modules/_renderer_api_index_._renderer_api_components_/#notificationid">NotificationId</a></td>
|
<td align="left"><a href="../../modules/renderer.component/#notificationid">NotificationId</a></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<p><strong>Returns:</strong> <em>void</em></p>
|
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user