@dnd-kit/abstract 0.1.21 → 0.2.0-beta-20251025202520

package/index.d.cts

@@ -247,10 +247,7 @@ declare abstract class Plugin<T extends DragDropManager<any, any> = DragDropMana
      * @param callback - The effect callback to register
      * @returns A function to dispose of the effect
      */
-    protected registerEffect(callback: () => void): {
-        (): void;
-        [Symbol.dispose](): void;
-    };
+    protected registerEffect(callback: () => void): () => void;
     /**
      * Destroys a plugin instance and cleans up its resources.
      *
@@ -915,6 +912,38 @@ declare class Droppable<T extends Data = Data, U extends DragDropManager<any, an
     get isDropTarget(): boolean;
 }
 
+declare class ActivationController<E extends Event> extends AbortController {
+    private constraints;
+    private onActivate;
+    activated: boolean;
+    constructor(constraints: ActivationConstraints<E> | undefined, onActivate: (event: E) => void);
+    onEvent(event: E): void;
+    activate(event: E): void;
+    abort(event?: E): void;
+}
+interface ActivationConstraintOptions {
+}
+declare abstract class ActivationConstraint<E extends Event = Event, O extends ActivationConstraintOptions = ActivationConstraintOptions> {
+    #private;
+    protected options: O;
+    set controller(controller: ActivationController<E>);
+    constructor(options: O);
+    /**
+     * Called when the activation is triggered.
+     */
+    activate(event: E): void;
+    /**
+     * Called when the activation is aborted.
+     */
+    abstract abort(event?: E): void;
+    /**
+     * Called when an input event is received by the sensor.
+     * Returns `true` if this event triggers activation immediately.
+     */
+    abstract onEvent(event: E): void;
+}
+type ActivationConstraints<E extends Event> = ActivationConstraint<E>[];
+
 /**
  * Provides actions for controlling drag and drop operations.
  *
@@ -1276,4 +1305,4 @@ declare class DragDropManager<T extends Draggable, U extends Droppable> {
     destroy: () => void;
 }
 
-export { type Collision, type CollisionDetector, CollisionPriority, CollisionType, CorePlugin, type Data, DragActions, type DragDropEvents, DragDropManager, type DragDropManagerInput, type DragOperationSnapshot as DragOperation, Status as DragOperationStatus, Draggable, type Input$1 as DraggableInput, Droppable, type Input as DroppableInput, Entity, Modifier, type ModifierConstructor, type Modifiers, Plugin, type PluginConstructor, type PluginDescriptor, type PluginOptions, PluginRegistry, type Plugins, type Renderer, Sensor, type SensorConstructor, type SensorDescriptor, type SensorOptions, type Sensors, type Type, type UniqueIdentifier, configurator, configure, descriptor, sortCollisions };
+export { ActivationConstraint, type ActivationConstraints, ActivationController, type Collision, type CollisionDetector, CollisionPriority, CollisionType, CorePlugin, type Data, DragActions, type DragDropEvents, DragDropManager, type DragDropManagerInput, type DragOperationSnapshot as DragOperation, Status as DragOperationStatus, Draggable, type Input$1 as DraggableInput, Droppable, type Input as DroppableInput, Entity, Modifier, type ModifierConstructor, type Modifiers, Plugin, type PluginConstructor, type PluginDescriptor, type PluginOptions, PluginRegistry, type Plugins, type Renderer, Sensor, type SensorConstructor, type SensorDescriptor, type SensorOptions, type Sensors, type Type, type UniqueIdentifier, configurator, configure, descriptor, sortCollisions };

package/index.d.ts

@@ -247,10 +247,7 @@ declare abstract class Plugin<T extends DragDropManager<any, any> = DragDropMana
      * @param callback - The effect callback to register
      * @returns A function to dispose of the effect
      */
-    protected registerEffect(callback: () => void): {
-        (): void;
-        [Symbol.dispose](): void;
-    };
+    protected registerEffect(callback: () => void): () => void;
     /**
      * Destroys a plugin instance and cleans up its resources.
      *
@@ -915,6 +912,38 @@ declare class Droppable<T extends Data = Data, U extends DragDropManager<any, an
     get isDropTarget(): boolean;
 }
 
+declare class ActivationController<E extends Event> extends AbortController {
+    private constraints;
+    private onActivate;
+    activated: boolean;
+    constructor(constraints: ActivationConstraints<E> | undefined, onActivate: (event: E) => void);
+    onEvent(event: E): void;
+    activate(event: E): void;
+    abort(event?: E): void;
+}
+interface ActivationConstraintOptions {
+}
+declare abstract class ActivationConstraint<E extends Event = Event, O extends ActivationConstraintOptions = ActivationConstraintOptions> {
+    #private;
+    protected options: O;
+    set controller(controller: ActivationController<E>);
+    constructor(options: O);
+    /**
+     * Called when the activation is triggered.
+     */
+    activate(event: E): void;
+    /**
+     * Called when the activation is aborted.
+     */
+    abstract abort(event?: E): void;
+    /**
+     * Called when an input event is received by the sensor.
+     * Returns `true` if this event triggers activation immediately.
+     */
+    abstract onEvent(event: E): void;
+}
+type ActivationConstraints<E extends Event> = ActivationConstraint<E>[];
+
 /**
  * Provides actions for controlling drag and drop operations.
  *
@@ -1276,4 +1305,4 @@ declare class DragDropManager<T extends Draggable, U extends Droppable> {
     destroy: () => void;
 }
 
-export { type Collision, type CollisionDetector, CollisionPriority, CollisionType, CorePlugin, type Data, DragActions, type DragDropEvents, DragDropManager, type DragDropManagerInput, type DragOperationSnapshot as DragOperation, Status as DragOperationStatus, Draggable, type Input$1 as DraggableInput, Droppable, type Input as DroppableInput, Entity, Modifier, type ModifierConstructor, type Modifiers, Plugin, type PluginConstructor, type PluginDescriptor, type PluginOptions, PluginRegistry, type Plugins, type Renderer, Sensor, type SensorConstructor, type SensorDescriptor, type SensorOptions, type Sensors, type Type, type UniqueIdentifier, configurator, configure, descriptor, sortCollisions };
+export { ActivationConstraint, type ActivationConstraints, ActivationController, type Collision, type CollisionDetector, CollisionPriority, CollisionType, CorePlugin, type Data, DragActions, type DragDropEvents, DragDropManager, type DragDropManagerInput, type DragOperationSnapshot as DragOperation, Status as DragOperationStatus, Draggable, type Input$1 as DraggableInput, Droppable, type Input as DroppableInput, Entity, Modifier, type ModifierConstructor, type Modifiers, Plugin, type PluginConstructor, type PluginDescriptor, type PluginOptions, PluginRegistry, type Plugins, type Renderer, Sensor, type SensorConstructor, type SensorDescriptor, type SensorOptions, type Sensors, type Type, type UniqueIdentifier, configurator, configure, descriptor, sortCollisions };

package/index.js

@@ -1121,6 +1121,58 @@ var Sensor = class extends Plugin {
   }
 };
 
+// src/core/sensors/activation.ts
+var ActivationController = class extends AbortController {
+  constructor(constraints, onActivate) {
+    super();
+    this.constraints = constraints;
+    this.onActivate = onActivate;
+    this.activated = false;
+    for (const constraint of constraints != null ? constraints : []) {
+      constraint.controller = this;
+    }
+  }
+  onEvent(event) {
+    var _a;
+    if (this.activated) return;
+    if ((_a = this.constraints) == null ? void 0 : _a.length) {
+      for (const constraint of this.constraints) {
+        constraint.onEvent(event);
+      }
+    } else {
+      this.activate(event);
+    }
+  }
+  activate(event) {
+    if (this.activated) return;
+    this.activated = true;
+    this.onActivate(event);
+  }
+  abort(event) {
+    this.activated = false;
+    super.abort(event);
+  }
+};
+var _controller;
+var ActivationConstraint = class {
+  constructor(options) {
+    this.options = options;
+    __privateAdd(this, _controller);
+  }
+  set controller(controller) {
+    __privateSet(this, _controller, controller);
+    controller.signal.addEventListener("abort", () => this.abort());
+  }
+  /**
+   * Called when the activation is triggered.
+   */
+  activate(event) {
+    var _a;
+    (_a = __privateGet(this, _controller)) == null ? void 0 : _a.activate(event);
+  }
+};
+_controller = new WeakMap();
+
 // src/core/modifiers/modifier.ts
 var Modifier = class extends Plugin {
   /**
@@ -1467,6 +1519,6 @@ var DragDropManager = class {
   }
 };
 
-export { CollisionPriority, CollisionType, CorePlugin, DragDropManager, Status as DragOperationStatus, Draggable, Droppable, Modifier, Plugin, PluginRegistry, Sensor, configurator, configure, descriptor, sortCollisions };
+export { ActivationConstraint, ActivationController, CollisionPriority, CollisionType, CorePlugin, DragDropManager, Status as DragOperationStatus, Draggable, Droppable, Modifier, Plugin, PluginRegistry, Sensor, configurator, configure, descriptor, sortCollisions };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map