Deployed 1db805b451 to master with MkDocs 1.2.3 and mike 1.1.2

master/extensions/api/classes/Main.Ipc/index.html

@@ -904,7 +904,7 @@
 <h3 id="ipcprefix">[IpcPrefix]<a class="headerlink" href="#ipcprefix" title="Permanent link">#</a></h3>
 <p>• <code>Readonly</code> <strong>[IpcPrefix]</strong>: <code>string</code></p>
 <h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
-<p>IpcRegistrar.__@IpcPrefix@44748</p>
+<p>IpcRegistrar.__@IpcPrefix@44753</p>
 <hr />
 <h3 id="extension">extension<a class="headerlink" href="#extension" title="Permanent link">#</a></h3>
 <p>• <code>Protected</code> <strong>extension</strong>: <code>LensExtension</code></p>

master/extensions/api/classes/Main.LensExtension/index.html

@@ -820,6 +820,13 @@
     protocolHandlers
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#traymenus" class="md-nav__link">
+    trayMenus
+  </a>
+  
 </li>
         
       </ul>
@@ -972,6 +979,7 @@
 <li><a href="./#manifest">manifest</a></li>
 <li><a href="./#manifestpath">manifestPath</a></li>
 <li><a href="./#protocolhandlers">protocolHandlers</a></li>
+<li><a href="./#traymenus">trayMenus</a></li>
 </ul>
 <h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
 <ul>
@@ -1015,7 +1023,7 @@
 <h3 id="disposers">[Disposers]<a class="headerlink" href="#disposers" title="Permanent link">#</a></h3>
 <p>• <strong>[Disposers]</strong>: <code>ExtendableDisposer</code></p>
 <h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
-<p>LensExtension.__@Disposers@30364</p>
+<p>LensExtension.__@Disposers@30369</p>
 <hr />
 <h3 id="appmenus">appMenus<a class="headerlink" href="#appmenus" title="Permanent link">#</a></h3>
 <p>• <strong>appMenus</strong>: <code>MenuRegistration</code>[] = <code>[]</code></p>
@@ -1044,6 +1052,9 @@
 <p>• <strong>protocolHandlers</strong>: <a href="../../interfaces/Common.Types.ProtocolHandlerRegistration/"><code>ProtocolHandlerRegistration</code></a>[] = <code>[]</code></p>
 <h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
 <p>LensExtension.protocolHandlers</p>
+<hr />
+<h3 id="traymenus">trayMenus<a class="headerlink" href="#traymenus" title="Permanent link">#</a></h3>
+<p>• <strong>trayMenus</strong>: <code>TrayMenuRegistration</code>[] = <code>[]</code></p>
 <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>
 <p>• <code>get</code> <strong>description</strong>(): <code>string</code></p>

master/extensions/api/classes/Renderer.Ipc/index.html

@@ -904,7 +904,7 @@
 <h3 id="ipcprefix">[IpcPrefix]<a class="headerlink" href="#ipcprefix" title="Permanent link">#</a></h3>
 <p>• <code>Readonly</code> <strong>[IpcPrefix]</strong>: <code>string</code></p>
 <h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
-<p>IpcRegistrar.__@IpcPrefix@44748</p>
+<p>IpcRegistrar.__@IpcPrefix@44753</p>
 <hr />
 <h3 id="extension">extension<a class="headerlink" href="#extension" title="Permanent link">#</a></h3>
 <p>• <code>Protected</code> <strong>extension</strong>: <code>LensExtension</code></p>

master/extensions/api/classes/Renderer.LensExtension/index.html

@@ -1135,7 +1135,7 @@
 <h3 id="disposers">[Disposers]<a class="headerlink" href="#disposers" title="Permanent link">#</a></h3>
 <p>• <strong>[Disposers]</strong>: <code>ExtendableDisposer</code></p>
 <h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
-<p>LensExtension.__@Disposers@30364</p>
+<p>LensExtension.__@Disposers@30369</p>
 <hr />
 <h3 id="apppreferences">appPreferences<a class="headerlink" href="#apppreferences" title="Permanent link">#</a></h3>
 <p>• <strong>appPreferences</strong>: <a href="../../interfaces/Common.Types.AppPreferenceRegistration/"><code>AppPreferenceRegistration</code></a>[] = <code>[]</code></p>

master/extensions/capabilities/common-capabilities/index.html

@@ -450,8 +450,8 @@
 </li>
         
           <li class="md-nav__item">
-  <a href="#app-menus" class="md-nav__link">
-    App Menus
+  <a href="#menus" class="md-nav__link">
+    Menus
   </a>
   
 </li>
@@ -872,8 +872,8 @@
 </li>
         
           <li class="md-nav__item">
-  <a href="#app-menus" class="md-nav__link">
-    App Menus
+  <a href="#menus" class="md-nav__link">
+    Menus
   </a>
   
 </li>
@@ -1007,8 +1007,8 @@ In order to see logs from this extension, you need to start Lens from the comman
   <span class="p">}</span>
 <span class="p">}</span>
 </code></pre></div>
-<h3 id="app-menus">App Menus<a class="headerlink" href="#app-menus" title="Permanent link">#</a></h3>
-<p>This extension can register custom app menus that will be displayed on OS native menus.</p>
+<h3 id="menus">Menus<a class="headerlink" href="#menus" title="Permanent link">#</a></h3>
+<p>This extension can register custom app and tray menus that will be displayed on OS native menus.</p>
 <p>Example:</p>
 <div class="highlight"><pre><span></span><code><span class="k">import</span> <span class="p">{</span> <span class="nx">Main</span> <span class="p">}</span> <span class="kr">from</span> <span class="s2">&quot;@k8slens/extensions&quot;</span>
 
@@ -1022,6 +1022,29 @@ In order to see logs from this extension, you need to start Lens from the comman
       <span class="p">}</span>
     <span class="p">}</span>
   <span class="p">]</span>
+
+  <span class="nx">trayMenus</span> <span class="o">=</span> <span class="p">[</span>
+    <span class="p">{</span>
+      <span class="nx">label</span><span class="o">:</span> <span class="s2">&quot;My links&quot;</span><span class="p">,</span>
+      <span class="nx">submenu</span><span class="o">:</span> <span class="p">[</span>
+        <span class="p">{</span>
+          <span class="nx">label</span><span class="o">:</span> <span class="s2">&quot;Lens&quot;</span><span class="p">,</span>
+          <span class="nx">click</span><span class="p">()</span> <span class="p">{</span>
+            <span class="nx">Main</span><span class="p">.</span><span class="nx">Navigation</span><span class="p">.</span><span class="nx">navigate</span><span class="p">(</span><span class="s2">&quot;https://k8slens.dev&quot;</span><span class="p">);</span>
+          <span class="p">}</span>
+        <span class="p">},</span>
+        <span class="p">{</span>
+          <span class="kr">type</span><span class="o">:</span> <span class="s2">&quot;separator&quot;</span>
+        <span class="p">},</span>
+        <span class="p">{</span>
+          <span class="nx">label</span><span class="o">:</span> <span class="s2">&quot;Lens Github&quot;</span><span class="p">,</span>
+          <span class="nx">click</span><span class="p">()</span> <span class="p">{</span>
+            <span class="nx">Main</span><span class="p">.</span><span class="nx">Navigation</span><span class="p">.</span><span class="nx">navigate</span><span class="p">(</span><span class="s2">&quot;https://github.com/lensapp/lens&quot;</span><span class="p">);</span>
+          <span class="p">}</span>
+        <span class="p">}</span>
+      <span class="p">]</span>
+    <span class="p">}</span>
+  <span class="p">]</span>
 <span class="p">}</span>
 </code></pre></div>
 <h2 id="renderer-extension">Renderer Extension<a class="headerlink" href="#renderer-extension" title="Permanent link">#</a></h2>

master/extensions/guides/main-extension/index.html

@@ -537,6 +537,13 @@
     appMenus
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#traymenus" class="md-nav__link">
+    trayMenus
+  </a>
+  
 </li>
         
           <li class="md-nav__item">
@@ -786,6 +793,13 @@
     appMenus
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#traymenus" class="md-nav__link">
+    trayMenus
+  </a>
+  
 </li>
         
           <li class="md-nav__item">
@@ -818,7 +832,7 @@
 <p>The Main Extension API is the interface to Lens's main process.
 Lens runs in both main and renderer processes.
 The Main Extension API allows you to access, configure, and customize Lens data, add custom application menu items and <a href="../protocol-handlers/">protocol handlers</a>, and run custom code in Lens's main process.
-It also provides convenient methods for navigating to built-in Lens pages and extension pages, as well as adding and removing sources of catalog entities. </p>
+It also provides convenient methods for navigating to built-in Lens pages and extension pages, as well as adding and removing sources of catalog entities.</p>
 <h2 id="mainlensextension-class"><code>Main.LensExtension</code> Class<a class="headerlink" href="#mainlensextension-class" title="Permanent link">#</a></h2>
 <h3 id="onactivate-and-ondeactivate-methods"><code>onActivate()</code> and <code>onDeactivate()</code> Methods<a class="headerlink" href="#onactivate-and-ondeactivate-methods" title="Permanent link">#</a></h3>
 <p>To create a main extension simply extend the <code>Main.LensExtension</code> class:</p>
@@ -850,7 +864,6 @@ Achieve this by starting Lens from the command prompt.</p>
 <p>For more details on accessing Lens state data, please see the <a href="../stores">Stores</a> guide.</p>
 <h3 id="appmenus"><code>appMenus</code><a class="headerlink" href="#appmenus" title="Permanent link">#</a></h3>
 <p>The Main Extension API allows you to customize the UI application menu.
-Note that this is the only UI feature that the Main Extension API allows you to customize.
 The following example demonstrates adding an item to the <strong>Help</strong> menu.</p>
 <div class="highlight"><pre><span></span><code><span class="k">import</span> <span class="p">{</span> <span class="nx">Main</span> <span class="p">}</span> <span class="kr">from</span> <span class="s2">&quot;@k8slens/extensions&quot;</span><span class="p">;</span>
 
@@ -867,7 +880,7 @@ The following example demonstrates adding an item to the <strong>Help</strong> m
 <span class="p">}</span>
 </code></pre></div>
 <p><code>appMenus</code> is an array of objects that satisfy the <code>MenuRegistration</code> interface.
-<code>MenuRegistration</code> extends React's <code>MenuItemConstructorOptions</code> interface.
+<code>MenuRegistration</code> extends Electron's <code>MenuItemConstructorOptions</code> interface.
 The properties of the appMenus array objects are defined as follows:</p>
 <ul>
 <li><code>parentId</code> is the name of the menu where your new menu item will be listed.
@@ -894,6 +907,28 @@ Note that pages are associated with the <a href="../renderer-extension/"><code>R
 </code></pre></div>
 <p>When the menu item is clicked the <code>navigate()</code> method looks for and displays a global page with id <code>"myGlobalPage"</code>.
 This page would be defined in your extension's <code>Renderer.LensExtension</code> implementation (See <a href="../renderer-extension/"><code>Renderer.LensExtension</code></a>).</p>
+<h3 id="traymenus"><code>trayMenus</code><a class="headerlink" href="#traymenus" title="Permanent link">#</a></h3>
+<p><code>trayMenus</code> is an array of <code>TrayMenuRegistration</code> objects. Most importantly you can define a <code>label</code> and a <code>click</code> handler. Other properties are <code>submenu</code>, <code>enabled</code>, <code>toolTip</code>, <code>id</code> and <code>type</code>.</p>
+<div class="highlight"><pre><span></span><code><span class="kd">interface</span> <span class="nx">TrayMenuRegistration</span> <span class="p">{</span>
+  <span class="nx">label?</span>: <span class="kt">string</span><span class="p">;</span>
+  <span class="nx">click</span><span class="o">?:</span> <span class="p">(</span><span class="nx">menuItem</span>: <span class="kt">TrayMenuRegistration</span><span class="p">)</span> <span class="p">=&gt;</span> <span class="ow">void</span><span class="p">;</span>
+  <span class="nx">id?</span>: <span class="kt">string</span><span class="p">;</span>
+  <span class="kr">type</span><span class="o">?:</span> <span class="s2">&quot;normal&quot;</span> <span class="o">|</span> <span class="s2">&quot;separator&quot;</span> <span class="o">|</span> <span class="s2">&quot;submenu&quot;</span>
+  <span class="nx">toolTip?</span>: <span class="kt">string</span><span class="p">;</span>
+  <span class="nx">enabled?</span>: <span class="kt">boolean</span><span class="p">;</span>
+  <span class="nx">submenu?</span>: <span class="kt">TrayMenuRegistration</span><span class="p">[]</span>
+<span class="p">}</span>
+</code></pre></div>
+<p>The following example demonstrates how tray menus can be added from extension:</p>
+<div class="highlight"><pre><span></span><code><span class="k">import</span> <span class="p">{</span> <span class="nx">Main</span> <span class="p">}</span> <span class="kr">from</span> <span class="s2">&quot;@k8slens/extensions&quot;</span><span class="p">;</span>
+
+<span class="k">export</span> <span class="k">default</span> <span class="kd">class</span> <span class="nx">SampleTrayMenuMainExtension</span> <span class="k">extends</span> <span class="nx">Main</span><span class="p">.</span><span class="nx">LensExtension</span> <span class="p">{</span>
+  <span class="nx">trayMenus</span> <span class="o">=</span> <span class="p">[{</span>
+    <span class="nx">label</span><span class="o">:</span> <span class="s2">&quot;menu from the extension&quot;</span><span class="p">,</span>
+    <span class="nx">click</span><span class="o">:</span> <span class="p">()</span> <span class="p">=&gt;</span> <span class="p">{</span> <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s2">&quot;tray menu clicked!&quot;</span><span class="p">)</span> <span class="p">}</span>
+  <span class="p">}]</span>
+<span class="p">}</span>
+</code></pre></div>
 <h3 id="addcatalogsource-and-removecatalogsource-methods"><code>addCatalogSource()</code> and <code>removeCatalogSource()</code> Methods<a class="headerlink" href="#addcatalogsource-and-removecatalogsource-methods" title="Permanent link">#</a></h3>
 <p>The <code>Main.LensExtension</code> class also provides the <code>addCatalogSource()</code> and <code>removeCatalogSource()</code> methods, for managing custom catalog items (or entities).
 See the <a href="../catalog/"><code>Catalog</code></a> documentation for full details about the catalog.</p>