@pantograph/sortable 2.0.0 → 2.1.0

package/{src/index.d.ts → index.d.ts}

@@ -1,8 +1,6 @@
 import {
   AutoScrollOptions,
   AutoScrollPlugin,
-  MultiDragOptions,
-  MultiDragPlugin,
   OnSpillOptions,
   OnSpillPlugin,
   SortablePlugin,
@@ -13,6 +11,7 @@ import {
 } from './plugins'
 
 export = Sortable
+export { type Sortable }
 
 declare class Sortable {
   public options: Sortable.Options
@@ -34,7 +33,7 @@ declare class Sortable {
    *
    * @example
    *
-   * Sortable.mount(new MultiDrag(), new AutoScroll())
+   * Sortable.mount(AutoScroll)
    */
   static mount(...sortablePlugins: SortablePlugin[]): void
 
@@ -102,7 +101,6 @@ declare namespace Sortable {
   export interface Options
     extends SortableOptions,
       AutoScrollOptions,
-      MultiDragOptions,
       OnSpillOptions,
       SwapOptions,
       FlatTreeOptions {}
@@ -111,13 +109,19 @@ declare namespace Sortable {
    * A class that all plugins inherit from for the sake of type inference.
    */
   export class Plugin extends SortablePlugin {}
-  export class MultiDrag extends MultiDragPlugin {}
   export class AutoScroll extends AutoScrollPlugin {}
   export class Swap extends SwapPlugin {}
   export class FlatTree extends FlatTreePlugin {}
   export class OnSpill extends OnSpillPlugin {}
 
-  export interface SortableEvent extends Event {
+  export interface TreeEventParams {
+    draggedTreeItemLevel: number
+    draggedTreeItemParent: HTMLElement
+    draggedTreeItemAfter?: HTMLElement & { level: number }
+    draggedTreeItemBefore?: HTMLElement & { level: number }
+  }
+
+  export interface SortableEvent extends Event, Partial<TreeEventParams> {
     clone: HTMLElement
     /**
      * previous list
@@ -156,27 +160,11 @@ declare namespace Sortable {
      * Pull mode if dragging into another sortable
      */
     pullMode: 'clone' | boolean | undefined
-    /**
-     * When MultiDrag is used to sort, this holds a HTMLElement and oldIndex for each item selected.
-     *
-     * `oldIndicies[number]` is directly related to `newIndicies[number]`
-     *
-     * If MultiDrag is not used to sort, this array will be empty.
-     */
-    oldIndicies: Array<{ multiDragElement: HTMLElement; index: number }>
-    /**
-     * When MultiDrag is used to sort, this holds a HTMLElement and newIndex for each item.
-     *
-     * `oldIndicies[number]` is directly related to `newIndicies[number]`
-     *
-     * If MultiDrag is not used to sort, this array will be empty.
-     */
-    newIndicies: Array<{ multiDragElement: HTMLElement; index: number }>
     /** When Swap is used to sort, this will contain the dragging item that was dropped on.*/
     swapItem: HTMLElement | null
   }
 
-  export interface MoveEvent extends Event {
+  export interface MoveEvent extends Event, Partial<TreeEventParams> {
     dragged: HTMLElement
     draggedRect: DOMRect
     from: HTMLElement
@@ -240,8 +228,8 @@ declare namespace Sortable {
   type Direction = 'vertical' | 'horizontal'
   export interface SortableOptions {
     getGhostFallback?: (dragEl: HTMLElement) => HTMLElement
-    getPlaceholder?: (dragEl: HTMLElement) => HTMLElement
-    getPlaceholderOnMove?: (event: MoveEvent) => HTMLElement
+    getPlaceholder?: (dragEl: SortableEvent) => HTMLElement | undefined
+    getPlaceholderOnMove?: (event: MoveEvent) => HTMLElement | undefined
     /**
      * ms, animation speed moving items when sorting, `0` — without animation
      */