ngx-virtual-dnd 3.2.0 → 3.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ngx-virtual-dnd",
-  "version": "3.2.0",
+  "version": "3.2.1",
   "description": "A performant drag-and-drop library for Angular that works seamlessly with virtual scrolling",
   "keywords": [
     "angular",

package/types/ngx-virtual-dnd.d.ts

@@ -49,9 +49,13 @@ interface DragState {
     sourceIndex: number | null;
     /** ID of the droppable currently being hovered over */
     activeDroppableId: string | null;
-    /** ID of the item the placeholder should appear before, or 'END_OF_LIST' */
+    /**
+     * `END_OF_LIST` while a droppable is targeted, otherwise null.
+     * @deprecated It never identifies an item. Use `placeholderIndex`. Will be removed in the next
+     * major version.
+     */
     placeholderId: string | null;
-    /** Index where the placeholder should be inserted (more stable than placeholderId) */
+    /** Index where the placeholder should be inserted */
     placeholderIndex: number | null;
     /** Current cursor position */
     cursorPosition: CursorPosition | null;
@@ -100,7 +104,11 @@ interface DropSource {
 interface DropDestination {
     /** ID of the droppable container receiving the item */
     droppableId: string;
-    /** ID of the item to insert before, or 'END_OF_LIST' */
+    /**
+     * The library always sets `END_OF_LIST`.
+     * @deprecated It never identifies an item. Use `index` for the insertion position. Will be
+     * removed in the next major version.
+     */
     placeholderId: string;
     /** Target index in the destination list */
     index: number;
@@ -150,7 +158,9 @@ interface DragEndEvent {
     /** ID of the droppable container the item originated from */
     droppableId: string;
     /**
-     * Whether the drag was actively cancelled (Escape key). Releasing over no valid
+     * Whether the drag was cancelled: Escape, Tab during a keyboard drag, or, during a pointer
+     * drag, the window losing focus, the page being hidden or the system cancelling the touch
+     * (`touchcancel`). Releasing over no valid
      * target (outside any droppable, or over a disabled droppable) is NOT a cancel —
      * it reports `cancelled: false` with `destinationIndex: null`. Branch on
      * `destinationIndex === null` to detect "no drop occurred".
@@ -172,7 +182,10 @@ interface DragEndEvent {
  */
 declare const INITIAL_DRAG_STATE: DragState;
 /**
- * Placeholder ID used when dropping at the end of a list.
+ * The value of every `placeholderId` the library sets. Positions are reported as indexes
+ * (`placeholderIndex`, `DropDestination.index`).
+ * @deprecated Goes with the deprecated `placeholderId` fields. Use the indexes. Will be removed in
+ * the next major version.
  */
 declare const END_OF_LIST = "END_OF_LIST";
 
@@ -408,7 +421,11 @@ declare class DragStateService {
     readonly sourceIndex: _angular_core.Signal<number | null>;
     /** ID of the droppable currently being hovered over */
     readonly activeDroppableId: _angular_core.Signal<string | null>;
-    /** ID of the item the placeholder should appear before */
+    /**
+     * `END_OF_LIST` while a droppable is targeted, otherwise null.
+     * @deprecated It never identifies an item. Use `placeholderIndex`. Will be removed in the next
+     * major version.
+     */
     readonly placeholderId: _angular_core.Signal<string | null>;
     /** Index where the placeholder should be inserted */
     readonly placeholderIndex: _angular_core.Signal<number | null>;
@@ -427,10 +444,12 @@ declare class DragStateService {
     constructor();
     /**
      * Start a drag operation.
+     * `placeholderId` is deprecated with the `placeholderId` signal; the library passes `END_OF_LIST`.
      */
     startDrag(item: DraggedItem, cursorPosition?: CursorPosition, grabOffset?: GrabOffset, lockAxis?: 'x' | 'y' | null, activeDroppableId?: string | null, placeholderId?: string | null, placeholderIndex?: number | null, sourceIndex?: number | null, isKeyboardDrag?: boolean, axisLockPosition?: CursorPosition): void;
     /**
      * Update the drag position and targets.
+     * `placeholderId` is deprecated with the `placeholderId` signal; the library passes `END_OF_LIST`.
      */
     updateDragPosition(update: {
         cursorPosition: CursorPosition;
@@ -443,7 +462,9 @@ declare class DragStateService {
      */
     setActiveDroppable(droppableId: string | null): void;
     /**
-     * Update just the placeholder position.
+     * Update just the placeholder ID.
+     * @deprecated Sets only the deprecated `placeholderId`. Will be removed in the next major
+     * version.
      */
     setPlaceholder(placeholderId: string | null): void;
     /**
@@ -452,6 +473,7 @@ declare class DragStateService {
      * Used by the autoscroll scroll-only fast path: when a scroll fires, the cursor has not
      * moved, so only the placeholder index needs recalculation. Skipping the cursor and
      * active-droppable writes avoids spurious re-evaluation of computeds that read those signals.
+     * `placeholderId` is deprecated with the `placeholderId` signal; the library passes `END_OF_LIST`.
      */
     updateScrollOnlyPlaceholder(placeholderId: string | null, placeholderIndex: number | null): void;
     /**
@@ -1503,7 +1525,11 @@ declare class DroppableDirective implements OnDestroy {
     placeholderMove: _angular_core.OutputEmitterRef<PlaceholderMoveEvent>;
     /** Whether this droppable is currently being targeted */
     readonly isActive: _angular_core.Signal<boolean>;
-    /** The current placeholder ID when this droppable is active */
+    /**
+     * `END_OF_LIST` while this droppable is active, otherwise null.
+     * @deprecated It never identifies an item. For the position, use the `placeholderMove` output
+     * (and `DropEvent.destination.index` on drop). Will be removed in the next major version.
+     */
     readonly placeholderId: _angular_core.Signal<string | null>;
     constructor();
     ngOnDestroy(): void;