@vue-dnd-kit/core 2.1.3 → 2.1.5

package/dist/external/types/operations.d.ts

@@ -1,185 +1,187 @@
 import { IPlacement, TInsertSide, TPlacementOrientation } from './placement';
-// ── Result types ───────────────────────────────────────────────────────────────
-
-/**
- * Result of suggestSort.
- * Same-list: sourceItems === targetItems (one array, reordered).
- * Cross-list: two different arrays — apply both.
- */
-export interface ISuggestSortResult<T = unknown> {
-  /** Source list after removing dragged items. Same ref as targetItems when sameList. */
-  sourceItems: T[];
-  /** Target list after inserting dragged items at targetIndex. */
-  targetItems: T[];
-  /** The items that were moved (in original order). */
-  draggedItems: T[];
-  sourceIndexes: number[];
-  targetIndex: number;
-  mode: 'insert' | 'append' | 'prepend';
-  sameList: boolean;
-}
-
-/**
- * Result of suggestSwap.
- * Same-list: one array with positions swapped (sourceItems === targetItems).
- * Cross-list: two arrays with the items exchanged.
- * Multi-drag: dragged group exchanges with the single hovered item.
- */
-export interface ISuggestSwapResult<T = unknown> {
-  /** Source list after swap. */
-  sourceItems: T[];
-  /** Target list after swap. Same ref as sourceItems when sameList. */
-  targetItems: T[];
-  sourceIndexes: number[];
-  targetIndex: number;
-  sameList: boolean;
-}
-
-/**
- * Result of suggestCopy.
- * Source list is NEVER modified — only target receives new items.
- */
-export interface ISuggestCopyResult<T = unknown> {
-  /** Target list after inserting copies. */
-  targetItems: T[];
-  /** Shallow copies of the dragged items that were inserted. */
-  copiedItems: T[];
-  targetIndex: number;
-  mode: 'insert' | 'append' | 'prepend';
-}
-
-/**
- * Result of suggestRemove.
- */
-export interface ISuggestRemoveResult<T = unknown> {
-  /** Source list after removing dragged items. */
-  sourceItems: T[];
-  /** The items that were removed. */
-  removedItems: T[];
-  sourceIndexes: number[];
-}
-
-/** Draggable element currently under the cursor (inside the drop zone). */
-export interface IHoveredDraggableContext<T = unknown> {
-  element: HTMLElement;
-  /** Cursor position relative to this element. */
-  placement: IPlacement;
-  index: number;
-  /** The actual object: items[index]. */
-  item: T;
-  items: T[];
-  /** Custom data from the `data` option (reactive, always up-to-date) */
-  data?: unknown;
-}
-
-/** Placement helpers: interpret placement flags by list orientation. */
-export interface IPlacementHelpers {
-  /** 'before' = top (vertical) / left (horizontal). 'after' = bottom / right. */
-  getInsertSide(
-    placement: IPlacement | undefined,
-    orientation: TPlacementOrientation
-  ): TInsertSide | null;
-  isAtZoneStart(
-    placement: IPlacement | undefined,
-    orientation: TPlacementOrientation
-  ): boolean;
-  isAtZoneEnd(
-    placement: IPlacement | undefined,
-    orientation: TPlacementOrientation
-  ): boolean;
-}
-
-/**
- * Helpers object available on every drag event via `event.helpers`.
- *
- * ── Low-level (stateless, no event context) ─────────────────────────────────
- * Array primitives and placement interpreters. Use these to build custom logic.
- *
- * ── High-level (event-bound) ────────────────────────────────────────────────
- * Preset operations that read the current event context.
- * The user decides which one to call based on `event.hoveredDraggable`:
- *
- * ```ts
- * onDrop(event) {
- *   if (event.hoveredDraggable) {
- *     // hovering over an element → sort / swap / copy into position
- *     const r = event.helpers.suggestSort()
- *     if (r) list.value = r.targetItems
- *   } else {
- *     // hovering over zone only → append / prepend / copy to zone
- *     const r = event.helpers.suggestSort()
- *     if (r) list.value = r.targetItems
- *   }
- * }
- * ```
- */
-export interface IHelpers {
-  // ── Low-level: array ops ──────────────────────────────────────────────────
-  /** Insert toInsert items into items at index. Returns new array. */
-  insertAt<T>(items: T[], index: number, toInsert: T[]): T[];
-  /** Remove count items at index. Returns new array. */
-  removeAt<T>(items: T[], index: number, count?: number): T[];
-  /** Remove multiple indexes (high → low, safe). Returns new array. */
-  removeIndexes<T>(items: T[], indexes: number[]): T[];
-  /** Swap items at positions i and j. Returns new array. */
-  swapAt<T>(items: T[], i: number, j: number): T[];
-
-  // ── Low-level: placement ──────────────────────────────────────────────────
-  /** 'before' or 'after' relative to the orientation axis, or null if ambiguous. */
-  getInsertSide(
-    placement: IPlacement | undefined,
-    orientation: TPlacementOrientation
-  ): TInsertSide | null;
-  /** True when pointer is at the very start edge of the zone (no center). */
-  isAtZoneStart(
-    placement: IPlacement | undefined,
-    orientation: TPlacementOrientation
-  ): boolean;
-  /** True when pointer is at the very end edge of the zone (no center). */
-  isAtZoneEnd(
-    placement: IPlacement | undefined,
-    orientation: TPlacementOrientation
-  ): boolean;
-
-  // ── High-level: event-bound presets ───────────────────────────────────────
-
-  /**
-   * **Sort / Transfer** — universal insert.
-   *
-   * - With `hoveredDraggable`: inserts dragged items before or after the
-   *   hovered element (determined by cursor placement).
-   * - Without `hoveredDraggable`: appends to zone start/end based on zone placement.
-   * - Same-list: reorders in place. Cross-list: transfers (removes from source, inserts into target).
-   *
-   * Returns null when context is insufficient (no draggedItems or no dropZone).
-   * Cast result arrays to your item type: `r.targetItems as MyItem[]`.
-   */
-  suggestSort(orientation?: TPlacementOrientation): ISuggestSortResult | null;
-
-  /**
-   * **Swap** — exchange the single dragged item with the hovered element.
-   *
-   * - Same-list: swaps two positions in one array.
-   * - Cross-list: exchanges items between two arrays.
-   *
-   * Returns null when multi-drag or no `hoveredDraggable`.
-   */
-  suggestSwap(): ISuggestSwapResult | null;
-
-  /**
-   * **Copy** — insert copies of dragged items at target position WITHOUT removing from source.
-   *
-   * Position logic is identical to `suggestSort`.
-   * Useful for copy-on-drag (e.g. held Ctrl key).
-   *
-   * Returns null when context is insufficient.
-   */
-  suggestCopy(orientation?: TPlacementOrientation): ISuggestCopyResult | null;
-
-  /**
-   * **Remove** — remove dragged items from their source list.
-   *
-   * Returns null when there are no draggedItems.
-   */
-  suggestRemove(): ISuggestRemoveResult | null;
-}
+
+
+// ── Result types ───────────────────────────────────────────────────────────────
+
+/**
+ * Result of suggestSort.
+ * Same-list: sourceItems === targetItems (one array, reordered).
+ * Cross-list: two different arrays — apply both.
+ */
+export interface ISuggestSortResult<T = unknown> {
+  /** Source list after removing dragged items. Same ref as targetItems when sameList. */
+  sourceItems: T[];
+  /** Target list after inserting dragged items at targetIndex. */
+  targetItems: T[];
+  /** The items that were moved (in original order). */
+  draggedItems: T[];
+  sourceIndexes: number[];
+  targetIndex: number;
+  mode: 'insert' | 'append' | 'prepend';
+  sameList: boolean;
+}
+
+/**
+ * Result of suggestSwap.
+ * Same-list: one array with positions swapped (sourceItems === targetItems).
+ * Cross-list: two arrays with the items exchanged.
+ * Multi-drag: dragged group exchanges with the single hovered item.
+ */
+export interface ISuggestSwapResult<T = unknown> {
+  /** Source list after swap. */
+  sourceItems: T[];
+  /** Target list after swap. Same ref as sourceItems when sameList. */
+  targetItems: T[];
+  sourceIndexes: number[];
+  targetIndex: number;
+  sameList: boolean;
+}
+
+/**
+ * Result of suggestCopy.
+ * Source list is NEVER modified — only target receives new items.
+ */
+export interface ISuggestCopyResult<T = unknown> {
+  /** Target list after inserting copies. */
+  targetItems: T[];
+  /** Shallow copies of the dragged items that were inserted. */
+  copiedItems: T[];
+  targetIndex: number;
+  mode: 'insert' | 'append' | 'prepend';
+}
+
+/**
+ * Result of suggestRemove.
+ */
+export interface ISuggestRemoveResult<T = unknown> {
+  /** Source list after removing dragged items. */
+  sourceItems: T[];
+  /** The items that were removed. */
+  removedItems: T[];
+  sourceIndexes: number[];
+}
+
+/** Draggable element currently under the cursor (inside the drop zone). */
+export interface IHoveredDraggableContext<T = unknown> {
+  element: HTMLElement;
+  /** Cursor position relative to this element. */
+  placement: IPlacement;
+  index: number;
+  /** The actual object: items[index]. */
+  item: T;
+  items: T[];
+  /** Custom data from the `data` option (reactive, always up-to-date) */
+  data?: unknown;
+}
+
+/** Placement helpers: interpret placement flags by list orientation. */
+export interface IPlacementHelpers {
+  /** 'before' = top (vertical) / left (horizontal). 'after' = bottom / right. */
+  getInsertSide(
+    placement: IPlacement | undefined,
+    orientation: TPlacementOrientation
+  ): TInsertSide | null;
+  isAtZoneStart(
+    placement: IPlacement | undefined,
+    orientation: TPlacementOrientation
+  ): boolean;
+  isAtZoneEnd(
+    placement: IPlacement | undefined,
+    orientation: TPlacementOrientation
+  ): boolean;
+}
+
+/**
+ * Helpers object available on every drag event via `event.helpers`.
+ *
+ * ── Low-level (stateless, no event context) ─────────────────────────────────
+ * Array primitives and placement interpreters. Use these to build custom logic.
+ *
+ * ── High-level (event-bound) ────────────────────────────────────────────────
+ * Preset operations that read the current event context.
+ * The user decides which one to call based on `event.hoveredDraggable`:
+ *
+ * ```ts
+ * onDrop(event) {
+ *   if (event.hoveredDraggable) {
+ *     // hovering over an element → sort / swap / copy into position
+ *     const r = event.helpers.suggestSort()
+ *     if (r) list.value = r.targetItems
+ *   } else {
+ *     // hovering over zone only → append / prepend / copy to zone
+ *     const r = event.helpers.suggestSort()
+ *     if (r) list.value = r.targetItems
+ *   }
+ * }
+ * ```
+ */
+export interface IHelpers {
+  // ── Low-level: array ops ──────────────────────────────────────────────────
+  /** Insert toInsert items into items at index. Returns new array. */
+  insertAt<T>(items: T[], index: number, toInsert: T[]): T[];
+  /** Remove count items at index. Returns new array. */
+  removeAt<T>(items: T[], index: number, count?: number): T[];
+  /** Remove multiple indexes (high → low, safe). Returns new array. */
+  removeIndexes<T>(items: T[], indexes: number[]): T[];
+  /** Swap items at positions i and j. Returns new array. */
+  swapAt<T>(items: T[], i: number, j: number): T[];
+
+  // ── Low-level: placement ──────────────────────────────────────────────────
+  /** 'before' or 'after' relative to the orientation axis, or null if ambiguous. */
+  getInsertSide(
+    placement: IPlacement | undefined,
+    orientation: TPlacementOrientation
+  ): TInsertSide | null;
+  /** True when pointer is at the very start edge of the zone (no center). */
+  isAtZoneStart(
+    placement: IPlacement | undefined,
+    orientation: TPlacementOrientation
+  ): boolean;
+  /** True when pointer is at the very end edge of the zone (no center). */
+  isAtZoneEnd(
+    placement: IPlacement | undefined,
+    orientation: TPlacementOrientation
+  ): boolean;
+
+  // ── High-level: event-bound presets ───────────────────────────────────────
+
+  /**
+   * **Sort / Transfer** — universal insert.
+   *
+   * - With `hoveredDraggable`: inserts dragged items before or after the
+   *   hovered element (determined by cursor placement).
+   * - Without `hoveredDraggable`: appends to zone start/end based on zone placement.
+   * - Same-list: reorders in place. Cross-list: transfers (removes from source, inserts into target).
+   *
+   * Returns null when context is insufficient (no draggedItems or no dropZone).
+   * Cast result arrays to your item type: `r.targetItems as MyItem[]`.
+   */
+  suggestSort(orientation?: TPlacementOrientation): ISuggestSortResult | null;
+
+  /**
+   * **Swap** — exchange the single dragged item with the hovered element.
+   *
+   * - Same-list: swaps two positions in one array.
+   * - Cross-list: exchanges items between two arrays.
+   *
+   * Returns null when multi-drag or no `hoveredDraggable`.
+   */
+  suggestSwap(): ISuggestSwapResult | null;
+
+  /**
+   * **Copy** — insert copies of dragged items at target position WITHOUT removing from source.
+   *
+   * Position logic is identical to `suggestSort`.
+   * Useful for copy-on-drag (e.g. held Ctrl key).
+   *
+   * Returns null when context is insufficient.
+   */
+  suggestCopy(orientation?: TPlacementOrientation): ISuggestCopyResult | null;
+
+  /**
+   * **Remove** — remove dragged items from their source list.
+   *
+   * Returns null when there are no draggedItems.
+   */
+  suggestRemove(): ISuggestRemoveResult | null;
+}

package/dist/external/types/placement.d.ts

@@ -1,34 +1,34 @@
-/**
- * Which side(s) of the element/zone the pointer is in.
- * Multiple flags can be true (e.g. top + right for corner). Do not normalize.
- * - vertical list: top = before, bottom = after
- * - horizontal list: left = before, right = after
- * - center: pointer in center zone (dual-role draggable+zone)
- */
-export interface IPlacement {
-  top: boolean;
-  right: boolean;
-  bottom: boolean;
-  left: boolean;
-  /** True when pointer is in center zone (inside placementMargins). Used for dual-role draggable+zone. */
-  center: boolean;
-}
-
-export type TPlacementOrientation = 'vertical' | 'horizontal';
-
-/** 'before' | 'after' for insert position along one axis */
-export type TInsertSide = 'before' | 'after';
-
-export interface IPlacementMargins {
-  top?: number;
-  right?: number;
-  bottom?: number;
-  left?: number;
-}
-
-/** Options for makeAutoScroll and DnDProvider autoScrollViewport prop */
-export interface IAutoScrollOptions {
-  threshold?: number | IPlacementMargins;
-  speed?: number;
-  disabled?: boolean;
-}
+/**
+ * Which side(s) of the element/zone the pointer is in.
+ * Multiple flags can be true (e.g. top + right for corner). Do not normalize.
+ * - vertical list: top = before, bottom = after
+ * - horizontal list: left = before, right = after
+ * - center: pointer in center zone (dual-role draggable+zone)
+ */
+export interface IPlacement {
+  top: boolean;
+  right: boolean;
+  bottom: boolean;
+  left: boolean;
+  /** True when pointer is in center zone (inside placementMargins). Used for dual-role draggable+zone. */
+  center: boolean;
+}
+
+export type TPlacementOrientation = 'vertical' | 'horizontal';
+
+/** 'before' | 'after' for insert position along one axis */
+export type TInsertSide = 'before' | 'after';
+
+export interface IPlacementMargins {
+  top?: number;
+  right?: number;
+  bottom?: number;
+  left?: number;
+}
+
+/** Options for makeAutoScroll and DnDProvider autoScrollViewport prop */
+export interface IAutoScrollOptions {
+  threshold?: number | IPlacementMargins;
+  speed?: number;
+  disabled?: boolean;
+}

package/dist/external/types/pointer.d.ts

@@ -1,10 +1,10 @@
-export interface ICoordinates {
-  x: number;
-  y: number;
-}
-
-export type TPointerState = {
-  start: ICoordinates;
-  current: ICoordinates;
-  offset: ICoordinates;
-} | undefined | null
+export interface ICoordinates {
+  x: number;
+  y: number;
+}
+
+export type TPointerState = {
+  start: ICoordinates;
+  current: ICoordinates;
+  offset: ICoordinates;
+} | undefined | null

package/dist/external/types/provider.d.ts

@@ -3,85 +3,87 @@ import { ICoordinates, TPointerState } from './pointer';
 import { IAutoScrollOptions } from './placement';
 import { IHelpers, IHoveredDraggableContext } from './operations';
 import { Component, ComputedRef, CSSProperties, Reactive, Ref, ShallowRef, VNode, VueElement, WritableComputedRef } from 'vue';
-/** Event object passed to all drag/drop handlers */
-export interface IDragEvent<DragT = unknown, ZoneT = unknown> {
-  /** All dragged items sorted by index. Length > 1 means multi-drag. */
-  draggedItems: IDragItem<DragT>[];
-  /** Drop zone context — present in onEnter / onDrop / onLeave. */
-  dropZone: IDropZoneContext<ZoneT> | undefined;
-  /** Draggable element under cursor inside the zone — use for insert-before/after. */
-  hoveredDraggable: IHoveredDraggableContext | undefined;
-  provider: IDnDProviderExternal;
-  /** Helpers bound to this event. Low-level array ops + high-level suggest* presets. */
-  helpers: IHelpers;
-}
-
-/** Map element → placement for elements under cursor during drag */
-export type THoveredMap = Map<HTMLElement, IPlacement>;
-
-export interface IHovered {
-  draggable: THoveredMap;
-  droppable: THoveredMap;
-}
-
-export interface ICollision {
-  throttle: Ref<number>;
-}
-
-export interface IDnDProviderExternal {
-  state: Ref<TDnDState | undefined>;
-  pointer: Ref<TPointerState | undefined>;
-  entities: Reactive<IEntities>;
-  keyboard: {
-    keys: {
-      pressedKeys: Ref<Set<string>>;
-      forDrag: string[];
-      forCancel: string[];
-      forDrop: string[];
-      forMove: string[];
-      forMoveFaster: string[];
-    };
-    step: number;
-    moveFaster: number;
-  };
-  scrollPosition: Reactive<ICoordinates>;
-  delay: Reactive<IDelay>;
-  distanceProgress: ComputedRef<number>;
-  overlay: {
-    ref: Ref<HTMLElement | null>;
-    position: ComputedRef<ICoordinates>;
-    size: Ref<DOMRect | null>;
-    render: Ref<Component | undefined>;
-    to: WritableComputedRef<string | false | null | undefined>;
-  };
-  hovered: IHovered;
-  collision: ICollision;
-  autoScrollViewport: ComputedRef<
-    IAutoScrollOptions | true | false | null | undefined
-  >;
-}
-
-export interface IDelay {
-  progress: number;
-  startTime: number;
-}
-
-export type TDnDState =
-  | 'dragging'
-  | 'selecting'
-  | 'activating'
-  | 'pending' /** awaiting async onDrop (e.g. confirm); drag still active */
-  | null
-  | undefined;
-
-export type TDropResult = 'accept' | 'cancel' | 'decline';
-
-/** DnDProvider props */
-export interface IDnDProviderProps {
-  /** Enable viewport auto-scroll: true = defaults, object = options. false | null | undefined = disabled. */
-  autoScrollViewport?: IAutoScrollOptions | true | false | null;
-  /** Teleport overlay to element: 'body' = defaults, string = element id. false | null | undefined = disabled. */
-  overlayTo?: string | false | null;
-  style?: any;
-  class?: any;
-}
+
+
+/** Event object passed to all drag/drop handlers */
+export interface IDragEvent<DragT = unknown, ZoneT = unknown> {
+  /** All dragged items sorted by index. Length > 1 means multi-drag. */
+  draggedItems: IDragItem<DragT>[];
+  /** Drop zone context — present in onEnter / onDrop / onLeave. */
+  dropZone: IDropZoneContext<ZoneT> | undefined;
+  /** Draggable element under cursor inside the zone — use for insert-before/after. */
+  hoveredDraggable: IHoveredDraggableContext | undefined;
+  provider: IDnDProviderExternal;
+  /** Helpers bound to this event. Low-level array ops + high-level suggest* presets. */
+  helpers: IHelpers;
+}
+
+/** Map element → placement for elements under cursor during drag */
+export type THoveredMap = Map<HTMLElement, IPlacement>;
+
+export interface IHovered {
+  draggable: THoveredMap;
+  droppable: THoveredMap;
+}
+
+export interface ICollision {
+  throttle: Ref<number>;
+}
+
+export interface IDnDProviderExternal {
+  state: Ref<TDnDState | undefined>;
+  pointer: Ref<TPointerState | undefined>;
+  entities: Reactive<IEntities>;
+  keyboard: {
+    keys: {
+      pressedKeys: Ref<Set<string>>;
+      forDrag: string[];
+      forCancel: string[];
+      forDrop: string[];
+      forMove: string[];
+      forMoveFaster: string[];
+    };
+    step: number;
+    moveFaster: number;
+  };
+  scrollPosition: Reactive<ICoordinates>;
+  delay: Reactive<IDelay>;
+  distanceProgress: ComputedRef<number>;
+  preview: {
+    ref: Ref<HTMLElement | null>;
+    position: ComputedRef<ICoordinates>;
+    size: ShallowRef<DOMRect>;
+    render: Ref<Component | undefined>;
+    to: WritableComputedRef<string | false | null | undefined>;
+  };
+  hovered: IHovered;
+  collision: ICollision;
+  autoScrollViewport: ComputedRef<
+    IAutoScrollOptions | true | false | null | undefined
+  >;
+}
+
+export interface IDelay {
+  progress: number;
+  startTime: number;
+}
+
+export type TDnDState =
+  | 'dragging'
+  | 'selecting'
+  | 'activating'
+  | 'pending' /** awaiting async onDrop (e.g. confirm); drag still active */
+  | null
+  | undefined;
+
+export type TDropResult = 'accept' | 'cancel' | 'decline';
+
+/** DnDProvider props */
+export interface IDnDProviderProps {
+  /** Enable viewport auto-scroll: true = defaults, object = options. false | null | undefined = disabled. */
+  autoScrollViewport?: IAutoScrollOptions | true | false | null;
+  /** Teleport preview to element: 'body' = defaults, string = element id. false | null | undefined = disabled. */
+  previewTo?: string | false | null;
+  style?: any;
+  class?: any;
+}