@nanoporetech-digital/components 4.1.0 → 4.3.0

package/dist/types/components/demo/demo.d.ts

@@ -2,5 +2,6 @@ import { ComponentInterface } from '../../stencil-public-runtime';
 export declare class Demo implements ComponentInterface {
   private order;
   private lineItemTotal;
+  private columns;
   render(): any;
 }

package/dist/types/components/details/details.d.ts

@@ -8,6 +8,7 @@ import type { Color } from '../../interface';
  * @slot icon-start - used for icons at the start of the handle
  * @slot label - can be used when you wish to insert complex label markup
  * @slot icon-end - used for icons at the end of the handle
+ *
  * @part button - the main details ui control
  * @part label - the text wrapper of the ui control
  * @part icon--start - the icon wrapper at the start of the ui control

package/dist/types/components/global-nav/global-nav.d.ts

@@ -15,6 +15,13 @@ import type { SearchIndex, AloliaSearchResultDetail, MyAccountUser, MyAccountDat
  * @slot promotion - a free area for any promotional content, displayed within the overflow menu panel
  * @slot logo - when show-logo="false" you can utilise the logo slot
  * @slot - if using search functionality, place a `<nano-search-results />` element in the default slot
+ *
+ * @part burger - the overflow / burger menu
+ * @part burger-actions-bar - the top bar of the overflow / burger menu
+ * @part burger-content - the main content area of the overflow / burger menu
+ * @part main-bar - the main nav menu bar
+ * @part logo-link - the link wrapping the logo
+ * @part search-bar - the search bar that appears under the main nav menu bar
  */
 export declare class GlobalNav implements ComponentInterface {
   private io;
@@ -177,6 +184,11 @@ export declare class GlobalNav implements ComponentInterface {
    * Submit the search form (a search value must be present)
    */
   submitSearch(): Promise<void>;
+  /**
+   * Manually open or close the overflow (burger) menu
+   * @param openClose - optionally force open (true) or close (false)
+   */
+  toggleOverflowMenu(openClose?: boolean): Promise<void>;
   getMyAccData(): Promise<void>;
   currentSelectedIndex(): SearchIndex;
   changeInternalSearchVal(): void;

package/dist/types/components/table/table-interface.d.ts

@@ -191,7 +191,7 @@ export declare namespace TableTypes {
    * Row renderer property. Called during the rendering of a tables head and foot
    * controlling their visual state.
    */
-  interface HeadFootRenderer {
+  interface HeadFootRenderer<T = RowData> {
     /** Function to decide whether the row is vertically pinned. Defaults to `start` for the header and `end` the footer */
     pinned: Position;
     /**
@@ -200,7 +200,7 @@ export declare namespace TableTypes {
      * If used, and you want to see the rendered row, you *must* nest it within your
      * jsx function e.g. `(h, props) => { return [props.renderedRow, <tr><td>Custom thing</td></tr>]}`
      **/
-    template?: RowTemplateFunc<VNode | VNode[], null>;
+    template?: RowTemplateFunc<VNode | VNode[], T>;
     /** A function which can be used to apply any html attribute/s onto a table row `tr` */
     rowProperties?: () => RowProps | void | undefined;
   }
@@ -211,6 +211,9 @@ export declare namespace TableTypes {
   class NanoTable<T = RowGeneric> {
     rows: T[];
     columns: ColumnConfig<T>[];
+    rowRender: RowRenderer<T>;
+    headRender: HeadFootRenderer<T>;
+    footRender: HeadFootRenderer<T>;
   }
   type Falsy = false | 0 | '' | null | undefined;
 }

package/dist/types/components/table/table.d.ts

@@ -40,7 +40,7 @@ export declare class Table implements ComponentInterface {
   rows: TableTypes.NanoTable['rows'] | Promise<TableTypes.NanoTable['rows']>;
   handleRowsChange(): void;
   /** The column config used to present the rows of data */
-  columns: TableTypes.NanoTable['columns'];
+  columns: TableTypes.NanoTable<any>['columns'];
   handleColsChange(): Promise<void>;
   /** Used for custom thead row rendering */
   headRender: TableTypes.HeadFootRenderer;

package/dist/types/components.d.ts

@@ -1078,6 +1078,11 @@ export namespace Components {
           * Submit the search form (a search value must be present)
          */
         "submitSearch": () => Promise<void>;
+        /**
+          * Manually open or close the overflow (burger) menu
+          * @param openClose - optionally force open (true) or close (false)
+         */
+        "toggleOverflowMenu": (openClose?: boolean) => Promise<void>;
     }
     /**
      * Nanopore digital global navigation user profile.
@@ -2264,7 +2269,7 @@ export namespace Components {
         /**
           * The column config used to present the rows of data
          */
-        "columns": TableTypes.NanoTable['columns'];
+        "columns": TableTypes.NanoTable<any>['columns'];
         /**
           * A custom filtering function. Should return a promise. If the promise resolves as `true` the column UI will be updated. If the promise resolves as falsey, the sort will be performed by the component. A good use-case would be performing the filter on a server / via fetch. Then on success, updating the table's data via the `rows` property
          */
@@ -5494,7 +5499,7 @@ declare namespace LocalJSX {
         /**
           * The column config used to present the rows of data
          */
-        "columns"?: TableTypes.NanoTable['columns'];
+        "columns"?: TableTypes.NanoTable<any>['columns'];
         /**
           * A custom filtering function. Should return a promise. If the promise resolves as `true` the column UI will be updated. If the promise resolves as falsey, the sort will be performed by the component. A good use-case would be performing the filter on a server / via fetch. Then on success, updating the table's data via the `rows` property
          */

package/docs-json.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2023-03-06T12:14:11",
+  "timestamp": "2023-03-08T17:53:37",
   "compiler": {
     "name": "@stencil/core",
     "version": "2.23.0",
@@ -2045,10 +2045,20 @@
           "annotation": "prop",
           "docs": "Initial Bg color of radio / checkbox controls. Changes for [checked] and [disabled] states. Defaults to #fff;"
         },
+        {
+          "name": "--check-border-color",
+          "annotation": "prop",
+          "docs": "initial border color. Defaults to #b5aea7;"
+        },
+        {
+          "name": "--check-border-size",
+          "annotation": "prop",
+          "docs": "initial border size. Default to 1px;"
+        },
         {
           "name": "--check-border-style",
           "annotation": "prop",
-          "docs": "Initial border style. Defaults to 1px solid #b5aea7;"
+          "docs": "Initial border style. Defaults to var(--check-border-size) solid var(--check-border-color);"
         },
         {
           "name": "--check-checked-bg-color",
@@ -6413,6 +6423,30 @@
         {
           "name": "slot",
           "text": "- if using search functionality, place a `<nano-search-results />` element in the default slot"
+        },
+        {
+          "name": "part",
+          "text": "burger - the overflow / burger menu"
+        },
+        {
+          "name": "part",
+          "text": "burger-actions-bar - the top bar of the overflow / burger menu"
+        },
+        {
+          "name": "part",
+          "text": "burger-content - the main content area of the overflow / burger menu"
+        },
+        {
+          "name": "part",
+          "text": "main-bar - the main nav menu bar"
+        },
+        {
+          "name": "part",
+          "text": "logo-link - the link wrapping the logo"
+        },
+        {
+          "name": "part",
+          "text": "search-bar - the search bar that appears under the main nav menu bar"
         }
       ],
       "usage": {},
@@ -6806,6 +6840,22 @@
           "parameters": [],
           "docs": "Submit the search form (a search value must be present)",
           "docsTags": []
+        },
+        {
+          "name": "toggleOverflowMenu",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "signature": "toggleOverflowMenu(openClose?: boolean) => Promise<void>",
+          "parameters": [],
+          "docs": "Manually open or close the overflow (burger) menu",
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "openClose - optionally force open (true) or close (false)"
+            }
+          ]
         }
       ],
       "events": [
@@ -7008,7 +7058,32 @@
           "docs": "nano-nav-item's to display with site links that come from MyAccount"
         }
       ],
-      "parts": [],
+      "parts": [
+        {
+          "name": "burger",
+          "docs": "the overflow / burger menu"
+        },
+        {
+          "name": "burger-actions-bar",
+          "docs": "the top bar of the overflow / burger menu"
+        },
+        {
+          "name": "burger-content",
+          "docs": "the main content area of the overflow / burger menu"
+        },
+        {
+          "name": "logo-link",
+          "docs": "the link wrapping the logo"
+        },
+        {
+          "name": "main-bar",
+          "docs": "the main nav menu bar"
+        },
+        {
+          "name": "search-bar",
+          "docs": "the search bar that appears under the main nav menu bar"
+        }
+      ],
       "dependents": [],
       "dependencies": [
         "nano-select",
@@ -10959,49 +11034,49 @@
       "listeners": [],
       "styles": [
         {
-          "name": "--fade-size. The size of the fade areas (when items do not fit). Defaults to 1.75rem;",
+          "name": "--fade-size",
           "annotation": "prop",
-          "docs": ""
+          "docs": "The size of the fade areas (when items do not fit). Defaults to 1.75rem;"
         },
         {
-          "name": "--fade-transparency. Defaults to 0;",
+          "name": "--fade-transparency",
           "annotation": "prop",
-          "docs": ""
+          "docs": "Defaults to 0;"
         },
         {
-          "name": "--indicator-color. Defaults to #90c6e7;",
+          "name": "--indicator-color",
           "annotation": "prop",
-          "docs": ""
+          "docs": "Defaults to #90c6e7;"
         },
         {
-          "name": "--indicator-size. Defaults to 0;",
+          "name": "--indicator-size",
           "annotation": "prop",
-          "docs": ""
+          "docs": "Defaults to 0;"
         },
         {
-          "name": "--indicator-track-color. Defaults to #e4e6e8;",
+          "name": "--indicator-track-color",
           "annotation": "prop",
-          "docs": ""
+          "docs": "Defaults to #e4e6e8;"
         },
         {
-          "name": "--indicator-track-size. Defaults to var(--indicator-size);",
+          "name": "--indicator-track-size",
           "annotation": "prop",
-          "docs": ""
+          "docs": "Defaults to var(--indicator-size);"
         },
         {
-          "name": "--indicator-transition. Defaults to var(--nano-transition-fast, 0.3s)",
+          "name": "--indicator-transition",
           "annotation": "prop",
-          "docs": ""
+          "docs": "Defaults to var(--nano-transition-fast, 0.3s)"
         },
         {
-          "name": "--padding. Padding that matches the fade size will stop items shifting if fade areas are added (i.e when items do not fit). Defaults to var(--fade-size);",
+          "name": "--padding",
           "annotation": "prop",
-          "docs": ""
+          "docs": "Padding that matches the fade size will stop items shifting if fade areas are added (i.e when items do not fit). Defaults to var(--fade-size);"
         },
         {
-          "name": "--scroll-btn-color. Defaults to 'currentColor';",
+          "name": "--scroll-btn-color",
           "annotation": "prop",
-          "docs": ""
+          "docs": "Defaults to 'currentColor';"
         }
       ],
       "slots": [
@@ -15125,7 +15200,7 @@
         },
         {
           "name": "columns",
-          "type": "ColumnConfig<RowGeneric>[]",
+          "type": "ColumnConfig<any>[]",
           "mutable": true,
           "reflectToAttr": false,
           "docs": "The column config used to present the rows of data",
@@ -15133,7 +15208,7 @@
           "default": "[]",
           "values": [
             {
-              "type": "ColumnConfig<RowGeneric>[]"
+              "type": "ColumnConfig<any>[]"
             }
           ],
           "optional": false,
@@ -15221,7 +15296,7 @@
         },
         {
           "name": "footRender",
-          "type": "HeadFootRenderer",
+          "type": "HeadFootRenderer<RowData<RowGeneric>>",
           "mutable": false,
           "reflectToAttr": false,
           "docs": "Used for custom tfoot row rendering",
@@ -15229,7 +15304,7 @@
           "default": "{ pinned: 'bottom' }",
           "values": [
             {
-              "type": "HeadFootRenderer"
+              "type": "HeadFootRenderer<RowData<RowGeneric>>"
             }
           ],
           "optional": false,
@@ -15239,7 +15314,7 @@
         },
         {
           "name": "headRender",
-          "type": "HeadFootRenderer",
+          "type": "HeadFootRenderer<RowData<RowGeneric>>",
           "mutable": false,
           "reflectToAttr": false,
           "docs": "Used for custom thead row rendering",
@@ -15247,7 +15322,7 @@
           "default": "{ pinned: 'top' }",
           "values": [
             {
-              "type": "HeadFootRenderer"
+              "type": "HeadFootRenderer<RowData<RowGeneric>>"
             }
           ],
           "optional": false,