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

Deployed 88edeeef43 to master with MkDocs 1.1.2 and mike 1.0.0

Browse Source
This commit is contained in:
GitHub Action committed 2021-05-27 13:17:14 +00:00
1 parent 961a8c40e4
commit ac6c34818d
293 files changed
+9990 -89083
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

master/extensions/api/classes/_renderer_api_navigation_.pageparam/index.html
+34 -266
View File
@@ -6,10 +6,10 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="description" content="Documentation for Lens IDE. The only system you’ll ever need to take control of your Kubernetes clusters. It's open source and free. Download it today!">
<meta name="description" content="Documentation for Lens Extension API.">
<link rel="canonical" href="https://docs.k8slens.dev/master/extensions/api/classes/_renderer_api_navigation_.pageparam/">
<link rel="canonical" href="https://api-docs.k8slens.dev/master/extensions/api/classes/_renderer_api_navigation_.pageparam/">
<meta name="author" content="Mirantis, Inc.">
@@ -19,7 +19,7 @@
<title>Class: PageParam ‹**V**› - Lens Documentation</title>
<title>Class: PageParam ‹**V**› - Lens Extension API</title>
@@ -85,7 +85,7 @@
<header class="md-header" data-md-component="header">
<nav class="md-header-nav md-grid" aria-label="Header">
<a href="https://docs.k8slens.dev/master" title="Lens Documentation" class="md-header-nav__button md-logo" aria-label="Lens Documentation">
<a href="https://api-docs.k8slens.dev/master" title="Lens Extension API" class="md-header-nav__button md-logo" aria-label="Lens Extension API">
<img src="../../../../img/lens-logo-icon.svg" alt="logo">
@@ -97,7 +97,7 @@
<div class="md-header-nav__ellipsis">
<div class="md-header-nav__topic">
<span class="md-ellipsis">
Lens Documentation
Lens Extension API
</span>
</div>
<div class="md-header-nav__topic">
@@ -193,12 +193,12 @@
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="https://docs.k8slens.dev/master" title="Lens Documentation" class="md-nav__button md-logo" aria-label="Lens Documentation">
<a href="https://api-docs.k8slens.dev/master" title="Lens Extension API" class="md-nav__button md-logo" aria-label="Lens Extension API">
<img src="../../../../img/lens-logo-icon.svg" alt="logo">
</a>
Lens Documentation
Lens Extension API
</label>
<div class="md-nav__source">
@@ -233,126 +233,16 @@
<li class="md-nav__item">
<a href="../../../../getting-started/" class="md-nav__link">
Getting Started
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-2" type="checkbox" id="nav-2">
<label class="md-nav__link" for="nav-3">
Managing Clusters
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Managing Clusters" data-md-level="1">
<label class="md-nav__title" for="nav-3">
<span class="md-nav__icon md-icon"></span>
Managing Clusters
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../../clusters/adding-clusters/" class="md-nav__link">
Adding Clusters
</a>
</li>
<li class="md-nav__item">
<a href="../../../../clusters/removing-clusters/" class="md-nav__link">
Removing Clusters
</a>
</li>
<li class="md-nav__item">
<a href="../../../../clusters/settings/" class="md-nav__link">
Settings
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../../../../helm/" class="md-nav__link">
Using Helm Charts
</a>
</li>
<li class="md-nav__item">
<a href="../../../usage/" class="md-nav__link">
Using Extensions
</a>
</li>
<li class="md-nav__item">
<a href="../../../../getting-started/preferences/" class="md-nav__link">
Preferences
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-7" type="checkbox" id="nav-7">
<label class="md-nav__link" for="nav-7">
<label class="md-nav__link" for="nav-2">
Extension Development
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Extension Development" data-md-level="1">
<label class="md-nav__title" for="nav-7">
<label class="md-nav__title" for="nav-2">
<span class="md-nav__icon md-icon"></span>
Extension Development
</label>
@@ -364,28 +254,16 @@
<li class="md-nav__item">
<a href="../../../" class="md-nav__link">
Overview
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-7-2" type="checkbox" id="nav-7-2">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-2-1" type="checkbox" id="nav-2-1">
<label class="md-nav__link" for="nav-7-2">
<label class="md-nav__link" for="nav-2-1">
Getting Started
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Getting Started" data-md-level="2">
<label class="md-nav__title" for="nav-7-2">
<label class="md-nav__title" for="nav-2-1">
<span class="md-nav__icon md-icon"></span>
Getting Started
</label>
@@ -452,14 +330,14 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-7-3" type="checkbox" id="nav-7-3">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-2-2" type="checkbox" id="nav-2-2">
<label class="md-nav__link" for="nav-7-3">
<label class="md-nav__link" for="nav-2-2">
Extension Capabilities
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Extension Capabilities" data-md-level="2">
<label class="md-nav__title" for="nav-7-3">
<label class="md-nav__title" for="nav-2-2">
<span class="md-nav__icon md-icon"></span>
Extension Capabilities
</label>
@@ -502,14 +380,14 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-7-4" type="checkbox" id="nav-7-4">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-2-3" type="checkbox" id="nav-2-3">
<label class="md-nav__link" for="nav-7-4">
<label class="md-nav__link" for="nav-2-3">
Extension Guides
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Extension Guides" data-md-level="2">
<label class="md-nav__title" for="nav-7-4">
<label class="md-nav__title" for="nav-2-3">
<span class="md-nav__icon md-icon"></span>
Extension Guides
</label>
@@ -624,14 +502,14 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-7-5" type="checkbox" id="nav-7-5">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-2-4" type="checkbox" id="nav-2-4">
<label class="md-nav__link" for="nav-7-5">
<label class="md-nav__link" for="nav-2-4">
Testing and Publishing
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Testing and Publishing" data-md-level="2">
<label class="md-nav__title" for="nav-7-5">
<label class="md-nav__title" for="nav-2-4">
<span class="md-nav__icon md-icon"></span>
Testing and Publishing
</label>
@@ -684,116 +562,6 @@
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-8" type="checkbox" id="nav-8">
<label class="md-nav__link" for="nav-8">
Contributing
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Contributing" data-md-level="1">
<label class="md-nav__title" for="nav-8">
<span class="md-nav__icon md-icon"></span>
Contributing
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../../contributing/" class="md-nav__link">
Overview
</a>
</li>
<li class="md-nav__item">
<a href="../../../../contributing/development/" class="md-nav__link">
Development
</a>
</li>
<li class="md-nav__item">
<a href="../../../../contributing/documentation/" class="md-nav__link">
Documentation
</a>
</li>
<li class="md-nav__item">
<a href="../../../../contributing/maintainers/" class="md-nav__link">
Maintainers
</a>
</li>
<li class="md-nav__item">
<a href="../../../../contributing/promotion/" class="md-nav__link">
Promotion
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../../../../support/" class="md-nav__link">
Support
</a>
</li>
<li class="md-nav__item">
<a href="../../../../faq/" class="md-nav__link">
FAQ
</a>
</li>
</ul>
</nav>
</div>
@@ -1062,7 +830,7 @@
<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 PageParam</strong>(<code>init</code>: <a href="../../interfaces/_renderer_api_navigation_.pageparaminit/">PageParamInit</a>‹V›, <code>history</code>: ObservableHistory): <em><a href="./">PageParam</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/navigation/page-param.ts#L37">src/renderer/navigation/page-param.ts:37</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/navigation/page-param.ts#L37">src/renderer/navigation/page-param.ts:37</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -1086,36 +854,36 @@
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
<h3 id="ismulti">isMulti<a class="headerlink" href="#ismulti" title="Permanent link">#</a></h3>
<p>• <strong>isMulti</strong>: <em>boolean</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/navigation/page-param.ts#L37">src/renderer/navigation/page-param.ts:37</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/navigation/page-param.ts#L37">src/renderer/navigation/page-param.ts:37</a></em></p>
<hr />
<h3 id="name">name<a class="headerlink" href="#name" title="Permanent link">#</a></h3>
<p>• <strong>name</strong>: <em>string</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/navigation/page-param.ts#L36">src/renderer/navigation/page-param.ts:36</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/navigation/page-param.ts#L36">src/renderer/navigation/page-param.ts:36</a></em></p>
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
<h3 id="defaultvalue">defaultValue<a class="headerlink" href="#defaultvalue" title="Permanent link">#</a></h3>
<p>• <strong>get defaultValue</strong>(): <em>V | undefined</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/navigation/page-param.ts#L48">src/renderer/navigation/page-param.ts:48</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/navigation/page-param.ts#L48">src/renderer/navigation/page-param.ts:48</a></em></p>
<p><strong>Returns:</strong> <em>V | undefined</em></p>
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
<h3 id="clear">clear<a class="headerlink" href="#clear" title="Permanent link">#</a></h3>
<p>▸ <strong>clear</strong>(): <em>void</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/navigation/page-param.ts#L112">src/renderer/navigation/page-param.ts:112</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/navigation/page-param.ts#L112">src/renderer/navigation/page-param.ts:112</a></em></p>
<p><strong>Returns:</strong> <em>void</em></p>
<hr />
<h3 id="get">get<a class="headerlink" href="#get" title="Permanent link">#</a></h3>
<p>▸ <strong>get</strong>(): <em>V</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/navigation/page-param.ts#L73">src/renderer/navigation/page-param.ts:73</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/navigation/page-param.ts#L73">src/renderer/navigation/page-param.ts:73</a></em></p>
<p><strong>Returns:</strong> <em>V</em></p>
<hr />
<h3 id="getraw">getRaw<a class="headerlink" href="#getraw" title="Permanent link">#</a></h3>
<p>▸ <strong>getRaw</strong>(): <em>string | string[]</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/navigation/page-param.ts#L105">src/renderer/navigation/page-param.ts:105</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/navigation/page-param.ts#L105">src/renderer/navigation/page-param.ts:105</a></em></p>
<p>Get stringified raw value(s) from <code>document.location.search</code></p>
<p><strong>Returns:</strong> <em>string | string[]</em></p>
<hr />
<h3 id="parse">parse<a class="headerlink" href="#parse" title="Permanent link">#</a></h3>
<p>▸ <strong>parse</strong>(<code>values</code>: string | string[]): <em>V</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/navigation/page-param.ts#L52">src/renderer/navigation/page-param.ts:52</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/navigation/page-param.ts#L52">src/renderer/navigation/page-param.ts:52</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -1135,7 +903,7 @@
<hr />
<h3 id="set">set<a class="headerlink" href="#set" title="Permanent link">#</a></h3>
<p>▸ <strong>set</strong>(<code>value</code>: V, <code>__namedParameters</code>: object): <em>void</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/navigation/page-param.ts#L78">src/renderer/navigation/page-param.ts:78</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/navigation/page-param.ts#L78">src/renderer/navigation/page-param.ts:78</a></em></p>
<p><strong>Parameters:</strong></p>
<p>▪ <strong>value</strong>: <em>V</em></p>
<p>▪<code>Default value</code> <strong>__namedParameters</strong>: <em>object</em>= {}</p>
@@ -1164,7 +932,7 @@
<hr />
<h3 id="setraw">setRaw<a class="headerlink" href="#setraw" title="Permanent link">#</a></h3>
<p>▸ <strong>setRaw</strong>(<code>value</code>: string | string[]): <em>void</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/navigation/page-param.ts#L89">src/renderer/navigation/page-param.ts:89</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/navigation/page-param.ts#L89">src/renderer/navigation/page-param.ts:89</a></em></p>
<p>Set stringified raw value(s) and update <code>document.location.search</code></p>
<p><strong>Parameters:</strong></p>
<table>
@@ -1187,7 +955,7 @@
<hr />
<h3 id="stringify">stringify<a class="headerlink" href="#stringify" title="Permanent link">#</a></h3>
<p>▸ <strong>stringify</strong>(<code>value</code>: V): <em>string[]</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/navigation/page-param.ts#L63">src/renderer/navigation/page-param.ts:63</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/navigation/page-param.ts#L63">src/renderer/navigation/page-param.ts:63</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -1209,7 +977,7 @@
<hr />
<h3 id="tostring">toString<a class="headerlink" href="#tostring" title="Permanent link">#</a></h3>
<p>▸ <strong>toString</strong>(<code>__namedParameters</code>: object): <em>string</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/navigation/page-param.ts#L116">src/renderer/navigation/page-param.ts:116</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/navigation/page-param.ts#L116">src/renderer/navigation/page-param.ts:116</a></em></p>
<p><strong>Parameters:</strong></p>
<p>▪<code>Default value</code> <strong>__namedParameters</strong>: <em>object</em>= {}</p>
<table>