@nanoporetech-digital/components 5.10.0 → 5.11.0

package/dist/types/components/slides/lib/js/flickity.d.ts

@@ -0,0 +1,23 @@
+declare function Flickity(element: any, options: any): void;
+declare namespace Flickity {
+  var defaults: {
+    accessibility: boolean;
+    cellAlign: string;
+    freeScrollFriction: number;
+    friction: number;
+    namespaceJQueryEvents: boolean;
+    percentPosition: boolean;
+    resize: boolean;
+    selectedAttraction: number;
+    setGallerySize: boolean;
+  };
+  var createMethods: any[];
+  var keyboardHandlers: {
+    37: () => void;
+    39: () => void;
+  };
+  var data: (elem: any) => any;
+  var Cell: typeof import("./cell").default;
+  var Slide: typeof import("./slide").default;
+}
+export default Flickity;

package/dist/types/components/slides/lib/js/fullscreen.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/components/slides/lib/js/index.d.ts

@@ -0,0 +1,5 @@
+import Flickity from './flickity';
+import './drag';
+import './prev-next-button';
+import './player';
+export declare const flickity: typeof Flickity;

package/dist/types/components/slides/lib/js/lazyload.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/components/slides/lib/js/page-dots.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/components/slides/lib/js/player.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/components/slides/lib/js/prev-next-button.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/components/slides/lib/js/slide.d.ts

@@ -0,0 +1 @@
+export default function Slide(parent: any): void;

package/dist/types/components/slides/lib/js/utils/event-emitter.d.ts

@@ -0,0 +1 @@
+export declare function EvEmitter(): void;

package/dist/types/components/slides/lib/js/utils/gestures.d.ts

@@ -0,0 +1,26 @@
+/*!
+ * Unipointer v2.4.0
+ * base class for doing one thing with pointer event
+ * MIT license
+ */
+export declare function Unipointer(): void;
+export declare namespace Unipointer {
+  var prototype: any;
+  var getPointerPoint: (pointer: any) => {
+    x: any;
+    y: any;
+  };
+}
+/*!
+ * Unidragger v2.4.0
+ * Draggable base class
+ * MIT license
+ */
+export declare function Unidragger(): void;
+export declare namespace Unidragger {
+  var prototype: any;
+  var getPointerPoint: (pointer: any) => {
+    x: any;
+    y: any;
+  };
+}

package/dist/types/components/slides/lib/js/utils/get-size.d.ts

@@ -0,0 +1,6 @@
+/*!
+ * getSize v2.0.3
+ * measure size of elements
+ * MIT license
+ */
+export declare function getSize(elem: any): any;

package/dist/types/components/slides/lib/js/utils/utils.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Fizzy UI utils v2.0.7
+ * MIT license
+ */
+export declare const utils: any;

package/dist/types/components/slides/slides-interface.d.ts

@@ -1,4 +1,5 @@
-import Flicker, { Options, EventBindings } from 'flickity';
+import Flicker, { Options, EventBindings } from '@types/flickity';
+
 interface PointerDragEvent extends PointerEvent {
   x: number;
   y: number;
@@ -7,7 +8,9 @@ interface TouchDragEvent extends Touch {
   x: number;
   y: number;
 }
-export interface Flickity extends Omit<Flicker, 'next' | 'previous' | 'slides'> {
+
+export interface Flickity
+  extends Omit<Flicker, 'next' | 'previous' | 'slides'> {
   options: FlickityOptions;
   next(isWrapped?: boolean, isInstant?: boolean): void;
   previous(isWrapped?: boolean, isInstant?: boolean): void;
@@ -20,18 +23,27 @@ export interface Flickity extends Omit<Flicker, 'next' | 'previous' | 'slides'>
   slideableWidth: number;
   cursorPosition: number;
 }
+
 export interface FlickityOptions extends Options {
   fullscreen?: boolean;
   fade?: boolean;
 }
+
 export type DragEvent = TouchDragEvent | PointerDragEvent;
+
 export type SlideAnimation = 'fade' | 'scroll' | 'parallax' | (() => void);
-export interface FlickityEvents extends Omit<EventBindings, 'dragMove' | 'dragEnd' | 'dragStart' | 'staticClick'> {
+
+export interface FlickityEvents
+  extends Omit<
+    EventBindings,
+    'dragMove' | 'dragEnd' | 'dragStart' | 'staticClick'
+  > {
   dragMove?: (pointer?: DragEvent) => void;
   dragStart?: (pointer?: DragEvent) => void;
   dragEnd?: (pointer?: DragEvent) => void;
   staticClick?: (pointer?: DragEvent) => void;
 }
+
 export interface FlickitySlide {
   cells: FlickityCell[];
   firstMargin: number;
@@ -42,14 +54,12 @@ export interface FlickitySlide {
   target: number;
   x: number;
 }
+
 export interface FlickityCell {
   element: HTMLElement;
   parent: Flickity;
   shift: number;
-  size: {
-    [prop: string]: number;
-  };
+  size: { [prop: string]: number };
   target: number;
   x: number;
 }
-export {};

package/dist/types/components/slides/slides.d.ts

@@ -31,6 +31,10 @@ export declare class Slides implements ComponentInterface {
   private flickity;
   private syncflickity?;
   private childrenEles;
+  private hasFullScreenModule;
+  private hasLazyLoadModule;
+  private hasDotsModule;
+  private hasFadeModule;
   iCurrentSlide: number;
   slidesReady: boolean;
   didInit: boolean;
@@ -157,6 +161,7 @@ export declare class Slides implements ComponentInterface {
   private handleFullscreen;
   private handleSlideSelect;
   private destroyflickity;
+  private loadFlickityModules;
   private initflickity;
   private normalizeOptions;
   componentDidLoad(): void;

package/dist/types/components.d.ts

@@ -137,14 +137,10 @@ export namespace Components {
           * The method of storage. Either session storage, url hash (after the '#') or url query (after the '?').
          */
         "storeMethod": StorageMethods;
-        /**
-          * Template engine to use when rendering results and filters. Defaults to Squirrel v8 (https://squirrelly.js.org/). This gives you access to the underlying squirrel object allowing you to modify it's configuration / add filters.
-         */
-        "tplEngine": Object;
         /**
           * Template engine render function to use when rendering results and filters. Defaults to Squirrel v8's render (https://squirrelly.js.org/).
          */
-        "tplRenderFn": (...args: any[]) => string;
+        "tplRenderFn": (...args: any[]) => any;
     }
     /**
      * Displays and syncs algolia filters
@@ -316,6 +312,10 @@ export namespace Components {
           * Disable all the nested form controls
          */
         "disabled": boolean | null;
+        /**
+          * Visually hide the legend but still available to screen readers.
+         */
+        "hideLegend"?: boolean;
         /**
           * This will be true when the control is in an invalid state. Validity is determined by the `required` prop. Or if custom validity message is set. @readonly
          */
@@ -3384,14 +3384,10 @@ declare namespace LocalJSX {
           * The method of storage. Either session storage, url hash (after the '#') or url query (after the '?').
          */
         "storeMethod"?: StorageMethods;
-        /**
-          * Template engine to use when rendering results and filters. Defaults to Squirrel v8 (https://squirrelly.js.org/). This gives you access to the underlying squirrel object allowing you to modify it's configuration / add filters.
-         */
-        "tplEngine"?: Object;
         /**
           * Template engine render function to use when rendering results and filters. Defaults to Squirrel v8's render (https://squirrelly.js.org/).
          */
-        "tplRenderFn"?: (...args: any[]) => string;
+        "tplRenderFn"?: (...args: any[]) => any;
     }
     /**
      * Displays and syncs algolia filters
@@ -3560,6 +3556,10 @@ declare namespace LocalJSX {
           * Disable all the nested form controls
          */
         "disabled"?: boolean | null;
+        /**
+          * Visually hide the legend but still available to screen readers.
+         */
+        "hideLegend"?: boolean;
         /**
           * This will be true when the control is in an invalid state. Validity is determined by the `required` prop. Or if custom validity message is set. @readonly
          */

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

@@ -8,6 +8,10 @@ export declare function lockBodyScrolling(lockingEl: HTMLElement): void;
  */
 export declare function unlockBodyScrolling(lockingEl: HTMLElement): void;
 /**
- * Scrolls an element into view of its container. If the element is already in view, nothing will happen.
+ * Scrolls an element into view *of its parent container*.
+ * Note to future me - cannot use native `scrollIntoView`
+ * 'cos it will move the whole window
+ * (vertically even though we only care about parent).
+ * If the element is already in view, nothing will happen.
  */
 export declare function scrollIntoView(element: HTMLElement, container: HTMLElement, direction?: 'horizontal' | 'vertical' | 'both', position?: 'center' | 'start'): void;

package/docs-json.json

@@ -1,8 +1,8 @@
 {
-  "timestamp": "2023-11-15T09:49:34",
+  "timestamp": "2024-02-28T22:56:32",
   "compiler": {
     "name": "@stencil/core",
-    "version": "2.23.1",
+    "version": "2.23.2",
     "typescriptVersion": "4.9.4"
   },
   "components": [
@@ -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,
@@ -1935,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."
@@ -1961,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",
@@ -2269,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": [],
@@ -5139,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`.",
@@ -16878,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

@@ -419,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"