@nanoporetech-digital/components 4.9.3 → 4.10.0

package/dist/types/components.d.ts

@@ -9,7 +9,7 @@ import { AlgoliaNetworkError, AloliaSearchResultDetail, CheckboxChangeEventDetai
 import { StorageMethods } from "./utils/store/component-store";
 import { DaysOfWeek } from "./utils/date-utils";
 import { PopoverPlacement } from "./utils/popover";
-import { EventEmitter } from "./stencil-public-runtime";
+import { Element, EventEmitter } from "./stencil-public-runtime";
 import { ObservableMap } from "@stencil/store";
 import { MyAccountUser as MyAccountUser1 } from "./components/global-nav/global-nav-interface";
 import { OptionInterface as OptionInterface1 } from "./components/option/option-interface";
@@ -1254,6 +1254,10 @@ export namespace Components {
           * Set to true to disable the button.
          */
         "disabled": boolean;
+        /**
+          * The HTML form element or form element id. Used to submit a form when the button is not a child of the form.
+         */
+        "form": HTMLFormElement | string;
         /**
           * Contains a URL or a URL fragment that the hyperlink points to. If this property is set, an anchor tag will be rendered.
          */
@@ -1274,6 +1278,10 @@ export namespace Components {
           * The name of the button, submitted as a pair with the button’s value as part of the form data.
          */
         "name"?: string;
+        /**
+          * Specifies the relationship of the target object to the link object. The value is a space-separated list of [link types](https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types)
+         */
+        "rel": string | undefined;
         /**
           * Sets focus on the internal button
          */
@@ -2068,6 +2076,103 @@ export namespace Components {
          */
         "updateAutoHeight": (speed?: number) => Promise<void>;
     }
+    /**
+     * An accessible and flexible re-order / sort utility component.
+     * - Drag and drop via mouse, touch or keyboard
+     * - Live announcements for screen readers
+     * - Works with or without an explicit handle (although with is preferable)
+     */
+    interface NanoSortable {
+        /**
+          * Items being sorted will animate into place
+         */
+        "animationEnabled": boolean;
+        /**
+          * The css animation timing applied when `animationEnabled` is `true`
+         */
+        "animationTiming": any;
+        /**
+          * A function that should attach a keyboard accessible control. When a `handleSelector` is not used - to allow keyboard accessibility - `createKeyboardHandle` should render a focusable element.  If your sortable item is itself focusable, you must use this function to render a control *outside* of the focusable element.
+          * @param _number
+          * @param _element
+          * @returns a function that attaches a keyboard accessible handle control element. The function itself *must* return the handle element.
+         */
+        "createKeyboardHandle": (_number: number, _element: Element) => HTMLElement;
+        /**
+          * Dragged items by default, will take whatever default css is applied in situ. When sortable items' dimensions are dynamic (i.e they can shrink / grow via the space allowed) dragging items can look 'wrong'. Apply `dragResize` to read & recreate the dragged items current dimensions when dragged.
+         */
+        "dragResize": boolean;
+        /**
+          * Use this class to change how the element looks whilst being sorted
+         */
+        "draggedClass": string;
+        /**
+          * Used to generate a screen reader live update, informing the user of the current element being dropped.
+          * @param el the element that has been dropped by the user
+          * @returns a string, describing the element that has been dropped
+         */
+        "droppedHelperText": (el: Element) => string;
+        /**
+          * Used in-conjunction with `dropzoneSelector`, applied when a dropzone is dragged over
+         */
+        "dropzoneActiveClass"?: string;
+        /**
+          * When dragging between grouped collections of items, it is possible to drag all sortable items from one group to another. At that point, you will not be able to drag items back to the original group. A `dropzoneSelector` allows you to define a placeholder area where items can always be dropped.
+         */
+        "dropzoneSelector"?: string;
+        /**
+          * Used to generate a screen reader live update, informing the user of the current element being grabbed.
+          * @param el the element that has been grabbed by the user
+          * @returns a string, describing the element being grabbed
+         */
+        "grabbedHelperText": (el: Element) => string;
+        /**
+          * Use this class to change how the handle looks whilst being sorted
+         */
+        "handleDraggedClass": string;
+        /**
+          * A css query selector which matches an element *within* the `itemSelector` element which will act like a drag handle. **Note** For keyboard a11y it's recommended to use `handleSelector` when possible. Alternatively, the `createKeyboardHandle` prop will be used
+         */
+        "handleSelector"?: string;
+        /**
+          * Accessibility helper text applied to handle controls
+         */
+        "helperText": string;
+        /**
+          * As a sortable element is interacted with, announcements are made to screen readers - informing the user what is changing. By default, the text from the element is extracted to describe the interacted with element. Use this function to provide a more meaningful, concise item descriptor
+          * @param el the element being interacted with
+          * @returns a string, describing the element being interacted with
+         */
+        "itemDescriptor": (el: Element) => string;
+        /**
+          * A css query selector which matches a set of elements that should be sortable. e.g. `<li>` or `<tr>`
+         */
+        "itemSelector": string;
+        /**
+          * The axis to lock dragging elements to. `undefined` means any axis
+         */
+        "orientation"?: 'horizontal' | 'vertical';
+        /**
+          * Use this class to change how the element looks when acting as a placeholder
+         */
+        "placeholderClass": string;
+        /**
+          * If sortable elements change dynamically, use this method to add handle controls to new elements
+         */
+        "refreshKeyboardHandles": () => Promise<void>;
+        /**
+          * Used to generate a screen reader live update, informing the user when items have been reordered.
+          * @param el the element that has been reordered by the user
+          * @param elements the elements in the sortable list
+          * @param position the new position of the dropped element
+          * @returns a string, describing the element being dropped
+         */
+        "reorderHelperText": (el: Element, elements: Element[], position: number) => string;
+        /**
+          * use `sortableHostElement` to watch a sortable list without needing to wrap in `nano-sortable`. Note that the `sortableHostElement` element css `position` will be set to `relative`
+         */
+        "sortableHostElement"?: HTMLElement;
+    }
     /**
      * Spinners are used to show the progress of an indeterminate operation.
      */
@@ -2263,7 +2368,6 @@ export namespace Components {
      * - Built-in column sort
      * - Easily swap in API / async based search / filter & sort
      * - Pin headers, footers, rows, columns
-     * - Drag-&-Drop columns to re-order
      * - Add custom rendering at every level
      * - Add custom properties at every level
      */
@@ -2305,10 +2409,6 @@ export namespace Components {
     property: TableTypes.Prop,
     order: TableTypes.Order
   ) => Promise<true | TableTypes.Falsy>;
-        /**
-          * The default draggable option for all columns. `true` will enable column drag-to-reorder unless you set `draggable: false` on a column `false` will disable column drag-to-reorder unless you set `draggable: true` on a column
-         */
-        "defaultColDraggable": boolean;
         /**
           * The default sortable option for all columns. `true` will enable column sorting unless you set `sortable: false` on a column `false` will disable column sorting unless you set `sortable: true` on a column
          */
@@ -2570,6 +2670,10 @@ export interface NanoSlidesCustomEvent<T> extends CustomEvent<T> {
     detail: T;
     target: HTMLNanoSlidesElement;
 }
+export interface NanoSortableCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLNanoSortableElement;
+}
 export interface NanoSplitPaneCustomEvent<T> extends CustomEvent<T> {
     detail: T;
     target: HTMLNanoSplitPaneElement;
@@ -3030,6 +3134,18 @@ declare global {
         prototype: HTMLNanoSlidesElement;
         new (): HTMLNanoSlidesElement;
     };
+    /**
+     * An accessible and flexible re-order / sort utility component.
+     * - Drag and drop via mouse, touch or keyboard
+     * - Live announcements for screen readers
+     * - Works with or without an explicit handle (although with is preferable)
+     */
+    interface HTMLNanoSortableElement extends Components.NanoSortable, HTMLStencilElement {
+    }
+    var HTMLNanoSortableElement: {
+        prototype: HTMLNanoSortableElement;
+        new (): HTMLNanoSortableElement;
+    };
     /**
      * Spinners are used to show the progress of an indeterminate operation.
      */
@@ -3088,7 +3204,6 @@ declare global {
      * - Built-in column sort
      * - Easily swap in API / async based search / filter & sort
      * - Pin headers, footers, rows, columns
-     * - Drag-&-Drop columns to re-order
      * - Add custom rendering at every level
      * - Add custom properties at every level
      */
@@ -3151,6 +3266,7 @@ declare global {
         "nano-skeleton": HTMLNanoSkeletonElement;
         "nano-slide": HTMLNanoSlideElement;
         "nano-slides": HTMLNanoSlidesElement;
+        "nano-sortable": HTMLNanoSortableElement;
         "nano-spinner": HTMLNanoSpinnerElement;
         "nano-split-pane": HTMLNanoSplitPaneElement;
         "nano-sticker": HTMLNanoStickerElement;
@@ -4458,6 +4574,10 @@ declare namespace LocalJSX {
           * Set to true to disable the button.
          */
         "disabled"?: boolean;
+        /**
+          * The HTML form element or form element id. Used to submit a form when the button is not a child of the form.
+         */
+        "form"?: HTMLFormElement | string;
         /**
           * Contains a URL or a URL fragment that the hyperlink points to. If this property is set, an anchor tag will be rendered.
          */
@@ -4478,6 +4598,10 @@ declare namespace LocalJSX {
           * The name of the button, submitted as a pair with the button’s value as part of the form data.
          */
         "name"?: string;
+        /**
+          * Specifies the relationship of the target object to the link object. The value is a space-separated list of [link types](https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types)
+         */
+        "rel"?: string | undefined;
         /**
           * display the label as a `<nano-tooltip />`
          */
@@ -5311,6 +5435,115 @@ declare namespace LocalJSX {
          */
         "pager"?: boolean;
     }
+    /**
+     * An accessible and flexible re-order / sort utility component.
+     * - Drag and drop via mouse, touch or keyboard
+     * - Live announcements for screen readers
+     * - Works with or without an explicit handle (although with is preferable)
+     */
+    interface NanoSortable {
+        /**
+          * Items being sorted will animate into place
+         */
+        "animationEnabled"?: boolean;
+        /**
+          * The css animation timing applied when `animationEnabled` is `true`
+         */
+        "animationTiming"?: any;
+        /**
+          * A function that should attach a keyboard accessible control. When a `handleSelector` is not used - to allow keyboard accessibility - `createKeyboardHandle` should render a focusable element.  If your sortable item is itself focusable, you must use this function to render a control *outside* of the focusable element.
+          * @param _number
+          * @param _element
+          * @returns a function that attaches a keyboard accessible handle control element. The function itself *must* return the handle element.
+         */
+        "createKeyboardHandle"?: (_number: number, _element: Element) => HTMLElement;
+        /**
+          * Dragged items by default, will take whatever default css is applied in situ. When sortable items' dimensions are dynamic (i.e they can shrink / grow via the space allowed) dragging items can look 'wrong'. Apply `dragResize` to read & recreate the dragged items current dimensions when dragged.
+         */
+        "dragResize"?: boolean;
+        /**
+          * Use this class to change how the element looks whilst being sorted
+         */
+        "draggedClass"?: string;
+        /**
+          * Used to generate a screen reader live update, informing the user of the current element being dropped.
+          * @param el the element that has been dropped by the user
+          * @returns a string, describing the element that has been dropped
+         */
+        "droppedHelperText"?: (el: Element) => string;
+        /**
+          * Used in-conjunction with `dropzoneSelector`, applied when a dropzone is dragged over
+         */
+        "dropzoneActiveClass"?: string;
+        /**
+          * When dragging between grouped collections of items, it is possible to drag all sortable items from one group to another. At that point, you will not be able to drag items back to the original group. A `dropzoneSelector` allows you to define a placeholder area where items can always be dropped.
+         */
+        "dropzoneSelector"?: string;
+        /**
+          * Used to generate a screen reader live update, informing the user of the current element being grabbed.
+          * @param el the element that has been grabbed by the user
+          * @returns a string, describing the element being grabbed
+         */
+        "grabbedHelperText"?: (el: Element) => string;
+        /**
+          * Use this class to change how the handle looks whilst being sorted
+         */
+        "handleDraggedClass"?: string;
+        /**
+          * A css query selector which matches an element *within* the `itemSelector` element which will act like a drag handle. **Note** For keyboard a11y it's recommended to use `handleSelector` when possible. Alternatively, the `createKeyboardHandle` prop will be used
+         */
+        "handleSelector"?: string;
+        /**
+          * Accessibility helper text applied to handle controls
+         */
+        "helperText"?: string;
+        /**
+          * As a sortable element is interacted with, announcements are made to screen readers - informing the user what is changing. By default, the text from the element is extracted to describe the interacted with element. Use this function to provide a more meaningful, concise item descriptor
+          * @param el the element being interacted with
+          * @returns a string, describing the element being interacted with
+         */
+        "itemDescriptor"?: (el: Element) => string;
+        /**
+          * A css query selector which matches a set of elements that should be sortable. e.g. `<li>` or `<tr>`
+         */
+        "itemSelector"?: string;
+        /**
+          * Fired when a sortable element is dropped after having been picked up.
+         */
+        "onNanoDropped"?: (event: NanoSortableCustomEvent<{ element: HTMLElement }>) => void;
+        /**
+          * Fired when a sortable element is picked-up; via keyboard, mouse or touch. `event.preventDefault()` to prevent the element being picked-up.
+         */
+        "onNanoGrabbed"?: (event: NanoSortableCustomEvent<{ element: HTMLElement; index: number }>) => void;
+        /**
+          * Fired when an the order changes. Use this to update any underlying data model. `event.preventDefault()` to prevent the element being moved; will revert to original position.
+         */
+        "onNanoOrderChange"?: (event: NanoSortableCustomEvent<{
+    element: HTMLElement;
+    originalIndex: number;
+    targetIndex: number;
+  }>) => void;
+        /**
+          * The axis to lock dragging elements to. `undefined` means any axis
+         */
+        "orientation"?: 'horizontal' | 'vertical';
+        /**
+          * Use this class to change how the element looks when acting as a placeholder
+         */
+        "placeholderClass"?: string;
+        /**
+          * Used to generate a screen reader live update, informing the user when items have been reordered.
+          * @param el the element that has been reordered by the user
+          * @param elements the elements in the sortable list
+          * @param position the new position of the dropped element
+          * @returns a string, describing the element being dropped
+         */
+        "reorderHelperText"?: (el: Element, elements: Element[], position: number) => string;
+        /**
+          * use `sortableHostElement` to watch a sortable list without needing to wrap in `nano-sortable`. Note that the `sortableHostElement` element css `position` will be set to `relative`
+         */
+        "sortableHostElement"?: HTMLElement;
+    }
     /**
      * Spinners are used to show the progress of an indeterminate operation.
      */
@@ -5517,7 +5750,6 @@ declare namespace LocalJSX {
      * - Built-in column sort
      * - Easily swap in API / async based search / filter & sort
      * - Pin headers, footers, rows, columns
-     * - Drag-&-Drop columns to re-order
      * - Add custom rendering at every level
      * - Add custom properties at every level
      */
@@ -5547,10 +5779,6 @@ declare namespace LocalJSX {
     property: TableTypes.Prop,
     order: TableTypes.Order
   ) => Promise<true | TableTypes.Falsy>;
-        /**
-          * The default draggable option for all columns. `true` will enable column drag-to-reorder unless you set `draggable: false` on a column `false` will disable column drag-to-reorder unless you set `draggable: true` on a column
-         */
-        "defaultColDraggable"?: boolean;
         /**
           * The default sortable option for all columns. `true` will enable column sorting unless you set `sortable: false` on a column `false` will disable column sorting unless you set `sortable: true` on a column
          */
@@ -5607,21 +5835,6 @@ declare namespace LocalJSX {
         "onNanoTblBlockRendered"?: (event: NanoTableCustomEvent<{
     block: number;
     totalBlocks: number;
-  }>) => void;
-        /**
-          * Fired when a column has started dragging
-         */
-        "onNanoTblColDrag"?: (event: NanoTableCustomEvent<{
-    column: TableTypes.Prop;
-  }>) => void;
-        /**
-          * Fired when a column has been dropped (after dragging) `event.preventDefault()` to stop column re-order.
-         */
-        "onNanoTblColDrop"?: (event: NanoTableCustomEvent<{
-    fromCol: TableTypes.Prop;
-    toCol: TableTypes.Prop;
-    fromIndex: number;
-    toIndex: number;
   }>) => void;
         /**
           * Fired when the table has done it's first complete render
@@ -5773,6 +5986,7 @@ declare namespace LocalJSX {
         "nano-skeleton": NanoSkeleton;
         "nano-slide": NanoSlide;
         "nano-slides": NanoSlides;
+        "nano-sortable": NanoSortable;
         "nano-spinner": NanoSpinner;
         "nano-split-pane": NanoSplitPane;
         "nano-sticker": NanoSticker;
@@ -6007,6 +6221,13 @@ declare module "@stencil/core" {
              * Uses [Flickity](https://flickity.metafizzy.co/) under the hood.
              */
             "nano-slides": LocalJSX.NanoSlides & JSXBase.HTMLAttributes<HTMLNanoSlidesElement>;
+            /**
+             * An accessible and flexible re-order / sort utility component.
+             * - Drag and drop via mouse, touch or keyboard
+             * - Live announcements for screen readers
+             * - Works with or without an explicit handle (although with is preferable)
+             */
+            "nano-sortable": LocalJSX.NanoSortable & JSXBase.HTMLAttributes<HTMLNanoSortableElement>;
             /**
              * Spinners are used to show the progress of an indeterminate operation.
              */
@@ -6035,7 +6256,6 @@ declare module "@stencil/core" {
              * - Built-in column sort
              * - Easily swap in API / async based search / filter & sort
              * - Pin headers, footers, rows, columns
-             * - Drag-&-Drop columns to re-order
              * - Add custom rendering at every level
              * - Add custom properties at every level
              */

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

@@ -1 +1,21 @@
-export declare function drag(container: HTMLElement, onMove: (x: number, y: number) => void): void;
+interface DragOptions {
+  /** Callback that runs as dragging occurs. */
+  onMove: (x: number, y: number) => void;
+  /** Callback that runs when dragging stops. */
+  onStop: () => void;
+  /**
+   * When an initial event is passed, the first drag will be triggered immediately using the coordinates therein. This
+   * is useful when the drag is initiated by a mousedown/touchstart event but you want the initial "click" to activate
+   * a drag (e.g. positioning a handle initially at the click target).
+   */
+  initialEvent: TouchEvent | PointerEvent | MouseEvent;
+  /**
+   * Used in conjunction with `options.initialEvent`
+   * Subtracts the initial pointer co-ordinates from the move co-ordinates.
+   * This is useful for tracking how far an element has been dragged
+   */
+  relative?: boolean;
+}
+/** Begins listening for dragging. */
+export declare function drag(container: HTMLElement, options?: Partial<DragOptions>): void;
+export {};