@nanoporetech-digital/components 2.7.0 → 2.10.0

package/dist/types/components.d.ts

@@ -245,6 +245,10 @@ export namespace Components {
           * If `true`, the user cannot interact with the checkbox.
          */
         "disabled": boolean;
+        /**
+          * The form element to associate the input with (its form owner). Must be the id of a form.
+         */
+        "form"?: string | null;
         /**
           * Returns the native input control
          */
@@ -283,7 +287,7 @@ export namespace Components {
         /**
           * Sets a custom validation message. If `message` is not empty, the field will be considered invalid. Use in conjunction with `nano-checkbox-group`
          */
-        "setError": (message: string) => Promise<void>;
+        "setError": (message: string, updateStatus?: boolean) => Promise<void>;
         /**
           * Sets focus on the checkbox.
          */
@@ -296,6 +300,10 @@ export namespace Components {
     | 'tag'
     | 'segment'
     | 'segment-pill';
+        /**
+          * Current validation message - if any. @readonly
+         */
+        "validityMessage": string;
         /**
           * The value of a checkbox is analogous to the value of an `<input type='checkbox'>`, it's only present when `checked` is true.
          */
@@ -328,6 +336,12 @@ export namespace Components {
           * @returns `{ isValid: boolean, errorMessage: string }`
          */
         "reportValidity": (validateFirst: boolean) => Promise<ControlValidity>;
+        /**
+          * Invalidate the field and show a custom error message. To clear the error you will need to re-call this method with an empty string.
+          * @param message - the error message to show
+          * @param optVal - optionally supply an option value to target which checkbox to show invalidate against (default is the first)
+         */
+        "showError": (message: string, optVal?: string) => Promise<void>;
         /**
           * Whether to show validation errors underneath input
          */
@@ -336,6 +350,10 @@ export namespace Components {
           * When should the field perform validation
          */
         "validateOn"?: 'dirty' | 'submit' | 'submitThenDirty';
+        /**
+          * Current validation message - if any. @readonly
+         */
+        "validityMessage": string;
     }
     interface NanoDatalist {
         /**
@@ -506,6 +524,10 @@ export namespace Components {
           * When should the field perform validation
          */
         "validateOn"?: 'dirty' | 'submit' | 'submitThenDirty';
+        /**
+          * Current validation message - if any. @readonly
+         */
+        "validityMessage": string;
         /**
           * Current value. Must be in IS0-8601 format: YYYY-MM-DD.
          */
@@ -579,6 +601,10 @@ export namespace Components {
           * Hides the dialog
          */
         "hide": () => Promise<void>;
+        /**
+          * Relocate the dialog to the root of the DOM. Useful for elements bound via css `transform: ...`
+         */
+        "hoist": boolean;
         /**
           * The dialog's label as displayed in the header. You should always include a relevant label even when using `no-header`, as it is required for proper accessibility.
          */
@@ -704,6 +730,48 @@ export namespace Components {
          */
         "tetherTo": HTMLElement;
     }
+    interface NanoFieldValidator {
+        /**
+          * Returns true if any nested fields have been changed @readonly
+         */
+        "dirty": boolean;
+        /**
+          * The current form payload as a reactive store. @readonly
+         */
+        "payload": ValueStore;
+        /**
+          * Tries to scroll to the first invalid field on submit
+         */
+        "scrollToInvalid": boolean;
+        /**
+          * Returns true if validation errors will be displayed to the user
+         */
+        "showValidation": boolean;
+        /**
+          * Returns true if all the nested fields are currently valid @readonly
+         */
+        "valid": boolean;
+        /**
+          * When should the fields perform validation. Will override / sync all nested `nano-...` controls
+         */
+        "validateOn"?: 'dirty' | 'submit' | 'submitThenDirty';
+        /**
+          * A validation callback method.
+          * @param field - The field name currently being evaluated
+          * @param value - The value of the field currently being evaluated
+          * @param fields - an array of all currently observered form fields and values
+          * @returns field names mapped to an object of status message and validity e.g. ```js {field1: {msg: `This is invalid!`}, field2: {msg: `This is valid!`, valid: true}} ```
+         */
+        "validation": (
+    field: string,
+    value: string,
+    fields: ValueStore
+  ) => { [key: string]: { msg: string; valid?: boolean } };
+        /**
+          * Get the current validation state of all form fields. @readonly ``` { fields: NanoFormEles[]; valid: boolean; validityMessage: string; dirty: boolean; name: string | number; value: any; }[] ```
+         */
+        "validationState": ValidationState[];
+    }
     interface NanoFileUpload {
         /**
           * The accept attribute value is a string that defines the file types the file input should accept. E.g. for a MS Word file: `.doc, .docx,application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document`
@@ -725,6 +793,10 @@ export namespace Components {
           * A File array that lists every selected file. Has an added `objectURL` property returning a `DOMString` containing an object URL that can be used to reference the contents of the specified source This list has no more than one member unless the multiple attribute is specified. @readonly
          */
         "files": FileWithUrl[];
+        /**
+          * The form element to associate with this input (its form owner). Must be the id of a form.
+         */
+        "form"?: string | null;
         /**
           * Returns the native `<input>` element used under the hood
          */
@@ -784,6 +856,10 @@ export namespace Components {
           * When should the field perform validation
          */
         "validateOn"?: 'dirty' | 'submit' | 'submitThenDirty';
+        /**
+          * Current validation message - if any. @readonly
+         */
+        "validityMessage": string;
         /**
           * A file input's value attribute contains a DOMString that represents the path to the selected file(s). If the user selected multiple files, the value represents the first file in the list of files they selected. You can reset the file-upload control by setting the value to an emptry string e.g. `var input.value = ''`
          */
@@ -808,9 +884,9 @@ export namespace Components {
          */
         "cartUrl": string;
         /**
-          * Connect to local, dev, test or prod MyAccount environments to retrieve global nav / sso data
+          * Connect to local, dev, test or prod MyAccount environments to retrieve global nav / sso data. Alternatively, you can use the `ssoDataUrl` prop.
          */
-        "env": 'local' | 'dev' | 'test' | 'prod';
+        "env"?: 'local' | 'dev' | 'test' | 'prod';
         /**
           * Whether to attempt to get global nav / sso data from MyAccount
          */
@@ -868,6 +944,10 @@ export namespace Components {
           * Whether to show search functionality
          */
         "showSearch": boolean;
+        /**
+          * A base url to retrieve global nav / sso data. `nav_bar_data.json` will be appended to this url. An alternative to the pre-defined `env` urls
+         */
+        "ssoDataUrl"?: string;
         /**
           * Where to take user after SSO login
          */
@@ -965,7 +1045,7 @@ export namespace Components {
         /**
           * Specifies the label to use for accessibility. Defaults to the icon name.
          */
-        "ariaLabel"?: string;
+        "ariaLabel": string;
         /**
           * Color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
          */
@@ -1105,7 +1185,7 @@ export namespace Components {
          */
         "floatLabel": boolean;
         /**
-          * The form element to associate the select with (its form owner). Must be the id of a form.
+          * The form element to associate the input with (its form owner). Must be the id of a form.
          */
         "form"?: string | null;
         /**
@@ -1225,6 +1305,10 @@ export namespace Components {
           * When should the field perform validation
          */
         "validateOn": 'dirty' | 'submit' | 'submitThenDirty';
+        /**
+          * Current validation message - if any. @readonly
+         */
+        "validityMessage": string;
         /**
           * The value of the input.
          */
@@ -1555,6 +1639,10 @@ export namespace Components {
           * When should the field perform validation
          */
         "validateOn"?: 'dirty' | 'submit' | 'submitThenDirty';
+        /**
+          * Current validation message - if any. @readonly
+         */
+        "validityMessage": string;
         /**
           * The value of the select.
          */
@@ -1998,6 +2086,12 @@ declare global {
         prototype: HTMLNanoDropdownElement;
         new (): HTMLNanoDropdownElement;
     };
+    interface HTMLNanoFieldValidatorElement extends Components.NanoFieldValidator, HTMLStencilElement {
+    }
+    var HTMLNanoFieldValidatorElement: {
+        prototype: HTMLNanoFieldValidatorElement;
+        new (): HTMLNanoFieldValidatorElement;
+    };
     interface HTMLNanoFileUploadElement extends Components.NanoFileUpload, HTMLStencilElement {
     }
     var HTMLNanoFileUploadElement: {
@@ -2184,6 +2278,7 @@ declare global {
         "nano-dialog": HTMLNanoDialogElement;
         "nano-drawer": HTMLNanoDrawerElement;
         "nano-dropdown": HTMLNanoDropdownElement;
+        "nano-field-validator": HTMLNanoFieldValidatorElement;
         "nano-file-upload": HTMLNanoFileUploadElement;
         "nano-global-nav": HTMLNanoGlobalNavElement;
         "nano-global-search-results": HTMLNanoGlobalSearchResultsElement;
@@ -2476,6 +2571,10 @@ declare namespace LocalJSX {
           * If `true`, the user cannot interact with the checkbox.
          */
         "disabled"?: boolean;
+        /**
+          * The form element to associate the input with (its form owner). Must be the id of a form.
+         */
+        "form"?: string | null;
         /**
           * If `true`, the checkbox will visually appear as indeterminate (only relevant for type="checkbox")
          */
@@ -2516,6 +2615,10 @@ declare namespace LocalJSX {
     | 'tag'
     | 'segment'
     | 'segment-pill';
+        /**
+          * Current validation message - if any. @readonly
+         */
+        "validityMessage"?: string;
         /**
           * The value of a checkbox is analogous to the value of an `<input type='checkbox'>`, it's only present when `checked` is true.
          */
@@ -2555,6 +2658,10 @@ declare namespace LocalJSX {
           * When should the field perform validation
          */
         "validateOn"?: 'dirty' | 'submit' | 'submitThenDirty';
+        /**
+          * Current validation message - if any. @readonly
+         */
+        "validityMessage"?: string;
     }
     interface NanoDatalist {
         /**
@@ -2728,6 +2835,10 @@ declare namespace LocalJSX {
           * When should the field perform validation
          */
         "validateOn"?: 'dirty' | 'submit' | 'submitThenDirty';
+        /**
+          * Current validation message - if any. @readonly
+         */
+        "validityMessage"?: string;
         /**
           * Current value. Must be in IS0-8601 format: YYYY-MM-DD.
          */
@@ -2802,6 +2913,10 @@ declare namespace LocalJSX {
         "open"?: boolean;
     }
     interface NanoDialog {
+        /**
+          * Relocate the dialog to the root of the DOM. Useful for elements bound via css `transform: ...`
+         */
+        "hoist"?: boolean;
         /**
           * The dialog's label as displayed in the header. You should always include a relevant label even when using `no-header`, as it is required for proper accessibility.
          */
@@ -2967,6 +3082,60 @@ declare namespace LocalJSX {
          */
         "tetherTo"?: HTMLElement;
     }
+    interface NanoFieldValidator {
+        /**
+          * Returns true if any nested fields have been changed @readonly
+         */
+        "dirty"?: boolean;
+        /**
+          * Fire on invalid form submission attempt
+         */
+        "onNanoInvalid"?: (event: CustomEvent<any>) => void;
+        /**
+          * Fired whenever the payload changes
+         */
+        "onNanoPayloadChange"?: (event: CustomEvent<ValueStore>) => void;
+        /**
+          * Fired on valid form submission. Note: if you wish to prevent a form from submitting, instead of using / preventing the native `submit` event, use this event ```js ele.addEventListener('nanoSubmit', (e) => {   e.preventDefault() }) ```
+         */
+        "onNanoSubmit"?: (event: CustomEvent<any>) => void;
+        /**
+          * The current form payload as a reactive store. @readonly
+         */
+        "payload"?: ValueStore;
+        /**
+          * Tries to scroll to the first invalid field on submit
+         */
+        "scrollToInvalid"?: boolean;
+        /**
+          * Returns true if validation errors will be displayed to the user
+         */
+        "showValidation"?: boolean;
+        /**
+          * Returns true if all the nested fields are currently valid @readonly
+         */
+        "valid"?: boolean;
+        /**
+          * When should the fields perform validation. Will override / sync all nested `nano-...` controls
+         */
+        "validateOn"?: 'dirty' | 'submit' | 'submitThenDirty';
+        /**
+          * A validation callback method.
+          * @param field - The field name currently being evaluated
+          * @param value - The value of the field currently being evaluated
+          * @param fields - an array of all currently observered form fields and values
+          * @returns field names mapped to an object of status message and validity e.g. ```js {field1: {msg: `This is invalid!`}, field2: {msg: `This is valid!`, valid: true}} ```
+         */
+        "validation"?: (
+    field: string,
+    value: string,
+    fields: ValueStore
+  ) => { [key: string]: { msg: string; valid?: boolean } };
+        /**
+          * Get the current validation state of all form fields. @readonly ``` { fields: NanoFormEles[]; valid: boolean; validityMessage: string; dirty: boolean; name: string | number; value: any; }[] ```
+         */
+        "validationState"?: ValidationState[];
+    }
     interface NanoFileUpload {
         /**
           * The accept attribute value is a string that defines the file types the file input should accept. E.g. for a MS Word file: `.doc, .docx,application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document`
@@ -2988,6 +3157,10 @@ declare namespace LocalJSX {
           * A File array that lists every selected file. Has an added `objectURL` property returning a `DOMString` containing an object URL that can be used to reference the contents of the specified source This list has no more than one member unless the multiple attribute is specified. @readonly
          */
         "files"?: FileWithUrl[];
+        /**
+          * The form element to associate with this input (its form owner). Must be the id of a form.
+         */
+        "form"?: string | null;
         /**
           * Visually hide the label - but make it accessible.
          */
@@ -3045,6 +3218,10 @@ declare namespace LocalJSX {
           * When should the field perform validation
          */
         "validateOn"?: 'dirty' | 'submit' | 'submitThenDirty';
+        /**
+          * Current validation message - if any. @readonly
+         */
+        "validityMessage"?: string;
         /**
           * A file input's value attribute contains a DOMString that represents the path to the selected file(s). If the user selected multiple files, the value represents the first file in the list of files they selected. You can reset the file-upload control by setting the value to an emptry string e.g. `var input.value = ''`
          */
@@ -3069,7 +3246,7 @@ declare namespace LocalJSX {
          */
         "cartUrl"?: string;
         /**
-          * Connect to local, dev, test or prod MyAccount environments to retrieve global nav / sso data
+          * Connect to local, dev, test or prod MyAccount environments to retrieve global nav / sso data. Alternatively, you can use the `ssoDataUrl` prop.
          */
         "env"?: 'local' | 'dev' | 'test' | 'prod';
         /**
@@ -3145,6 +3322,10 @@ declare namespace LocalJSX {
           * Whether to show search functionality
          */
         "showSearch"?: boolean;
+        /**
+          * A base url to retrieve global nav / sso data. `nav_bar_data.json` will be appended to this url. An alternative to the pre-defined `env` urls
+         */
+        "ssoDataUrl"?: string;
         /**
           * Where to take user after SSO login
          */
@@ -3390,7 +3571,7 @@ declare namespace LocalJSX {
          */
         "floatLabel"?: boolean;
         /**
-          * The form element to associate the select with (its form owner). Must be the id of a form.
+          * The form element to associate the input with (its form owner). Must be the id of a form.
          */
         "form"?: string | null;
         /**
@@ -3513,6 +3694,10 @@ declare namespace LocalJSX {
           * When should the field perform validation
          */
         "validateOn"?: 'dirty' | 'submit' | 'submitThenDirty';
+        /**
+          * Current validation message - if any. @readonly
+         */
+        "validityMessage"?: string;
         /**
           * The value of the input.
          */
@@ -3886,6 +4071,10 @@ declare namespace LocalJSX {
           * When should the field perform validation
          */
         "validateOn"?: 'dirty' | 'submit' | 'submitThenDirty';
+        /**
+          * Current validation message - if any. @readonly
+         */
+        "validityMessage"?: string;
         /**
           * The value of the select.
          */
@@ -4244,6 +4433,7 @@ declare namespace LocalJSX {
         "nano-dialog": NanoDialog;
         "nano-drawer": NanoDrawer;
         "nano-dropdown": NanoDropdown;
+        "nano-field-validator": NanoFieldValidator;
         "nano-file-upload": NanoFileUpload;
         "nano-global-nav": NanoGlobalNav;
         "nano-global-search-results": NanoGlobalSearchResults;
@@ -4295,6 +4485,7 @@ declare module "@stencil/core" {
             "nano-dialog": LocalJSX.NanoDialog & JSXBase.HTMLAttributes<HTMLNanoDialogElement>;
             "nano-drawer": LocalJSX.NanoDrawer & JSXBase.HTMLAttributes<HTMLNanoDrawerElement>;
             "nano-dropdown": LocalJSX.NanoDropdown & JSXBase.HTMLAttributes<HTMLNanoDropdownElement>;
+            "nano-field-validator": LocalJSX.NanoFieldValidator & JSXBase.HTMLAttributes<HTMLNanoFieldValidatorElement>;
             "nano-file-upload": LocalJSX.NanoFileUpload & JSXBase.HTMLAttributes<HTMLNanoFileUploadElement>;
             "nano-global-nav": LocalJSX.NanoGlobalNav & JSXBase.HTMLAttributes<HTMLNanoGlobalNavElement>;
             "nano-global-search-results": LocalJSX.NanoGlobalSearchResults & JSXBase.HTMLAttributes<HTMLNanoGlobalSearchResultsElement>;

package/dist/types/utils/store/get-set.d.ts

@@ -1,4 +1,4 @@
-export declare const urlSet: (object: object, to?: 'hash' | 'query', win?: Window, method?: 'replace' | 'push') => void;
+export declare const urlSet: (id: string, data: object, to?: 'hash' | 'query', win?: Window, method?: 'replace' | 'push') => void;
 export declare const urlGet: (key: string, to?: 'hash' | 'query', win?: Window) => any;
 export declare const sessionSet: (key: string, object: object, win?: Window) => void;
 export declare const sessionGet: (key: string, win?: Window) => any;