Deployed a980db0e08 to v4.2.4 with MkDocs 1.2 and mike 1.0.1

This commit is contained in:
GitHub Action committed 2021-06-09 13:45:19 +00:00
1 parent 2b56886258
commit 52fb60edc7
530 files changed
+16329 -101272

No files matched your search

@@ -6,7 +6,7 @@
<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 Development and API.">
<link rel="canonical" href="https://api-docs.k8slens.dev/v4.2.4/extensions/api/modules/_renderer_api_navigation_/">
@@ -15,11 +15,11 @@
<meta name="author" content="Mirantis, Inc.">
<link rel="shortcut icon" href="../../../../img/favicon.ico">
<meta name="generator" content="mkdocs-1.1.2, mkdocs-material-6.1.0+insiders-1.7.0">
<meta name="generator" content="mkdocs-1.2, mkdocs-material-6.1.0+insiders-1.7.0">
<title>Module: "renderer-api/navigation" - Lens Documentation</title>
<title>Module: "renderer-api/navigation" - Lens Extension Development</title>
@@ -64,7 +64,7 @@
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="" data-md-color-accent="">
<body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="" data-md-color-accent="">
<script>var palette=JSON.parse(localStorage.getItem("__palette")||"{}");if(void 0!==palette.color)for(var key in palette.color)document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
@@ -88,7 +88,7 @@
<header class="md-header" data-md-component="header">
<nav class="md-header-nav md-grid" aria-label="Header">
<a href="https://api-docs.k8slens.dev/v4.2.4" title="Lens Documentation" class="md-header-nav__button md-logo" aria-label="Lens Documentation">
<a href="https://api-docs.k8slens.dev/v4.2.4" title="Lens Extension Development" class="md-header-nav__button md-logo" aria-label="Lens Extension Development">
<img src="../../../../img/lens-logo-icon.svg" alt="logo">
@@ -100,7 +100,7 @@
<div class="md-header-nav__ellipsis">
<div class="md-header-nav__topic">
<span class="md-ellipsis">
Lens Documentation
Lens Extension Development
</span>
</div>
<div class="md-header-nav__topic">
@@ -118,15 +118,15 @@
<button class="md-header-nav__button md-icon" title="Switch to light mode" aria-label="Switch to light mode" data-md-option="palette" data-md-color-scheme="default" data-md-color-primary="" data-md-color-accent="" data-md-state="hidden">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 7H7a5 5 0 00-5 5 5 5 0 005 5h10a5 5 0 005-5 5 5 0 00-5-5m0 8a3 3 0 01-3-3 3 3 0 013-3 3 3 0 013 3 3 3 0 01-3 3z"/></svg>
<button class="md-header-nav__button md-icon" title="Switch to dark mode" aria-label="Switch to dark mode" data-md-option="palette" data-md-color-scheme="slate" data-md-color-primary="" data-md-color-accent="" data-md-state="hidden">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7 10a2 2 0 012 2 2 2 0 01-2 2 2 2 0 01-2-2 2 2 0 012-2m10-3a5 5 0 015 5 5 5 0 01-5 5H7a5 5 0 01-5-5 5 5 0 015-5h10M7 9a3 3 0 00-3 3 3 3 0 003 3h10a3 3 0 003-3 3 3 0 00-3-3H7z"/></svg>
</button>
<button class="md-header-nav__button md-icon" title="Switch to dark mode" aria-label="Switch to dark mode" data-md-option="palette" data-md-color-scheme="slate" data-md-color-primary="" data-md-color-accent="" data-md-state="hidden">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7 10a2 2 0 012 2 2 2 0 01-2 2 2 2 0 01-2-2 2 2 0 012-2m10-3a5 5 0 015 5 5 5 0 01-5 5H7a5 5 0 01-5-5 5 5 0 015-5h10M7 9a3 3 0 00-3 3 3 3 0 003 3h10a3 3 0 003-3 3 3 0 00-3-3H7z"/></svg>
<button class="md-header-nav__button md-icon" title="Switch to light mode" aria-label="Switch to light mode" data-md-option="palette" data-md-color-scheme="default" data-md-color-primary="" data-md-color-accent="" data-md-state="hidden">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 7H7a5 5 0 00-5 5 5 5 0 005 5h10a5 5 0 005-5 5 5 0 00-5-5m0 8a3 3 0 01-3-3 3 3 0 013-3 3 3 0 013 3 3 3 0 01-3 3z"/></svg>
</button>
@@ -196,12 +196,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://api-docs.k8slens.dev/v4.2.4" title="Lens Documentation" class="md-nav__button md-logo" aria-label="Lens Documentation">
<a href="https://api-docs.k8slens.dev/v4.2.4" title="Lens Extension Development" class="md-nav__button md-logo" aria-label="Lens Extension Development">
<img src="../../../../img/lens-logo-icon.svg" alt="logo">
</a>
Lens Documentation
Lens Extension Development
</label>
<div class="md-nav__source">
@@ -236,159 +236,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">
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">
<span class="md-nav__icon md-icon"></span>
Extension Development
</label>
<ul class="md-nav__list" data-md-scrollfix>
<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">
<label class="md-nav__link" for="nav-7-2">
<label class="md-nav__link" for="nav-2">
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">
<nav class="md-nav" aria-label="Getting Started" data-md-level="1">
<label class="md-nav__title" for="nav-2">
<span class="md-nav__icon md-icon"></span>
Getting Started
</label>
@@ -447,22 +304,22 @@
</nav>
</li>
<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-3" type="checkbox" id="nav-3">
<label class="md-nav__link" for="nav-7-3">
<label class="md-nav__link" for="nav-3">
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">
<nav class="md-nav" aria-label="Extension Capabilities" data-md-level="1">
<label class="md-nav__title" for="nav-3">
<span class="md-nav__icon md-icon"></span>
Extension Capabilities
</label>
@@ -493,38 +350,26 @@
</li>
<li class="md-nav__item">
<a href="../../../capabilities/color-reference/" class="md-nav__link">
Color Reference
</a>
</li>
</ul>
</nav>
</li>
<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-4" type="checkbox" id="nav-4">
<label class="md-nav__link" for="nav-7-4">
<label class="md-nav__link" for="nav-4">
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">
<nav class="md-nav" aria-label="Extension Guides" data-md-level="1">
<label class="md-nav__title" for="nav-4">
<span class="md-nav__icon md-icon"></span>
Extension Guides
</label>
@@ -603,38 +448,26 @@
</li>
<li class="md-nav__item">
<a href="../../../guides/protocol-handlers/" class="md-nav__link">
Protocol Handlers
</a>
</li>
</ul>
</nav>
</li>
<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-5" type="checkbox" id="nav-5">
<label class="md-nav__link" for="nav-7-5">
<label class="md-nav__link" for="nav-5">
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">
<nav class="md-nav" aria-label="Testing and Publishing" data-md-level="1">
<label class="md-nav__title" for="nav-5">
<span class="md-nav__icon md-icon"></span>
Testing and Publishing
</label>
@@ -669,10 +502,10 @@
</nav>
</li>
<li class="md-nav__item">
@@ -681,121 +514,6 @@
</a>
</li>
</ul>
</nav>
</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>
@@ -951,7 +669,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/a980db0e0/src/extensions/renderer-api/navigation.ts#L10">src/extensions/renderer-api/navigation.ts:10</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/a980db0e08/src/extensions/renderer-api/navigation.ts#L10">src/extensions/renderer-api/navigation.ts:10</a></em></p>
<p><strong>Type parameters:</strong></p>
<p>▪ <strong>V</strong></p>
<p><strong>Parameters:</strong></p>
@@ -973,7 +691,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/a980db0e0/src/renderer/components/kube-object/kube-object-details.tsx#L49">src/renderer/components/kube-object/kube-object-details.tsx:49</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/a980db0e08/src/renderer/components/kube-object/kube-object-details.tsx#L49">src/renderer/components/kube-object/kube-object-details.tsx:49</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -1005,12 +723,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/a980db0e0/src/renderer/components/kube-object/kube-object-details.tsx#L45">src/renderer/components/kube-object/kube-object-details.tsx:45</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/a980db0e08/src/renderer/components/kube-object/kube-object-details.tsx#L45">src/renderer/components/kube-object/kube-object-details.tsx:45</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/a980db0e0/src/renderer/navigation/helpers.ts#L25">src/renderer/navigation/helpers.ts:25</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/a980db0e08/src/renderer/navigation/helpers.ts#L25">src/renderer/navigation/helpers.ts:25</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -1030,7 +748,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/a980db0e0/src/renderer/navigation/helpers.ts#L7">src/renderer/navigation/helpers.ts:7</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/a980db0e08/src/renderer/navigation/helpers.ts#L7">src/renderer/navigation/helpers.ts:7</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -1050,7 +768,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/a980db0e0/src/renderer/components/kube-object/kube-object-details.tsx#L39">src/renderer/components/kube-object/kube-object-details.tsx:39</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/a980db0e08/src/renderer/components/kube-object/kube-object-details.tsx#L39">src/renderer/components/kube-object/kube-object-details.tsx:39</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -1150,4 +868,4 @@
</body>
</html>
</html>