@nanoporetech-digital/components 5.9.6 → 5.11.0

package/docs-json.json

@@ -1,8 +1,8 @@
 {
-  "timestamp": "2023-11-08T21:29:11",
+  "timestamp": "2024-02-28T22:56:32",
   "compiler": {
     "name": "@stencil/core",
-    "version": "2.23.1",
+    "version": "2.23.2",
     "typescriptVersion": "4.9.4"
   },
   "components": [
@@ -440,11 +440,11 @@
       "encapsulation": "shadow",
       "tag": "nano-algolia",
       "readme": "# nano-algolia-result\n\n\n",
-      "docs": "Algolia search container to contain and sync nano-algolia-results and nano-algolia-filter components.\nCan optionally contain nano-algolia-input components or use them as a 'resultsEmitter'",
+      "docs": "Algolia search container to contain and sync nano-algolia-results and nano-algolia-filter components.",
       "docsTags": [
         {
           "name": "slot",
-          "text": "search-input - optional. Should contain an algolia-input component."
+          "text": "search-input - optional. Should contain an `input` or `nano-input` component."
         },
         {
           "name": "slot",
@@ -540,7 +540,7 @@
           "mutable": false,
           "attr": "listen-to",
           "reflectToAttr": false,
-          "docs": "JS querSelector string of a `nano-input` / `input` element from which\nto listen to `nano-change` or `change` events and change the `query` prop.\nNot required if an appropriate field is in the 'search-input' slot",
+          "docs": "JS querySelector string of a `nano-input` / `input` element from which\nto listen to `nano-change` or `change` events and change the `query` prop.\nNot required if an appropriate field is in the 'search-input' slot",
           "docsTags": [],
           "default": "null",
           "values": [
@@ -767,27 +767,9 @@
           "getter": false,
           "setter": false
         },
-        {
-          "name": "tplEngine",
-          "type": "Object",
-          "mutable": false,
-          "reflectToAttr": false,
-          "docs": "Template engine to use when rendering results and filters.\nDefaults to Squirrel v8 (https://squirrelly.js.org/). This gives you access\nto the underlying squirrel object allowing you to modify it's configuration / add filters.",
-          "docsTags": [],
-          "default": "Squirrel",
-          "values": [
-            {
-              "type": "Object"
-            }
-          ],
-          "optional": false,
-          "required": false,
-          "getter": false,
-          "setter": false
-        },
         {
           "name": "tplRenderFn",
-          "type": "(...args: any[]) => string",
+          "type": "(...args: any[]) => any",
           "mutable": false,
           "reflectToAttr": false,
           "docs": "Template engine render function to use when rendering results and filters.\nDefaults to Squirrel v8's render (https://squirrelly.js.org/).",
@@ -795,7 +777,7 @@
           "default": "Squirrel.render",
           "values": [
             {
-              "type": "(...args: any[]) => string"
+              "type": "(...args: any[]) => any"
             }
           ],
           "optional": false,
@@ -914,7 +896,7 @@
         },
         {
           "name": "search-input",
-          "docs": "optional. Should contain an algolia-input component."
+          "docs": "optional. Should contain an `input` or `nano-input` component."
         },
         {
           "name": "template",
@@ -1128,258 +1110,6 @@
       "dependencies": [],
       "dependencyGraph": {}
     },
-    {
-      "filePath": "./src/components/algolia/algolia-input.tsx",
-      "encapsulation": "shadow",
-      "tag": "nano-algolia-input",
-      "readme": "# nano-algolia-result\n\n\n",
-      "docs": "",
-      "docsTags": [
-        {
-          "name": "deprecated",
-          "text": "Component for querying Algolia Indeces.\nCan be nested within an algolia element or used outside as a 'resultsEmitter' (see algolia component documentation)\nMust include one 'nano-input' component"
-        }
-      ],
-      "usage": {},
-      "props": [
-        {
-          "name": "apiKey",
-          "type": "string",
-          "mutable": false,
-          "attr": "api-key",
-          "reflectToAttr": false,
-          "docs": "An Algolia API Key. Used in conjunction with 'searchIndex' & 'appId'.\nAlternatively this will be set automatically when nested within an algolia component",
-          "docsTags": [],
-          "default": "''",
-          "values": [
-            {
-              "type": "string"
-            }
-          ],
-          "optional": false,
-          "required": false,
-          "getter": false,
-          "setter": false
-        },
-        {
-          "name": "appId",
-          "type": "string",
-          "mutable": false,
-          "attr": "app-id",
-          "reflectToAttr": false,
-          "docs": "An Algolia App ID key. Used in conjunction with 'searchIndex' & 'apiKey'.\nAlternatively this will be set automatically when nested within an algolia component",
-          "docsTags": [],
-          "default": "''",
-          "values": [
-            {
-              "type": "string"
-            }
-          ],
-          "optional": false,
-          "required": false,
-          "getter": false,
-          "setter": false
-        },
-        {
-          "name": "autoEmit",
-          "type": "boolean",
-          "mutable": false,
-          "attr": "auto-emit",
-          "reflectToAttr": false,
-          "docs": "Automatically emit results data to algolia components.\nFor example, if you wanted to provide an 'autocomplete' style dropdown\nbefore showing the main results with a submit button",
-          "docsTags": [],
-          "default": "true",
-          "values": [
-            {
-              "type": "boolean"
-            }
-          ],
-          "optional": false,
-          "required": false,
-          "getter": false,
-          "setter": false
-        },
-        {
-          "name": "browseIndex",
-          "type": "boolean",
-          "mutable": true,
-          "attr": "browse-index",
-          "reflectToAttr": false,
-          "docs": "Will maintain a search all / '*' on init and reset allowing for a view\nthen filter experience rather than a search first experience",
-          "docsTags": [],
-          "default": "false",
-          "values": [
-            {
-              "type": "boolean"
-            }
-          ],
-          "optional": false,
-          "required": false,
-          "getter": false,
-          "setter": false
-        },
-        {
-          "name": "minChars",
-          "type": "number",
-          "mutable": false,
-          "attr": "min-chars",
-          "reflectToAttr": false,
-          "docs": "Minimum number of characters before performing a search",
-          "docsTags": [],
-          "default": "2",
-          "values": [
-            {
-              "type": "number"
-            }
-          ],
-          "optional": false,
-          "required": false,
-          "getter": false,
-          "setter": false
-        },
-        {
-          "name": "searchIndex",
-          "type": "SearchIndex",
-          "mutable": true,
-          "reflectToAttr": false,
-          "docs": "Algolia search index. Used in conjunction with 'searchIndex' & 'appId'.\nAlternatively this will be set automatically if you're using a 'resultsEmitter' element.\n```\n{ index: string, // algolia index name\n  domain?: string, // used in template filers to resolve incomplete url fields\n  filters?: [string], // algolia facets to retrive\n  hitsPerPage?: number,\n  name?: string // human readable index name\n}\n```",
-          "docsTags": [],
-          "default": "null",
-          "values": [
-            {
-              "type": "SearchIndex"
-            }
-          ],
-          "optional": false,
-          "required": false,
-          "getter": false,
-          "setter": false
-        },
-        {
-          "name": "searchIndexName",
-          "type": "string",
-          "mutable": false,
-          "attr": "search-index-name",
-          "reflectToAttr": false,
-          "docs": "Algolia search index name. Alternative to 'searchIndex'.\nA simplified shortcut for setting an index.\nproperties such as hitsPerPage and facets will come from the algolia index",
-          "docsTags": [],
-          "values": [
-            {
-              "type": "string"
-            }
-          ],
-          "optional": false,
-          "required": false,
-          "getter": false,
-          "setter": false
-        },
-        {
-          "name": "storeId",
-          "type": "string",
-          "mutable": false,
-          "attr": "store-id",
-          "reflectToAttr": false,
-          "docs": "Store search queries (against this ID) to the component store.\nUse in conjunction with storeMethod",
-          "docsTags": [],
-          "values": [
-            {
-              "type": "string"
-            }
-          ],
-          "optional": true,
-          "required": false,
-          "getter": false,
-          "setter": false
-        },
-        {
-          "name": "storeMethod",
-          "type": "\"local\" | \"session\" | \"url-hash\" | \"url-hash-push\" | \"url-query\" | \"url-query-push\"",
-          "mutable": false,
-          "attr": "store-method",
-          "reflectToAttr": false,
-          "docs": "The method of storage.\nEither session storage, url hash (after the '#') or url query (after the '?').",
-          "docsTags": [],
-          "default": "'session'",
-          "values": [
-            {
-              "value": "local",
-              "type": "string"
-            },
-            {
-              "value": "session",
-              "type": "string"
-            },
-            {
-              "value": "url-hash",
-              "type": "string"
-            },
-            {
-              "value": "url-hash-push",
-              "type": "string"
-            },
-            {
-              "value": "url-query",
-              "type": "string"
-            },
-            {
-              "value": "url-query-push",
-              "type": "string"
-            }
-          ],
-          "optional": false,
-          "required": false,
-          "getter": false,
-          "setter": false
-        }
-      ],
-      "methods": [
-        {
-          "name": "search",
-          "returns": {
-            "type": "Promise<void>",
-            "docs": ""
-          },
-          "signature": "search() => Promise<void>",
-          "parameters": [],
-          "docs": "Manually emit search results to algolia components.\nUseful if you don't wish to search on input change / want to provide 'autocomplete' options\nor / and want to use a submit button",
-          "docsTags": []
-        }
-      ],
-      "events": [
-        {
-          "event": "nanoSearch",
-          "detail": "AloliaSearchResultDetail",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Emitted when search results are successfully returned from Algolia.",
-          "docsTags": []
-        },
-        {
-          "event": "nanoSearchReset",
-          "detail": "AloliaSearchResultDetail",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Emitted when search field is cleared.",
-          "docsTags": []
-        }
-      ],
-      "listeners": [
-        {
-          "event": "nanoChange",
-          "capture": false,
-          "passive": false
-        }
-      ],
-      "styles": [],
-      "slots": [],
-      "parts": [],
-      "dependents": [],
-      "dependencies": [],
-      "dependencyGraph": {},
-      "deprecation": "Component for querying Algolia Indeces.\nCan be nested within an algolia element or used outside as a 'resultsEmitter' (see algolia component documentation)\nMust include one 'nano-input' component"
-    },
     {
       "filePath": "./src/components/algolia/algolia-pagination.tsx",
       "encapsulation": "shadow",
@@ -2187,6 +1917,10 @@
           "name": "slot",
           "text": "- Used for grouping checkboxes inside the group wrapper"
         },
+        {
+          "name": "slot",
+          "text": "legend - if you do not set a legend attribute, you can use this slot for more complex markup"
+        },
         {
           "name": "slot",
           "text": "helper - helper text to accompany the form field underneath."
@@ -2213,6 +1947,25 @@
           "getter": false,
           "setter": false
         },
+        {
+          "name": "hideLegend",
+          "type": "boolean",
+          "mutable": false,
+          "attr": "hide-legend",
+          "reflectToAttr": false,
+          "docs": "Visually hide the legend but still available to screen readers.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
         {
           "name": "invalid",
           "type": "boolean",
@@ -2521,6 +2274,10 @@
         {
           "name": "helper",
           "docs": "helper text to accompany the form field underneath."
+        },
+        {
+          "name": "legend",
+          "docs": "if you do not set a legend attribute, you can use this slot for more complex markup"
         }
       ],
       "parts": [],
@@ -5391,7 +5148,7 @@
         {
           "name": "hoist",
           "type": "boolean",
-          "mutable": false,
+          "mutable": true,
           "attr": "hoist",
           "reflectToAttr": false,
           "docs": "Enable this option to prevent the panel from being clipped when the component is placed inside a container with\n`overflow: auto|scroll`.",
@@ -17130,7 +16887,7 @@
         {
           "name": "hoist",
           "type": "boolean",
-          "mutable": false,
+          "mutable": true,
           "attr": "hoist",
           "reflectToAttr": false,
           "docs": "Enable this option to prevent the panel from being clipped when the component is placed inside a container with\n`overflow: auto|scroll`.",

package/docs-vscode.json

@@ -105,7 +105,7 @@
       "name": "nano-algolia",
       "description": {
         "kind": "markdown",
-        "value": "Algolia search container to contain and sync nano-algolia-results and nano-algolia-filter components.\nCan optionally contain nano-algolia-input components or use them as a 'resultsEmitter'"
+        "value": "Algolia search container to contain and sync nano-algolia-results and nano-algolia-filter components."
       },
       "attributes": [
         {
@@ -122,7 +122,7 @@
         },
         {
           "name": "listen-to",
-          "description": "JS querSelector string of a `nano-input` / `input` element from which\nto listen to `nano-change` or `change` events and change the `query` prop.\nNot required if an appropriate field is in the 'search-input' slot"
+          "description": "JS querySelector string of a `nano-input` / `input` element from which\nto listen to `nano-change` or `change` events and change the `query` prop.\nNot required if an appropriate field is in the 'search-input' slot"
         },
         {
           "name": "min-chars",
@@ -247,67 +247,6 @@
         }
       ]
     },
-    {
-      "name": "nano-algolia-input",
-      "description": {
-        "kind": "markdown",
-        "value": ""
-      },
-      "attributes": [
-        {
-          "name": "api-key",
-          "description": "An Algolia API Key. Used in conjunction with 'searchIndex' & 'appId'.\nAlternatively this will be set automatically when nested within an algolia component"
-        },
-        {
-          "name": "app-id",
-          "description": "An Algolia App ID key. Used in conjunction with 'searchIndex' & 'apiKey'.\nAlternatively this will be set automatically when nested within an algolia component"
-        },
-        {
-          "name": "auto-emit",
-          "description": "Automatically emit results data to algolia components.\nFor example, if you wanted to provide an 'autocomplete' style dropdown\nbefore showing the main results with a submit button"
-        },
-        {
-          "name": "browse-index",
-          "description": "Will maintain a search all / '*' on init and reset allowing for a view\nthen filter experience rather than a search first experience"
-        },
-        {
-          "name": "min-chars",
-          "description": "Minimum number of characters before performing a search"
-        },
-        {
-          "name": "search-index-name",
-          "description": "Algolia search index name. Alternative to 'searchIndex'.\nA simplified shortcut for setting an index.\nproperties such as hitsPerPage and facets will come from the algolia index"
-        },
-        {
-          "name": "store-id",
-          "description": "Store search queries (against this ID) to the component store.\nUse in conjunction with storeMethod"
-        },
-        {
-          "name": "store-method",
-          "description": "The method of storage.\nEither session storage, url hash (after the '#') or url query (after the '?').",
-          "values": [
-            {
-              "name": "local"
-            },
-            {
-              "name": "session"
-            },
-            {
-              "name": "url-hash"
-            },
-            {
-              "name": "url-hash-push"
-            },
-            {
-              "name": "url-query"
-            },
-            {
-              "name": "url-query-push"
-            }
-          ]
-        }
-      ]
-    },
     {
       "name": "nano-algolia-pagination",
       "description": {
@@ -480,6 +419,10 @@
           "name": "disabled",
           "description": "Disable all the nested form controls"
         },
+        {
+          "name": "hide-legend",
+          "description": "Visually hide the legend but still available to screen readers."
+        },
         {
           "name": "invalid",
           "description": "This will be true when the control is in an invalid state.\nValidity is determined by the `required` prop. Or if custom validity message is set. @readonly"