@nanoporetech-digital/components 5.9.5 → 5.10.0

package/dist/types/components.d.ts

@@ -70,7 +70,6 @@ export namespace Components {
     }
     /**
      * Algolia search container to contain and sync nano-algolia-results and nano-algolia-filter components.
-     * Can optionally contain nano-algolia-input components or use them as a 'resultsEmitter'
      */
     interface NanoAlgolia {
         /**
@@ -90,7 +89,7 @@ export namespace Components {
          */
         "filters": Array<string>;
         /**
-          * JS querSelector string of a `nano-input` / `input` element from which to listen to `nano-change` or `change` events and change the `query` prop. Not required if an appropriate field is in the 'search-input' slot
+          * JS querySelector string of a `nano-input` / `input` element from which to listen to `nano-change` or `change` events and change the `query` prop. Not required if an appropriate field is in the 'search-input' slot
          */
         "listenTo"?: string;
         /**
@@ -173,53 +172,6 @@ export namespace Components {
          */
         "value": string | Array<string>;
     }
-    /**
-     * @deprecated Component for querying Algolia Indeces.
-     * Can be nested within an algolia element or used outside as a 'resultsEmitter' (see algolia component documentation)
-     * Must include one 'nano-input' component
-     */
-    interface NanoAlgoliaInput {
-        /**
-          * An Algolia API Key. Used in conjunction with 'searchIndex' & 'appId'. Alternatively this will be set automatically when nested within an algolia component
-         */
-        "apiKey": string;
-        /**
-          * An Algolia App ID key. Used in conjunction with 'searchIndex' & 'apiKey'. Alternatively this will be set automatically when nested within an algolia component
-         */
-        "appId": string;
-        /**
-          * Automatically emit results data to algolia components. For example, if you wanted to provide an 'autocomplete' style dropdown before showing the main results with a submit button
-         */
-        "autoEmit": boolean;
-        /**
-          * Will maintain a search all / '*' on init and reset allowing for a view then filter experience rather than a search first experience
-         */
-        "browseIndex": boolean;
-        /**
-          * Minimum number of characters before performing a search
-         */
-        "minChars": number;
-        /**
-          * Manually emit search results to algolia components. Useful if you don't wish to search on input change / want to provide 'autocomplete' options or / and want to use a submit button
-         */
-        "search": () => Promise<void>;
-        /**
-          * Algolia search index. Used in conjunction with 'searchIndex' & 'appId'. Alternatively this will be set automatically if you're using a 'resultsEmitter' element. ``` { index: string, // algolia index name   domain?: string, // used in template filers to resolve incomplete url fields   filters?: [string], // algolia facets to retrive   hitsPerPage?: number,   name?: string // human readable index name } ```
-         */
-        "searchIndex": SearchIndex;
-        /**
-          * Algolia search index name. Alternative to 'searchIndex'. A simplified shortcut for setting an index. properties such as hitsPerPage and facets will come from the algolia index
-         */
-        "searchIndexName": string;
-        /**
-          * Store search queries (against this ID) to the component store. Use in conjunction with storeMethod
-         */
-        "storeId"?: string;
-        /**
-          * The method of storage. Either session storage, url hash (after the '#') or url query (after the '?').
-         */
-        "storeMethod": StorageMethods;
-    }
     /**
      * Displays results from Algolia searches.
      * TODO / WIP
@@ -2590,10 +2542,6 @@ export interface NanoAlgoliaFilterCustomEvent<T> extends CustomEvent<T> {
     detail: T;
     target: HTMLNanoAlgoliaFilterElement;
 }
-export interface NanoAlgoliaInputCustomEvent<T> extends CustomEvent<T> {
-    detail: T;
-    target: HTMLNanoAlgoliaInputElement;
-}
 export interface NanoAlgoliaPaginationCustomEvent<T> extends CustomEvent<T> {
     detail: T;
     target: HTMLNanoAlgoliaPaginationElement;
@@ -2747,7 +2695,6 @@ declare global {
     };
     /**
      * Algolia search container to contain and sync nano-algolia-results and nano-algolia-filter components.
-     * Can optionally contain nano-algolia-input components or use them as a 'resultsEmitter'
      */
     interface HTMLNanoAlgoliaElement extends Components.NanoAlgolia, HTMLStencilElement {
     }
@@ -2765,17 +2712,6 @@ declare global {
         prototype: HTMLNanoAlgoliaFilterElement;
         new (): HTMLNanoAlgoliaFilterElement;
     };
-    /**
-     * @deprecated Component for querying Algolia Indeces.
-     * Can be nested within an algolia element or used outside as a 'resultsEmitter' (see algolia component documentation)
-     * Must include one 'nano-input' component
-     */
-    interface HTMLNanoAlgoliaInputElement extends Components.NanoAlgoliaInput, HTMLStencilElement {
-    }
-    var HTMLNanoAlgoliaInputElement: {
-        prototype: HTMLNanoAlgoliaInputElement;
-        new (): HTMLNanoAlgoliaInputElement;
-    };
     /**
      * Displays results from Algolia searches.
      * TODO / WIP
@@ -3260,7 +3196,6 @@ declare global {
         "nano-alert": HTMLNanoAlertElement;
         "nano-algolia": HTMLNanoAlgoliaElement;
         "nano-algolia-filter": HTMLNanoAlgoliaFilterElement;
-        "nano-algolia-input": HTMLNanoAlgoliaInputElement;
         "nano-algolia-pagination": HTMLNanoAlgoliaPaginationElement;
         "nano-algolia-results": HTMLNanoAlgoliaResultsElement;
         "nano-aspect-ratio": HTMLNanoAspectRatioElement;
@@ -3367,7 +3302,6 @@ declare namespace LocalJSX {
     }
     /**
      * Algolia search container to contain and sync nano-algolia-results and nano-algolia-filter components.
-     * Can optionally contain nano-algolia-input components or use them as a 'resultsEmitter'
      */
     interface NanoAlgolia {
         /**
@@ -3387,7 +3321,7 @@ declare namespace LocalJSX {
          */
         "filters"?: Array<string>;
         /**
-          * JS querSelector string of a `nano-input` / `input` element from which to listen to `nano-change` or `change` events and change the `query` prop. Not required if an appropriate field is in the 'search-input' slot
+          * JS querySelector string of a `nano-input` / `input` element from which to listen to `nano-change` or `change` events and change the `query` prop. Not required if an appropriate field is in the 'search-input' slot
          */
         "listenTo"?: string;
         /**
@@ -3493,57 +3427,6 @@ declare namespace LocalJSX {
          */
         "value"?: string | Array<string>;
     }
-    /**
-     * @deprecated Component for querying Algolia Indeces.
-     * Can be nested within an algolia element or used outside as a 'resultsEmitter' (see algolia component documentation)
-     * Must include one 'nano-input' component
-     */
-    interface NanoAlgoliaInput {
-        /**
-          * An Algolia API Key. Used in conjunction with 'searchIndex' & 'appId'. Alternatively this will be set automatically when nested within an algolia component
-         */
-        "apiKey"?: string;
-        /**
-          * An Algolia App ID key. Used in conjunction with 'searchIndex' & 'apiKey'. Alternatively this will be set automatically when nested within an algolia component
-         */
-        "appId"?: string;
-        /**
-          * Automatically emit results data to algolia components. For example, if you wanted to provide an 'autocomplete' style dropdown before showing the main results with a submit button
-         */
-        "autoEmit"?: boolean;
-        /**
-          * Will maintain a search all / '*' on init and reset allowing for a view then filter experience rather than a search first experience
-         */
-        "browseIndex"?: boolean;
-        /**
-          * Minimum number of characters before performing a search
-         */
-        "minChars"?: number;
-        /**
-          * Emitted when search results are successfully returned from Algolia.
-         */
-        "onNanoSearch"?: (event: NanoAlgoliaInputCustomEvent<AloliaSearchResultDetail>) => void;
-        /**
-          * Emitted when search field is cleared.
-         */
-        "onNanoSearchReset"?: (event: NanoAlgoliaInputCustomEvent<AloliaSearchResultDetail>) => void;
-        /**
-          * Algolia search index. Used in conjunction with 'searchIndex' & 'appId'. Alternatively this will be set automatically if you're using a 'resultsEmitter' element. ``` { index: string, // algolia index name   domain?: string, // used in template filers to resolve incomplete url fields   filters?: [string], // algolia facets to retrive   hitsPerPage?: number,   name?: string // human readable index name } ```
-         */
-        "searchIndex"?: SearchIndex;
-        /**
-          * Algolia search index name. Alternative to 'searchIndex'. A simplified shortcut for setting an index. properties such as hitsPerPage and facets will come from the algolia index
-         */
-        "searchIndexName"?: string;
-        /**
-          * Store search queries (against this ID) to the component store. Use in conjunction with storeMethod
-         */
-        "storeId"?: string;
-        /**
-          * The method of storage. Either session storage, url hash (after the '#') or url query (after the '?').
-         */
-        "storeMethod"?: StorageMethods;
-    }
     /**
      * Displays results from Algolia searches.
      * TODO / WIP
@@ -6030,7 +5913,6 @@ declare namespace LocalJSX {
         "nano-alert": NanoAlert;
         "nano-algolia": NanoAlgolia;
         "nano-algolia-filter": NanoAlgoliaFilter;
-        "nano-algolia-input": NanoAlgoliaInput;
         "nano-algolia-pagination": NanoAlgoliaPagination;
         "nano-algolia-results": NanoAlgoliaResults;
         "nano-aspect-ratio": NanoAspectRatio;
@@ -6094,7 +5976,6 @@ declare module "@stencil/core" {
             "nano-alert": LocalJSX.NanoAlert & JSXBase.HTMLAttributes<HTMLNanoAlertElement>;
             /**
              * Algolia search container to contain and sync nano-algolia-results and nano-algolia-filter components.
-             * Can optionally contain nano-algolia-input components or use them as a 'resultsEmitter'
              */
             "nano-algolia": LocalJSX.NanoAlgolia & JSXBase.HTMLAttributes<HTMLNanoAlgoliaElement>;
             /**
@@ -6102,12 +5983,6 @@ declare module "@stencil/core" {
              * Must be nested within an nano-algolia component.
              */
             "nano-algolia-filter": LocalJSX.NanoAlgoliaFilter & JSXBase.HTMLAttributes<HTMLNanoAlgoliaFilterElement>;
-            /**
-             * @deprecated Component for querying Algolia Indeces.
-             * Can be nested within an algolia element or used outside as a 'resultsEmitter' (see algolia component documentation)
-             * Must include one 'nano-input' component
-             */
-            "nano-algolia-input": LocalJSX.NanoAlgoliaInput & JSXBase.HTMLAttributes<HTMLNanoAlgoliaInputElement>;
             /**
              * Displays results from Algolia searches.
              * TODO / WIP

package/docs-json.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2023-11-02T12:01:43",
+  "timestamp": "2023-11-15T09:49:34",
   "compiler": {
     "name": "@stencil/core",
     "version": "2.23.1",
@@ -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": [
@@ -914,7 +914,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 +1128,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",

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": {