@nanoporetech-digital/components 5.1.2 → 5.2.0

package/dist/types/utils/events.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Add multiple event listeners with the same callback function
+ * @param el the element which emits events
+ * @param events the event names to listen to (string separated by a space)
+ * @param fn the function to call
+ * @param opts the event options to apply
+ */
+export declare function addListeners(el: Element | Document, events: string, fn: (e: Event) => void, opts?: AddEventListenerOptions): void;
+/**
+ * Remove multiple event listeners with the same callback function
+ * @param el the element which emits events
+ * @param events the event names to listen to (string separated by a space)
+ * @param fn the function to call
+ */
+export declare function removeListeners(el: Element | Document, events: string, fn: (e: Event) => void): void;

package/dist/types/utils/throttle.d.ts

@@ -14,4 +14,4 @@ export declare const debounce: (callback: (...args: any[]) => void, wait?: numbe
  * @param delay how long to delay before calling the function
  * @returns a throttled function to call as often as required
  */
-export declare function throttle(callback: (...args: [any]) => void, delay: number): (...args: any[]) => void;
+export declare const throttle: (callback: any, delay: any) => (...args: any[]) => any;

package/docs-json.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2023-07-13T01:03:55",
+  "timestamp": "2023-08-02T13:24:31",
   "compiler": {
     "name": "@stencil/core",
     "version": "2.23.0",
@@ -12284,6 +12284,15 @@
       ],
       "methods": [],
       "events": [
+        {
+          "event": "nanoResize",
+          "detail": "ResizeObserverEntry[]",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Fires after any resizing",
+          "docsTags": []
+        },
         {
           "event": "nanoResizeContentFitChange",
           "detail": "{ x: boolean; y: boolean; }",
@@ -15046,13 +15055,16 @@
         },
         {
           "name": "stickTo",
-          "type": "string",
+          "type": "HTMLNanoStickerElement | string",
           "mutable": false,
           "attr": "stick-to",
           "reflectToAttr": false,
-          "docs": "Upon being stuck, attach the sticker to another sticker element.\nA JS query selector that returns a <nano-sticker>",
+          "docs": "Upon being stuck, attach the sticker to another sticker element.\nJS query selector string or DOM element pointing to a `<nano-sticker>`",
           "docsTags": [],
           "values": [
+            {
+              "type": "HTMLNanoStickerElement"
+            },
             {
               "type": "string"
             }
@@ -15950,6 +15962,29 @@
       ],
       "usage": {},
       "props": [
+        {
+          "name": "appliedFilters",
+          "type": "Filter[]",
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [
+            {
+              "name": "readonly",
+              "text": "- shows the currently applied filters"
+            }
+          ],
+          "default": "[]",
+          "values": [
+            {
+              "type": "Filter[]"
+            }
+          ],
+          "optional": false,
+          "required": false,
+          "getter": true,
+          "setter": false
+        },
         {
           "name": "blocksLength",
           "type": "number",
@@ -16009,7 +16044,7 @@
           "type": "(filters: Filter[]) => Promise<true | Falsy>",
           "mutable": false,
           "reflectToAttr": false,
-          "docs": "A custom filtering function. Should return a promise.\nIf the promise resolves as `true` the column UI will be updated.\nIf the promise resolves as falsey, the sort will be performed by the component.\nA good use-case would be performing the filter on a server / via fetch.\nThen on success, updating the table's data via the `rows` property",
+          "docs": "A custom filtering function. Should return a promise.\nIf the promise resolves as `true` the column UI will be updated.\nIf the promise resolves as falsy, the sort will be performed by the component.\nA good use-case would be performing the filter on a server / via fetch.\nThen on success, updating the table's data via the `rows` property",
           "docsTags": [],
           "values": [
             {
@@ -16024,6 +16059,23 @@
           "getter": false,
           "setter": false
         },
+        {
+          "name": "customRenderer",
+          "type": "(node: any, cell: HTMLElement) => void",
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "Function called whenever `col.cellTemplate` renders an unknown object.\nThe function should render a valid HTMLElement to the cell arg.\nExample usage - render JSX from a 3rd party lib and append the result to the cell element.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "(node: any, cell: HTMLElement) => void"
+            }
+          ],
+          "optional": false,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
         {
           "name": "customSortFn",
           "type": "(property: keyof RowGeneric, order: Order) => Promise<true | Falsy>",
@@ -16099,30 +16151,13 @@
           "getter": false,
           "setter": false
         },
-        {
-          "name": "jsxRenderer",
-          "type": "HFunc<any>",
-          "mutable": false,
-          "reflectToAttr": false,
-          "docs": "",
-          "docsTags": [],
-          "values": [
-            {
-              "type": "HFunc<any>"
-            }
-          ],
-          "optional": false,
-          "required": false,
-          "getter": false,
-          "setter": false
-        },
         {
           "name": "loading",
           "type": "boolean",
           "mutable": false,
           "attr": "loading",
           "reflectToAttr": false,
-          "docs": "Will show a loading state when set to true.\nBy default, will be shown automatically if `rows` is a promise waiting to resolve\nor when performing custom filtering or sorting.\n*Note* when set manually, will overwrite any internal loading state.\nSet to 'undefined' to revert to default behaviour.",
+          "docs": "Will show a loading state when set to true.\nBy default, will be shown automatically if `rows` is a promise waiting to resolve / or falsy\n*or* when performing custom filtering or sorting.\n*Note* when set manually, will overwrite any internal loading state.\nSet to 'undefined' to revert to default behaviour.",
           "docsTags": [],
           "default": "undefined",
           "values": [
@@ -16143,7 +16178,7 @@
           "reflectToAttr": false,
           "docs": "To improve performance, data is split into blocks\nwhich are shown / hidden and rendered as they become visible.\nUse this to control the number of hits within a block -\nA block should fill a scrolling viewport.\nThe less perBlock the better for performance",
           "docsTags": [],
-          "default": "40",
+          "default": "50",
           "values": [
             {
               "type": "number"
@@ -16415,7 +16450,7 @@
           "docsTags": [
             {
               "name": "param",
-              "text": "row - the row to update.\n*Note* - this should come from the `col.cellTemplate` or `row.rowRender.template`  `rowModel` property\n- rows are augmented with certain properties to aid with efficient rendering"
+              "text": "row - the row to update."
             },
             {
               "name": "param",

package/docs-vscode.json

@@ -2681,7 +2681,7 @@
         },
         {
           "name": "stick-to",
-          "description": "Upon being stuck, attach the sticker to another sticker element.\nA JS query selector that returns a <nano-sticker>"
+          "description": "Upon being stuck, attach the sticker to another sticker element.\nJS query selector string or DOM element pointing to a `<nano-sticker>`"
         }
       ]
     },
@@ -2838,7 +2838,7 @@
         },
         {
           "name": "loading",
-          "description": "Will show a loading state when set to true.\nBy default, will be shown automatically if `rows` is a promise waiting to resolve\nor when performing custom filtering or sorting.\n*Note* when set manually, will overwrite any internal loading state.\nSet to 'undefined' to revert to default behaviour."
+          "description": "Will show a loading state when set to true.\nBy default, will be shown automatically if `rows` is a promise waiting to resolve / or falsy\n*or* when performing custom filtering or sorting.\n*Note* when set manually, will overwrite any internal loading state.\nSet to 'undefined' to revert to default behaviour."
         },
         {
           "name": "per-block",