@nanoporetech-digital/components 4.9.3 → 4.10.0

package/docs-json.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2023-06-10T00:10:20",
+  "timestamp": "2023-06-26T23:07:54",
   "compiler": {
     "name": "@stencil/core",
     "version": "2.23.0",
@@ -8243,7 +8243,7 @@
     },
     {
       "filePath": "./src/components/icon-button/icon-button.tsx",
-      "encapsulation": "scoped",
+      "encapsulation": "shadow",
       "tag": "nano-icon-button",
       "readme": "# nano-icon-button\n\n\n",
       "docs": "Icons buttons are simple, icon-only buttons that can be used for actions and in toolbars.",
@@ -8278,6 +8278,27 @@
           "getter": false,
           "setter": false
         },
+        {
+          "name": "form",
+          "type": "HTMLFormElement | string",
+          "mutable": false,
+          "attr": "form",
+          "reflectToAttr": false,
+          "docs": "The HTML form element or form element id.\nUsed to submit a form when the button is not a child of the form.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "HTMLFormElement"
+            },
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
         {
           "name": "href",
           "type": "string",
@@ -8368,6 +8389,24 @@
           "getter": false,
           "setter": false
         },
+        {
+          "name": "rel",
+          "type": "string",
+          "mutable": false,
+          "attr": "rel",
+          "reflectToAttr": false,
+          "docs": "Specifies the relationship of the target object to the link object.\nThe value is a space-separated list of [link types](https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types)",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
         {
           "name": "showTooltip",
           "type": "boolean",
@@ -8479,9 +8518,9 @@
           "docs": "defaults to transparent;"
         },
         {
-          "name": "--border-radius",
+          "name": "--box-shadow",
           "annotation": "prop",
-          "docs": "defaults to var(--nano-border-radius-medium, 4px);"
+          "docs": "defaults to none;"
         },
         {
           "name": "--color",
@@ -13851,6 +13890,479 @@
       "dependencies": [],
       "dependencyGraph": {}
     },
+    {
+      "filePath": "./src/components/sortable/sortable.tsx",
+      "encapsulation": "shadow",
+      "tag": "nano-sortable",
+      "readme": "# nano-sortable\n\n\n",
+      "docs": "An accessible and flexible re-order / sort utility component.\n\n- Drag and drop via mouse, touch or keyboard\n- Live announcements for screen readers\n- Works with or without an explicit handle (although with is preferable)",
+      "docsTags": [
+        {
+          "name": "part",
+          "text": "announcements - the a11y, live region. Visually hidden by default"
+        },
+        {
+          "name": "slot",
+          "text": "- The default slot containing any items you might want to sort"
+        }
+      ],
+      "usage": {},
+      "props": [
+        {
+          "name": "animationEnabled",
+          "type": "boolean",
+          "mutable": false,
+          "attr": "animation-enabled",
+          "reflectToAttr": false,
+          "docs": "Items being sorted will animate into place",
+          "docsTags": [],
+          "default": "true",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
+        {
+          "name": "animationTiming",
+          "type": "any",
+          "mutable": false,
+          "attr": "animation-timing",
+          "reflectToAttr": false,
+          "docs": "The css animation timing applied when `animationEnabled` is `true`",
+          "docsTags": [],
+          "default": "{ duration: 200, easing: 'ease-out' }",
+          "values": [
+            {
+              "type": "any"
+            }
+          ],
+          "optional": false,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
+        {
+          "name": "createKeyboardHandle",
+          "type": "(_number: number, _element: Element) => HTMLElement",
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "A function that should attach a keyboard accessible control.\nWhen a `handleSelector` is not used - to allow keyboard accessibility -\n`createKeyboardHandle` should render a focusable element.\n\nIf your sortable item is itself focusable,\nyou must use this function to render a control *outside* of the focusable element.",
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "_number"
+            },
+            {
+              "name": "param",
+              "text": "_element"
+            },
+            {
+              "name": "returns",
+              "text": "a function that attaches a keyboard accessible handle control element.\nThe function itself *must* return the handle element."
+            }
+          ],
+          "default": "(_number: number, _element: Element) => {\n    const handleTpl = /* html */ `\n      <nano-icon-button\n        slot=\"end\"\n        icon-name=\"light/arrows\"\n        class=\"nano-sortable__keyboard-handle visually-hidden\"\n      ></nano-icon-button>`;\n    const div = globalThis.document.createElement('div');\n    div.innerHTML = handleTpl;\n\n    const handle = div.children[0] as HTMLElement;\n    _element.append(handle);\n    return handle;\n  }",
+          "values": [
+            {
+              "type": "(_number: number, _element: Element) => HTMLElement"
+            }
+          ],
+          "optional": false,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
+        {
+          "name": "dragResize",
+          "type": "boolean",
+          "mutable": false,
+          "attr": "drag-resize",
+          "reflectToAttr": false,
+          "docs": "Dragged items by default, will take whatever default css is applied in situ.\nWhen sortable items' dimensions are dynamic (i.e they can shrink / grow via the space allowed) dragging items can look 'wrong'.\nApply `dragResize` to read & recreate the dragged items current dimensions when dragged.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
+        {
+          "name": "draggedClass",
+          "type": "string",
+          "mutable": false,
+          "attr": "dragged-class",
+          "reflectToAttr": false,
+          "docs": "Use this class to change how the element looks whilst being sorted",
+          "docsTags": [],
+          "default": "'nano-sortable__dragged'",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
+        {
+          "name": "droppedHelperText",
+          "type": "(el: Element) => string",
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "Used to generate a screen reader live update, informing the user of the current element being dropped.",
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "el the element that has been dropped by the user"
+            },
+            {
+              "name": "returns",
+              "text": "a string, describing the element that has been dropped"
+            }
+          ],
+          "default": "(el: Element) =>\n    `${this.itemDescriptor(el)} dropped`",
+          "values": [
+            {
+              "type": "(el: Element) => string"
+            }
+          ],
+          "optional": false,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
+        {
+          "name": "dropzoneActiveClass",
+          "type": "string",
+          "mutable": false,
+          "attr": "dropzone-active-class",
+          "reflectToAttr": false,
+          "docs": "Used in-conjunction with `dropzoneSelector`, applied when a dropzone is dragged over",
+          "docsTags": [],
+          "default": "''",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
+        {
+          "name": "dropzoneSelector",
+          "type": "string",
+          "mutable": false,
+          "attr": "dropzone-selector",
+          "reflectToAttr": false,
+          "docs": "When dragging between grouped collections of items, it is possible to drag all sortable items from one group to another.\nAt that point, you will not be able to drag items back to the original group.\nA `dropzoneSelector` allows you to define a placeholder area where items can always be dropped.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
+        {
+          "name": "grabbedHelperText",
+          "type": "(el: Element) => string",
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "Used to generate a screen reader live update, informing the user of the current element being grabbed.",
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "el the element that has been grabbed by the user"
+            },
+            {
+              "name": "returns",
+              "text": "a string, describing the element being grabbed"
+            }
+          ],
+          "default": "(el: Element) =>\n    `${this.itemDescriptor(el)} grabbed`",
+          "values": [
+            {
+              "type": "(el: Element) => string"
+            }
+          ],
+          "optional": false,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
+        {
+          "name": "handleDraggedClass",
+          "type": "string",
+          "mutable": false,
+          "attr": "handle-dragged-class",
+          "reflectToAttr": false,
+          "docs": "Use this class to change how the handle looks whilst being sorted",
+          "docsTags": [],
+          "default": "'nano-sortable__handle-dragged'",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
+        {
+          "name": "handleSelector",
+          "type": "string",
+          "mutable": false,
+          "attr": "handle-selector",
+          "reflectToAttr": false,
+          "docs": "A css query selector which matches an element *within* the `itemSelector` element\nwhich will act like a drag handle. **Note** For keyboard a11y it's recommended\nto use `handleSelector` when possible. Alternatively, the `createKeyboardHandle` prop will be used",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
+        {
+          "name": "helperText",
+          "type": "string",
+          "mutable": false,
+          "attr": "helper-text",
+          "reflectToAttr": false,
+          "docs": "Accessibility helper text applied to handle controls",
+          "docsTags": [],
+          "default": "'Press \"Space\" or \"Enter\" to enable element reordering and use the arrow keys to reorder items.' +\n    'Press \"Escape\" to cancel reordering. Alternatively, use your mouse to drag / reorder.'",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
+        {
+          "name": "itemDescriptor",
+          "type": "(el: Element) => string",
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "As a sortable element is interacted with, announcements are made to screen readers\n- informing the user what is changing.\nBy default, the text from the element is extracted to describe the interacted with element.\nUse this function to provide a more meaningful, concise item descriptor",
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "el the element being interacted with"
+            },
+            {
+              "name": "returns",
+              "text": "a string, describing the element being interacted with"
+            }
+          ],
+          "default": "(el: Element) => `\"${el.textContent.trim()}\"`",
+          "values": [
+            {
+              "type": "(el: Element) => string"
+            }
+          ],
+          "optional": false,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
+        {
+          "name": "itemSelector",
+          "type": "string",
+          "mutable": false,
+          "attr": "item-selector",
+          "reflectToAttr": false,
+          "docs": "A css query selector which matches a set of elements that should be sortable. e.g. `<li>` or `<tr>`",
+          "docsTags": [],
+          "default": "'li'",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
+        {
+          "name": "orientation",
+          "type": "\"horizontal\" | \"vertical\"",
+          "mutable": false,
+          "attr": "orientation",
+          "reflectToAttr": false,
+          "docs": "The axis to lock dragging elements to. `undefined` means any axis",
+          "docsTags": [],
+          "values": [
+            {
+              "value": "horizontal",
+              "type": "string"
+            },
+            {
+              "value": "vertical",
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
+        {
+          "name": "placeholderClass",
+          "type": "string",
+          "mutable": false,
+          "attr": "placeholder-class",
+          "reflectToAttr": false,
+          "docs": "Use this class to change how the element looks when acting as a placeholder",
+          "docsTags": [],
+          "default": "'nano-sortable__placeholder'",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
+        {
+          "name": "reorderHelperText",
+          "type": "(el: Element, elements: Element[], position: number) => string",
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "Used to generate a screen reader live update, informing the user when items have been reordered.",
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "el the element that has been reordered by the user"
+            },
+            {
+              "name": "param",
+              "text": "elements the elements in the sortable list"
+            },
+            {
+              "name": "param",
+              "text": "position the new position of the dropped element"
+            },
+            {
+              "name": "returns",
+              "text": "a string, describing the element being dropped"
+            }
+          ],
+          "default": "(\n    el: Element,\n    elements: Element[],\n    position: number\n  ) =>\n    `The list has been reordered, ${this.itemDescriptor(\n      el\n    )} is now item ${position} of ${elements.length}`",
+          "values": [
+            {
+              "type": "(el: Element, elements: Element[], position: number) => string"
+            }
+          ],
+          "optional": false,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
+        {
+          "name": "sortableHostElement",
+          "type": "HTMLElement",
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "use `sortableHostElement` to watch a sortable list without needing to wrap in `nano-sortable`.\nNote that the `sortableHostElement` element css `position` will be set to `relative`",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "HTMLElement"
+            }
+          ],
+          "optional": true,
+          "required": false,
+          "getter": false,
+          "setter": false
+        }
+      ],
+      "methods": [
+        {
+          "name": "refreshKeyboardHandles",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "signature": "refreshKeyboardHandles() => Promise<void>",
+          "parameters": [],
+          "docs": "If sortable elements change dynamically, use this method to add handle controls to new elements",
+          "docsTags": []
+        }
+      ],
+      "events": [
+        {
+          "event": "nanoDropped",
+          "detail": "{ element: HTMLElement; }",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Fired when a sortable element is dropped after having been picked up.",
+          "docsTags": []
+        },
+        {
+          "event": "nanoGrabbed",
+          "detail": "{ element: HTMLElement; index: number; }",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Fired when a sortable element is picked-up; via keyboard, mouse or touch.\n`event.preventDefault()` to prevent the element being picked-up.",
+          "docsTags": []
+        },
+        {
+          "event": "nanoOrderChange",
+          "detail": "{ element: HTMLElement; originalIndex: number; targetIndex: number; }",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Fired when an the order changes. Use this to update any underlying data model.\n`event.preventDefault()` to prevent the element being moved; will revert to original position.",
+          "docsTags": []
+        }
+      ],
+      "listeners": [],
+      "styles": [],
+      "slots": [
+        {
+          "name": "",
+          "docs": "The default slot containing any items you might want to sort"
+        }
+      ],
+      "parts": [
+        {
+          "name": "announcements",
+          "docs": "the a11y, live region. Visually hidden by default"
+        }
+      ],
+      "dependents": [],
+      "dependencies": [],
+      "dependencyGraph": {}
+    },
     {
       "filePath": "./src/components/spinner/spinner.tsx",
       "encapsulation": "shadow",
@@ -14610,9 +15122,29 @@
       "readme": "# nano-tab\n\n\n",
       "docs": "",
       "docsTags": [
+        {
+          "name": "slot",
+          "text": "start - start of the tab, content. Outside of the focusable element"
+        },
+        {
+          "name": "slot",
+          "text": "end - end of the tab, content. Outside of the focusable element"
+        },
         {
           "name": "slot",
           "text": "- The tab's label."
+        },
+        {
+          "name": "part",
+          "text": "base - the wrapper around the whole control"
+        },
+        {
+          "name": "part",
+          "text": "tab - the main tab control that controls the active state"
+        },
+        {
+          "name": "part",
+          "text": "close-btn - the close button of the tab (if `closable=true`)"
         }
       ],
       "usage": {},
@@ -14746,6 +15278,11 @@
           "annotation": "prop",
           "docs": "Defaults to var(--nano-layer-bg-rgb, 255 255 255);"
         },
+        {
+          "name": "--border-radius",
+          "annotation": "prop",
+          "docs": "inherit;"
+        },
         {
           "name": "--disabled-bg-rgb",
           "annotation": "prop",
@@ -14806,12 +15343,28 @@
         {
           "name": "",
           "docs": "The tab's label."
+        },
+        {
+          "name": "end",
+          "docs": "end of the tab, content. Outside of the focusable element"
+        },
+        {
+          "name": "start",
+          "docs": "start of the tab, content. Outside of the focusable element"
         }
       ],
       "parts": [
         {
           "name": "base",
-          "docs": ""
+          "docs": "the wrapper around the whole control"
+        },
+        {
+          "name": "close-btn",
+          "docs": "the close button of the tab (if `closable=true`)"
+        },
+        {
+          "name": "tab",
+          "docs": "the main tab control that controls the active state"
         }
       ],
       "dependents": [],
@@ -15036,7 +15589,7 @@
           "type": "\"start\" | \"top\"",
           "mutable": false,
           "attr": "placement",
-          "reflectToAttr": false,
+          "reflectToAttr": true,
           "docs": "The placement of the tabs.",
           "docsTags": [],
           "default": "'top'",
@@ -15191,7 +15744,7 @@
         {
           "name": "--content-border-radius",
           "annotation": "prop",
-          "docs": "defaults to var(--border-radius);"
+          "docs": "defaults to `var(--border-radius)` `position=\"top\"`. `0 var(--border-radius) var(--border-radius) 0` `position=\"start\"`;"
         },
         {
           "name": "--content-padding",
@@ -15236,7 +15789,7 @@
         {
           "name": "--tab-border-radius",
           "annotation": "prop",
-          "docs": "defaults to var(--border-radius);"
+          "docs": "defaults to `var(--border-radius) var(--border-radius) 0 0` `position=\"top\"`. `0` `position=\"start\"`. ;"
         },
         {
           "name": "--tab-text-color",
@@ -15320,7 +15873,7 @@
       "encapsulation": "none",
       "tag": "nano-table",
       "readme": "# nano-table\n\n\n",
-      "docs": "A performant, accessible and semantic (uses real html `<table />`, `<tr />` etc) table and data-grid solution.\n\n- Built-in search\n- Built-in column filter\n- Built-in column sort\n- Easily swap in API / async based search / filter & sort\n- Pin headers, footers, rows, columns\n- Drag-&-Drop columns to re-order\n- Add custom rendering at every level\n- Add custom properties at every level",
+      "docs": "A performant, accessible and semantic (uses real html `<table />`, `<tr />` etc) table and data-grid solution.\n\n- Built-in search\n- Built-in column filter\n- Built-in column sort\n- Easily swap in API / async based search / filter & sort\n- Pin headers, footers, rows, columns\n- Add custom rendering at every level\n- Add custom properties at every level",
       "docsTags": [
         {
           "name": "slot",
@@ -15427,25 +15980,6 @@
           "getter": false,
           "setter": false
         },
-        {
-          "name": "defaultColDraggable",
-          "type": "boolean",
-          "mutable": false,
-          "attr": "default-col-draggable",
-          "reflectToAttr": false,
-          "docs": "The default draggable option for all columns.\n`true` will enable column drag-to-reorder unless you set `draggable: false` on a column\n`false` will disable column drag-to-reorder unless you set `draggable: true` on a column",
-          "docsTags": [],
-          "default": "false",
-          "values": [
-            {
-              "type": "boolean"
-            }
-          ],
-          "optional": false,
-          "required": false,
-          "getter": false,
-          "setter": false
-        },
         {
           "name": "defaultSort",
           "type": "boolean",
@@ -15882,24 +16416,6 @@
           "docs": "Fired whenever a block is activated by scrolling into view / becoming visible\nThis could be leveraged for infinite scrolling / to fetch more data.",
           "docsTags": []
         },
-        {
-          "event": "nanoTblColDrag",
-          "detail": "{ column: keyof RowGeneric; }",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Fired when a column has started dragging",
-          "docsTags": []
-        },
-        {
-          "event": "nanoTblColDrop",
-          "detail": "{ fromCol: keyof RowGeneric; toCol: keyof RowGeneric; fromIndex: number; toIndex: number; }",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Fired when a column has been dropped (after dragging)\n`event.preventDefault()` to stop column re-order.",
-          "docsTags": []
-        },
         {
           "event": "nanoTblReady",
           "detail": "any",