ngx-virtual-dnd 3.1.2 → 3.1.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ngx-virtual-dnd",
-  "version": "3.1.2",
+  "version": "3.1.3",
   "description": "A performant drag-and-drop library for Angular that works seamlessly with virtual scrolling",
   "keywords": [
     "angular",
@@ -19,11 +19,11 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/gultyayev/angular-vdnd.git"
+    "url": "git+https://github.com/gultyayev/ngx-virtual-dnd.git"
   },
-  "homepage": "https://github.com/gultyayev/angular-vdnd#readme",
+  "homepage": "https://github.com/gultyayev/ngx-virtual-dnd#readme",
   "bugs": {
-    "url": "https://github.com/gultyayev/angular-vdnd/issues"
+    "url": "https://github.com/gultyayev/ngx-virtual-dnd/issues"
   },
   "peerDependencies": {
     "@angular/common": "^21.0.0 || ^22.0.0",

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

@@ -59,7 +59,7 @@ interface DragState {
     grabOffset: GrabOffset | null;
     /** Position when drag started (for axis locking) */
     initialPosition: CursorPosition | null;
-    /** Axis to lock movement to ('x' = horizontal only, 'y' = vertical only) */
+    /** Axis to freeze ('x' = X frozen → vertical-only, 'y' = Y frozen → horizontal-only) */
     lockAxis: 'x' | 'y' | null;
     /** Whether this is a keyboard-initiated drag */
     isKeyboardDrag: boolean;
@@ -124,13 +124,22 @@ interface DragEndEvent {
     draggableId: string;
     /** ID of the droppable container the item originated from */
     droppableId: string;
-    /** Whether the drag was cancelled (escaped, dropped outside) */
+    /**
+     * Whether the drag was actively cancelled (Escape key). 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".
+     */
     cancelled: boolean;
     /** Optional user-provided data associated with the item */
     data?: unknown;
     /** Original 0-indexed position in source list (for cancel announcements) */
     sourceIndex: number;
-    /** Final 0-indexed position (null if cancelled) */
+    /**
+     * Final 0-indexed insertion position, or `null` when there is no valid drop target —
+     * a cancelled drag, a release outside every droppable, or a release over a disabled
+     * droppable. A non-null value pairs with a `DropEvent` on the destination.
+     */
     destinationIndex: number | null;
 }
 /**
@@ -317,6 +326,8 @@ declare class DragStateService {
     #private;
     /** Whether the last drag was cancelled (for droppable to check before emitting drop) */
     readonly wasCancelled: _angular_core.Signal<boolean>;
+    /** Snapshot captured synchronously before the last drag reset. */
+    readonly endedDragState: _angular_core.Signal<DragState | null>;
     /** Whether a drag operation is in progress */
     readonly isDragging: _angular_core.Signal<boolean>;
     /** The currently dragged item, or null */
@@ -430,6 +441,25 @@ declare class PositionCalculatorService {
      * scroll event has not yet fired but the container has already moved.
      */
     invalidateDroppableRects(): void;
+    /**
+     * Re-query the candidate droppable *list* for the active session and re-read their
+     * rects. Unlike {@link invalidateDroppableRects} (which only refreshes rects), this
+     * picks up droppables added or removed since the snapshot was captured at drag start —
+     * the frozen candidate list is otherwise blind to mid-drag mounts/unmounts.
+     *
+     * Safe to call when no session is active (no-op).
+     */
+    refreshCandidates(): void;
+    /**
+     * Signal that the set of droppables for `groupName` may have changed (a droppable
+     * registered or unregistered mid-drag). Defers the actual re-query to the next
+     * hit-test — where a removed element is already gone from the DOM and a newly added
+     * one has its data attributes applied — keeping this notification path cheap.
+     *
+     * Called by {@link DroppableDirective} lifecycle hooks. No-op when the active session
+     * belongs to a different group or no session is active.
+     */
+    notifyCandidatesChanged(groupName: string): void;
     /**
      * Find the droppable element at a given point.
      *
@@ -538,8 +568,14 @@ declare class PositionCalculatorService {
     findAdjacentDroppable(currentDroppableId: string, direction: 'left' | 'right', groupName: string): {
         element: HTMLElement;
         id: string;
-        itemCount: number;
     } | null;
+    /**
+     * Whether the droppable with the given ID is currently disabled. A droppable that cannot
+     * be found is reported as disabled (treat missing as not a valid target). Used to
+     * revalidate a keyboard drag's active target at drop time, since it may have been disabled
+     * after the drag navigated into it.
+     */
+    isDroppableDisabledById(id: string): boolean;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<PositionCalculatorService, never>;
     static ɵprov: _angular_core.ɵɵInjectableDeclaration<PositionCalculatorService>;
 }
@@ -550,7 +586,7 @@ declare class PositionCalculatorService {
 interface AutoScrollConfig {
     /** Distance from edge to start scrolling (in pixels) */
     threshold: number;
-    /** Maximum scroll speed (in pixels per frame) */
+    /** Maximum scroll speed in pixels per 60fps frame (about 16.67ms) */
     maxSpeed: number;
     /** Whether to accelerate scroll based on distance from edge */
     accelerate: boolean;
@@ -1285,7 +1321,12 @@ declare class DraggableDirective implements OnInit, OnDestroy {
      * Set to 0 for immediate drag (default behavior).
      */
     dragDelay: _angular_core.InputSignal<number>;
-    /** Lock dragging to a single axis ('x' = horizontal only, 'y' = vertical only) */
+    /**
+     * Lock dragging by freezing one axis. The value names the axis that stays
+     * fixed: `'x'` freezes the X coordinate (vertical-only movement), `'y'`
+     * freezes the Y coordinate (horizontal-only movement). `null` allows free
+     * movement. Note: this is the opposite of Angular CDK's `cdkDragLockAxis`.
+     */
     lockAxis: _angular_core.InputSignal<"x" | "y" | null>;
     /** Emits when drag starts */
     dragStart: _angular_core.OutputEmitterRef<DragStartEvent>;