mirror of
https://github.com/lensapp/lens.git
synced 2025-05-20 05:10:56 +00:00
Deployed 88edeeef43 to master with MkDocs 1.1.2 and mike 1.0.0
This commit is contained in:
1 parent
961a8c40e4
commit
ac6c34818d
293 files changed
+9990
-89083
No files matched your search
@@ -6,10 +6,10 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
|
||||
<meta name="description" content="Documentation for Lens IDE. The only system you’ll ever need to take control of your Kubernetes clusters. It's open source and free. Download it today!">
|
||||
<meta name="description" content="Documentation for Lens Extension API.">
|
||||
|
||||
|
||||
<link rel="canonical" href="https://docs.k8slens.dev/master/extensions/api/modules/_renderer_api_navigation_/">
|
||||
<link rel="canonical" href="https://api-docs.k8slens.dev/master/extensions/api/modules/_renderer_api_navigation_/">
|
||||
|
||||
|
||||
<meta name="author" content="Mirantis, Inc.">
|
||||
@@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
|
||||
<title>Module: "renderer-api/navigation" - Lens Documentation</title>
|
||||
<title>Module: "renderer-api/navigation" - 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>
|
||||
@@ -948,7 +716,7 @@
|
||||
<h2 id="functions_1">Functions<a class="headerlink" href="#functions_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="createpageparam">createPageParam<a class="headerlink" href="#createpageparam" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>createPageParam</strong>‹<strong>V</strong>›(<code>init</code>: <a href="../../interfaces/_renderer_api_navigation_.pageparaminit/">PageParamInit</a>‹V›): <em><a href="../../classes/_renderer_api_navigation_.pageparam/">PageParam</a>‹V›</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/extensions/renderer-api/navigation.ts#L29">src/extensions/renderer-api/navigation.ts:29</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/extensions/renderer-api/navigation.ts#L29">src/extensions/renderer-api/navigation.ts:29</a></em></p>
|
||||
<p><strong>Type parameters:</strong></p>
|
||||
<p>▪ <strong>V</strong></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
@@ -970,7 +738,7 @@
|
||||
<hr />
|
||||
<h3 id="getdetailsurl">getDetailsUrl<a class="headerlink" href="#getdetailsurl" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getDetailsUrl</strong>(<code>selfLink</code>: string, <code>resetSelected</code>: boolean, <code>mergeGlobals</code>: boolean): <em>string</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/kube-object/kube-object-details.tsx#L68">src/renderer/components/kube-object/kube-object-details.tsx:68</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/kube-object/kube-object-details.tsx#L68">src/renderer/components/kube-object/kube-object-details.tsx:68</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1002,12 +770,12 @@
|
||||
<hr />
|
||||
<h3 id="hidedetails">hideDetails<a class="headerlink" href="#hidedetails" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>hideDetails</strong>(): <em>void</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/kube-object/kube-object-details.tsx#L64">src/renderer/components/kube-object/kube-object-details.tsx:64</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/kube-object/kube-object-details.tsx#L64">src/renderer/components/kube-object/kube-object-details.tsx:64</a></em></p>
|
||||
<p><strong>Returns:</strong> <em>void</em></p>
|
||||
<hr />
|
||||
<h3 id="isactiveroute">isActiveRoute<a class="headerlink" href="#isactiveroute" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>isActiveRoute</strong>(<code>route</code>: string | string[] | RouteProps): <em>boolean</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/navigation/helpers.ts#L46">src/renderer/navigation/helpers.ts:46</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/navigation/helpers.ts#L46">src/renderer/navigation/helpers.ts:46</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1027,7 +795,7 @@
|
||||
<hr />
|
||||
<h3 id="navigate">navigate<a class="headerlink" href="#navigate" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>navigate</strong>(<code>location</code>: LocationDescriptor): <em>void</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/navigation/helpers.ts#L28">src/renderer/navigation/helpers.ts:28</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/navigation/helpers.ts#L28">src/renderer/navigation/helpers.ts:28</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1047,7 +815,7 @@
|
||||
<hr />
|
||||
<h3 id="showdetails">showDetails<a class="headerlink" href="#showdetails" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>showDetails</strong>(<code>selfLink</code>: string, <code>resetSelected</code>: boolean): <em>void</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/6cee819c8b/src/renderer/components/kube-object/kube-object-details.tsx#L58">src/renderer/components/kube-object/kube-object-details.tsx:58</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/88edeeef43/src/renderer/components/kube-object/kube-object-details.tsx#L58">src/renderer/components/kube-object/kube-object-details.tsx:58</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
Reference in new issue
Block a user