@esri/calcite-components 1.7.0-next.17 → 1.7.0-next.19

package/dist/types/components/stepper-item/stepper-item.d.ts

@@ -23,25 +23,37 @@ export declare class StepperItem implements InteractiveComponent, LocalizedCompo
   heading: string;
   /** A description for the component. Displays below the header text. */
   description: string;
-  /** Defines the layout of the component. */
-  /** @internal */
-  layout: Extract<"horizontal" | "vertical", Layout>;
-  /** When `true`, displays a status icon in the component's heading. */
-  /** @internal */
-  icon: boolean;
   /** When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). */
   iconFlipRtl: boolean;
-  /** When `true`, displays the step number in the component's heading. */
-  /** @internal */
-  numbered: boolean;
-  /** Specifies the size of the component. */
-  /** @internal */
-  scale: Scale;
   /**
    * @internal
    */
   numberingSystem: NumberingSystem;
   disabledWatcher(): void;
+  /**
+   * When `true`, displays a status icon in the `calcite-stepper-item` heading inherited from parent `calcite-stepper`.
+   *
+   * @internal
+   */
+  icon: boolean;
+  /**
+   * Specifies the layout of the `calcite-stepper-item` inherited from parent `calcite-stepper`, defaults to `horizontal`.
+   *
+   * @internal
+   */
+  layout: Extract<"horizontal" | "vertical", Layout>;
+  /**
+   * When `true`, displays the step number in the `calcite-stepper-item` heading inherited from parent `calcite-stepper`.
+   *
+   * @internal
+   */
+  numbered: boolean;
+  /**
+   * Specifies the size of the component inherited from the `calcite-stepper`, defaults to `m`.
+   *
+   * @internal
+   */
+  scale: Scale;
   effectiveLocale: string;
   effectiveLocaleWatcher(locale: string): void;
   headerEl: HTMLDivElement;

package/dist/types/components/value-list/value-list.d.ts

@@ -8,7 +8,7 @@ import { ItemData, ListFocusId } from "../pick-list/shared-list-logic";
 import { ListItemAndHandle } from "../value-list-item/interfaces";
 import { ValueListMessages } from "./assets/value-list/t9n";
 import { ICON_TYPES } from "./resources";
-import { DragEvent, SortableComponent } from "../../utils/sortableComponent";
+import { DragDetail, SortableComponent } from "../../utils/sortableComponent";
 /**
  * @deprecated Use the `list` component instead.
  * @slot - A slot for adding `calcite-value-list-item` elements. List items are displayed as a vertical list.
@@ -22,11 +22,11 @@ export declare class ValueList<ItemElement extends HTMLCalciteValueListItemEleme
   /**
    * When provided, the method will be called to determine whether the element can  move from the list.
    */
-  canPull: (event: DragEvent) => boolean;
+  canPull: (detail: DragDetail) => boolean;
   /**
    * When provided, the method will be called to determine whether the element can be added from another list.
    */
-  canPut: (event: DragEvent) => boolean;
+  canPut: (detail: DragDetail) => boolean;
   /**
    * When `true`, `calcite-value-list-item`s are sortable via a draggable button.
    */

package/dist/types/components.d.ts

@@ -48,7 +48,7 @@ import { InputTextMessages } from "./components/input-text/assets/input-text/t9n
 import { InputTimePickerMessages } from "./components/input-time-picker/assets/input-time-picker/t9n";
 import { TimePickerMessages } from "./components/time-picker/assets/time-picker/t9n";
 import { InputTimeZoneMessages } from "./components/input-time-zone/assets/input-time-zone/t9n";
-import { DragEvent } from "./utils/sortableComponent";
+import { DragDetail } from "./utils/sortableComponent";
 import { ItemData } from "./components/list-item/interfaces";
 import { SelectionAppearance } from "./components/list/resources";
 import { ListItemMessages } from "./components/list-item/assets/list-item/t9n";
@@ -2087,6 +2087,10 @@ export namespace Components {
           * @mdn [step](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode)
          */
         "inputMode": string;
+        /**
+          * When `true`, restricts the component to integer numbers only and disables exponential notation.
+         */
+        "integer": boolean;
         /**
           * Accessible name for the component's button or hyperlink.
          */
@@ -2499,11 +2503,11 @@ export namespace Components {
         /**
           * When provided, the method will be called to determine whether the element can  move from the list.
          */
-        "canPull": (event: DragEvent) => boolean;
+        "canPull": (detail: DragDetail) => boolean;
         /**
           * When provided, the method will be called to determine whether the element can be added from another list.
          */
-        "canPut": (event: DragEvent) => boolean;
+        "canPut": (detail: DragDetail) => boolean;
         /**
           * When `true`, interaction is prevented and the component is displayed with lower opacity.
          */
@@ -3950,11 +3954,11 @@ export namespace Components {
         /**
           * When provided, the method will be called to determine whether the element can  move from the list.
          */
-        "canPull": (event: DragEvent) => boolean;
+        "canPull": (detail: DragDetail) => boolean;
         /**
           * When provided, the method will be called to determine whether the element can be added from another list.
          */
-        "canPut": (event: DragEvent) => boolean;
+        "canPut": (detail: DragDetail) => boolean;
         /**
           * When true, disabled prevents interaction. This state shows items with lower opacity/grayed.
          */
@@ -4124,14 +4128,26 @@ export namespace Components {
           * The component header text.
          */
         "heading": string;
+        /**
+          * When `true`, displays a status icon in the `calcite-stepper-item` heading inherited from parent `calcite-stepper`.
+         */
         "icon": boolean;
         /**
           * When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`).
          */
         "iconFlipRtl": boolean;
+        /**
+          * Specifies the layout of the `calcite-stepper-item` inherited from parent `calcite-stepper`, defaults to `horizontal`.
+         */
         "layout": Extract<"horizontal" | "vertical", Layout>;
+        /**
+          * When `true`, displays the step number in the `calcite-stepper-item` heading inherited from parent `calcite-stepper`.
+         */
         "numbered": boolean;
         "numberingSystem": NumberingSystem;
+        /**
+          * Specifies the size of the component inherited from the `calcite-stepper`, defaults to `m`.
+         */
         "scale": Scale;
         /**
           * When `true`, the component is selected.
@@ -4850,11 +4866,11 @@ export namespace Components {
         /**
           * When provided, the method will be called to determine whether the element can  move from the list.
          */
-        "canPull": (event: DragEvent) => boolean;
+        "canPull": (detail: DragDetail) => boolean;
         /**
           * When provided, the method will be called to determine whether the element can be added from another list.
          */
-        "canPut": (event: DragEvent) => boolean;
+        "canPut": (detail: DragDetail) => boolean;
         /**
           * When `true`, interaction is prevented and the component is displayed with lower opacity.
          */
@@ -7898,6 +7914,10 @@ declare namespace LocalJSX {
           * @mdn [step](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode)
          */
         "inputMode"?: string;
+        /**
+          * When `true`, restricts the component to integer numbers only and disables exponential notation.
+         */
+        "integer"?: boolean;
         /**
           * Accessible name for the component's button or hyperlink.
          */
@@ -8276,11 +8296,11 @@ declare namespace LocalJSX {
         /**
           * When provided, the method will be called to determine whether the element can  move from the list.
          */
-        "canPull"?: (event: DragEvent) => boolean;
+        "canPull"?: (detail: DragDetail) => boolean;
         /**
           * When provided, the method will be called to determine whether the element can be added from another list.
          */
-        "canPut"?: (event: DragEvent) => boolean;
+        "canPut"?: (detail: DragDetail) => boolean;
         /**
           * When `true`, interaction is prevented and the component is displayed with lower opacity.
          */
@@ -8326,7 +8346,7 @@ declare namespace LocalJSX {
         /**
           * Emitted when the default slot has changes in order to notify parent lists.
          */
-        "onCalciteInternalListDefaultSlotChange"?: (event: CalciteListCustomEvent<DragEvent>) => void;
+        "onCalciteInternalListDefaultSlotChange"?: (event: CalciteListCustomEvent<void>) => void;
         /**
           * Emits when any of the list item selections have changed.
          */
@@ -8338,7 +8358,7 @@ declare namespace LocalJSX {
         /**
           * Emitted when the order of the list has changed.
          */
-        "onCalciteListOrderChange"?: (event: CalciteListCustomEvent<DragEvent>) => void;
+        "onCalciteListOrderChange"?: (event: CalciteListCustomEvent<DragDetail>) => void;
         /**
           * The currently selected items.
           * @readonly
@@ -9612,11 +9632,11 @@ declare namespace LocalJSX {
         /**
           * When provided, the method will be called to determine whether the element can  move from the list.
          */
-        "canPull"?: (event: DragEvent) => boolean;
+        "canPull"?: (detail: DragDetail) => boolean;
         /**
           * When provided, the method will be called to determine whether the element can be added from another list.
          */
-        "canPut"?: (event: DragEvent) => boolean;
+        "canPut"?: (detail: DragDetail) => boolean;
         /**
           * When true, disabled prevents interaction. This state shows items with lower opacity/grayed.
          */
@@ -10406,11 +10426,11 @@ declare namespace LocalJSX {
         /**
           * When provided, the method will be called to determine whether the element can  move from the list.
          */
-        "canPull"?: (event: DragEvent) => boolean;
+        "canPull"?: (detail: DragDetail) => boolean;
         /**
           * When provided, the method will be called to determine whether the element can be added from another list.
          */
-        "canPut"?: (event: DragEvent) => boolean;
+        "canPut"?: (detail: DragDetail) => boolean;
         /**
           * When `true`, interaction is prevented and the component is displayed with lower opacity.
          */

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

@@ -1,5 +1,5 @@
 import Sortable from "sortablejs";
-export interface DragEvent {
+export interface DragDetail {
   toEl: HTMLElement;
   fromEl: HTMLElement;
   dragEl: HTMLElement;
@@ -35,23 +35,23 @@ export interface SortableComponent {
   /**
    * Whether the element can move from the list.
    */
-  canPull: (event: DragEvent) => boolean;
+  canPull: (detail: DragDetail) => boolean;
   /**
    * Whether the element can be added from another list.
    */
-  canPut: (event: DragEvent) => boolean;
+  canPut: (detail: DragDetail) => boolean;
   /**
    * Called by any change to the list (add / update / remove).
    */
-  onDragSort: (event: Sortable.SortableEvent) => void;
+  onDragSort: (detail: DragDetail) => void;
   /**
-   * Element dragging started.
+   * Called when a sortable component drag starts.
    */
-  onDragStart?: (event: Sortable.SortableEvent) => void;
+  onDragStart: () => void;
   /**
-   * Element dragging ended.
+   * Called when a sortable component drag ends.
    */
-  onDragEnd?: (event: Sortable.SortableEvent) => void;
+  onDragEnd: () => void;
 }
 /**
  * Helper to keep track of a SortableComponent. This should be called in the `connectedCallback` lifecycle method as well as any other method necessary to rebuild the sortable instance.
@@ -65,3 +65,10 @@ export declare function connectSortableComponent(component: SortableComponent):
  * @param {SortableComponent} component - The sortable component.
  */
 export declare function disconnectSortableComponent(component: SortableComponent): void;
+/**
+ * Helper to determine if dragging is currently active.
+ *
+ * @param component The sortable component.
+ * @returns {boolean} a boolean value.
+ */
+export declare function dragActive(component: SortableComponent): boolean;