-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
index.d.ts
585 lines (500 loc) · 15.3 KB
/
index.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
declare module '@shopify/draggable/lib/draggable.bundle.legacy' {
export * from '@shopify/draggable';
}
declare module '@shopify/draggable/lib/es5/draggable.bundle' {
export * from '@shopify/draggable';
}
declare module '@shopify/draggable/lib/es5/draggable.bundle.legacy' {
export * from '@shopify/draggable';
}
declare module '@shopify/draggable' {
abstract class AbstractEvent<TData = {[key: string]: any}> {
// Abstract, waiting on https://github.com/Microsoft/TypeScript/issues/14600
static readonly type: string;
// Abstract, waiting on https://github.com/Microsoft/TypeScript/issues/14600
static readonly cancelable: boolean;
readonly type: string;
readonly cancelable: boolean;
constructor(data: TData);
cancel(): void;
canceled(): boolean;
clone(): AbstractEvent<TData>;
}
export {AbstractEvent as BaseEvent};
type GetEventByEventName<TEventName> =
TEventName extends 'draggable:initialize'
? DraggableInitializedEvent
: TEventName extends 'draggable:destroy'
? DraggableDestroyEvent
: TEventName extends 'drag:start'
? DragStartEvent
: TEventName extends 'drag:move'
? DragMoveEvent
: TEventName extends 'drag:over'
? DragOverEvent
: TEventName extends 'drag:over:container'
? DragOverContainerEvent
: TEventName extends 'drag:out'
? DragOutEvent
: TEventName extends 'drag:out:container'
? DragOutContainerEvent
: TEventName extends 'drag:stop'
? DragStopEvent
: TEventName extends 'drag:stopped'
? DragStoppedEvent
: TEventName extends 'drag:pressure'
? DragPressureEvent
: TEventName extends 'mirror:create'
? MirrorCreateEvent
: TEventName extends 'mirror:created'
? MirrorCreatedEvent
: TEventName extends 'mirror:attached'
? MirrorAttachedEvent
: TEventName extends 'mirror:move'
? MirrorMoveEvent
: TEventName extends 'mirror:moved'
? MirrorMovedEvent
: TEventName extends 'mirror:destroy'
? MirrorDestroyEvent
: TEventName extends 'droppable:start'
? DroppableStartEvent
: TEventName extends 'droppable:dropped'
? DroppableDroppedEvent
: TEventName extends 'droppable:returned'
? DroppableReturnedEvent
: TEventName extends 'droppable:stop'
? DroppableStopEvent
: TEventName extends 'sortable:start'
? SortableStartEvent
: TEventName extends 'sortable:sort'
? SortableSortEvent
: TEventName extends 'sortable:sorted'
? SortableSortedEvent
: TEventName extends 'sortable:stop'
? SortableStopEvent
: TEventName extends 'swappable:start'
? SwappableStartEvent
: TEventName extends 'swappable:swap'
? SwappableSwapEvent
: TEventName extends 'swappable:swapped'
? SwappableSwappedEvent
: TEventName extends 'swappable:stop'
? SwappableStopEvent
: TEventName extends 'collidable:in'
? CollidableInEvent
: TEventName extends 'collidable:out'
? CollidableOutEvent
: TEventName extends 'snap:in'
? SnapInEvent
: TEventName extends 'snap:out'
? SnapOutEvent
: AbstractEvent;
export interface DelayOptions {
mouse?: number;
drag?: number;
touch?: number;
}
/**
* DragEvent
*/
export class DragEvent extends AbstractEvent {
readonly source: HTMLElement;
readonly originalSource: HTMLElement;
readonly mirror: HTMLElement;
readonly sourceContainer: HTMLElement;
readonly sensorEvent: SensorEvent;
readonly originalEvent: Event;
}
export class DragStartEvent extends DragEvent {}
export class DragMoveEvent extends DragEvent {}
export class DragOverEvent extends DragEvent {
readonly overContainer: HTMLElement;
readonly over: HTMLElement;
}
export class DragOutEvent extends DragEvent {
readonly overContainer: HTMLElement;
readonly over: HTMLElement;
}
export class DragOverContainerEvent extends DragEvent {
readonly overContainer: HTMLElement;
}
export class DragOutContainerEvent extends DragEvent {
readonly overContainer: HTMLElement;
}
export class DragPressureEvent extends DragEvent {
readonly pressure: number;
}
export class DragStopEvent extends DragEvent {}
export class DragStoppedEvent extends DragEvent {}
/**
* DraggableEvent
*/
export type DraggableEventNames =
| 'draggable:initialize'
| 'draggable:destroy'
| 'drag:start'
| 'drag:move'
| 'drag:over'
| 'drag:over:container'
| 'drag:out'
| 'drag:out:container'
| 'drag:stop'
| 'drag:pressure'
| MirrorEventNames;
export class DraggableEvent extends AbstractEvent {
readonly draggable: Draggable;
}
export class DraggableInitializedEvent extends DraggableEvent {}
export class DraggableDestroyEvent extends DraggableEvent {}
export type DraggableClassNames =
| 'body:dragging'
| 'container:dragging'
| 'source:dragging'
| 'source:placed'
| 'container:placed'
| 'draggable:over'
| 'container:over'
| 'source:original'
| 'mirror';
export type DraggableContainer = HTMLElement | HTMLElement[] | NodeList;
export interface DraggableOptions {
draggable?: string;
distance?: number;
handle?:
| string
| NodeList
| HTMLElement[]
| HTMLElement
| ((currentElement: HTMLElement) => HTMLElement);
delay?: number | DelayOptions;
plugins?: (typeof AbstractPlugin)[];
sensors?: Sensor[];
classes?: {[key in DraggableClassNames]: string | string[]};
announcements?: AnnouncementOptions;
collidables?: Collidables;
mirror?: MirrorOptions;
scrollable?: ScrollableOptions;
swapAnimation?: SwapAnimationOptions;
sortAnimation?: SortAnimationOptions;
}
export class Draggable<TEventListType = DraggableEventNames> {
static Plugins: {
Announcement: typeof Announcement;
Focusable: typeof Focusable;
Mirror: typeof Mirror;
Scrollable: typeof Scrollable;
};
constructor(containers: DraggableContainer, options?: DraggableOptions);
destroy(): void;
on<T extends TEventListType>(
eventName: T,
callback: (event: GetEventByEventName<T>) => void,
): this;
off<T extends TEventListType>(
eventName: T,
callback: (event: GetEventByEventName<T>) => void,
): this;
trigger(event: AbstractEvent): void;
addPlugin(...plugins: (typeof AbstractPlugin)[]): this;
removePlugin(...plugins: (typeof AbstractPlugin)[]): this;
addSensor(...sensors: (typeof Sensor)[]): this;
removeSensor(...sensors: (typeof Sensor)[]): this;
addContainer(...containers: HTMLElement[]): this;
removeContainer(...containers: HTMLElement[]): this;
getClassNameFor(name: DraggableClassNames): string;
getClassNamesFor(name: DraggableClassNames): string[];
isDragging(): boolean;
getDraggableElementsForContainer(container: HTMLElement): HTMLElement[];
}
export abstract class AbstractPlugin {
protected draggable: Draggable;
constructor(draggable: Draggable);
protected abstract attach(): void;
protected abstract detach(): void;
}
export {AbstractPlugin as BasePlugin};
/**
* Announcement Plugin
*/
export interface AnnouncementOptions {
expire: number;
[key: string]: string | (() => string) | number;
}
class Announcement extends AbstractPlugin {
options: AnnouncementOptions;
protected attach(): void;
protected detach(): void;
}
/**
* Focusable Plugin
*/
class Focusable extends AbstractPlugin {
getElements(): HTMLElement[];
protected attach(): void;
protected detach(): void;
}
/**
* Mirror Plugin
*/
export type MirrorEventNames =
| 'mirror:create'
| 'mirror:created'
| 'mirror:attached'
| 'mirror:move'
| 'mirror:destroy';
export class MirrorEvent extends AbstractEvent {
readonly source: HTMLElement;
readonly originalSource: HTMLElement;
readonly sourceContainer: HTMLElement;
readonly sensorEvent: SensorEvent;
readonly originalEvent: Event;
}
export class MirrorCreateEvent extends MirrorEvent {}
export class MirrorCreatedEvent extends MirrorEvent {
readonly mirror: HTMLElement;
}
export class MirrorAttachedEvent extends MirrorEvent {
readonly mirror: HTMLElement;
}
export class MirrorMoveEvent extends MirrorEvent {
readonly mirror: HTMLElement;
readonly passedThreshX: boolean;
readonly passedThreshY: boolean;
}
export class MirrorMovedEvent extends MirrorEvent {
readonly mirror: HTMLElement;
readonly passedThreshX: boolean;
readonly passedThreshY: boolean;
}
export class MirrorDestroyEvent extends MirrorEvent {
readonly mirror: HTMLElement;
}
export interface MirrorOptions {
xAxis?: boolean;
yAxis?: boolean;
constrainDimensions?: boolean;
cursorOffsetX?: number;
cursorOffsetY?: number;
appendTo?: string | HTMLElement | ((source: HTMLElement) => HTMLElement);
}
class Mirror extends AbstractPlugin {
getElements(): HTMLElement[];
protected attach(): void;
protected detach(): void;
}
/**
* Scrollable Plugin
*/
export interface ScrollableOptions {
speed?: number;
sensitivity?: number;
scrollableElements?: HTMLElement[];
}
class Scrollable extends AbstractPlugin {
protected attach(): void;
protected detach(): void;
}
/**
* Sensors
*/
export class SensorEvent extends AbstractEvent {
readonly originalEvent: Event;
readonly clientX: number;
readonly clientY: number;
readonly target: HTMLElement;
readonly container: HTMLElement;
readonly pressure: number;
}
export class DragStartSensorEvent extends SensorEvent {}
export class DragMoveSensorEvent extends SensorEvent {}
export class DragStopSensorEvent extends SensorEvent {}
export class DragPressureSensorEvent extends SensorEvent {}
export interface SensorOptions {
delay?: number | DelayOptions;
}
export class Sensor {
constructor(
containers: HTMLElement | HTMLElement[] | NodeList,
options?: SensorOptions,
);
attach(): this;
detach(): this;
addContainer(...containers: HTMLElement[]): void;
removeContainer(...containers: HTMLElement[]): void;
trigger(element: HTMLElement, sensorEvent: SensorEvent): SensorEvent;
}
export interface Sensors {
DragSensor: typeof DragSensor;
}
export class DragSensor extends Sensor {}
export class ForceTouchSensor extends Sensor {}
export class MouseSensor extends Sensor {}
export class TouchSensor extends Sensor {}
/**
* Droppable
*/
export type DroppableEventNames =
| 'droppable:start'
| 'droppable:dropped'
| 'droppable:returned'
| 'droppable:stop'
| DraggableEventNames;
export class DroppableEvent extends AbstractEvent {
readonly dragEvent: DragEvent;
}
export class DroppableStartEvent extends DroppableEvent {
dropzone: HTMLElement;
}
export class DroppableDroppedEvent extends DroppableEvent {
dropzone: HTMLElement;
}
export class DroppableReturnedEvent extends DroppableEvent {
dropzone: HTMLElement;
}
export class DroppableStopEvent extends DroppableEvent {
dropzone: HTMLElement;
}
export type DroppableClassNames =
| DraggableClassNames
| 'droppable:active'
| 'droppable:occupied';
export interface DroppableOptions extends DraggableOptions {
dropzone:
| string
| NodeList
| HTMLElement[]
| (() => NodeList | HTMLElement[]);
classes?: {[key in DroppableClassNames]: string};
}
export class Droppable<T = DroppableEventNames> extends Draggable<T> {
constructor(containers: DraggableContainer, options: DroppableOptions);
getClassNameFor(name: DroppableClassNames): string;
}
/**
* Sortable
*/
export type SortableEventNames =
| 'sortable:start'
| 'sortable:sort'
| 'sortable:sorted'
| 'sortable:stop'
| DraggableEventNames;
export class SortableEvent extends AbstractEvent {
readonly dragEvent: DragEvent;
}
export class SortableStartEvent extends SortableEvent {
readonly startIndex: number;
readonly startContainer: HTMLElement;
}
export class SortableSortEvent extends SortableEvent {
readonly oldIndex: number;
readonly newIndex: number;
readonly oldContainer: HTMLElement;
readonly newContainer: HTMLElement;
}
export class SortableSortedEvent extends SortableEvent {
readonly oldIndex: number;
readonly newIndex: number;
readonly oldContainer: HTMLElement;
readonly newContainer: HTMLElement;
}
export class SortableStopEvent extends SortableEvent {
readonly oldIndex: number;
readonly newIndex: number;
readonly oldContainer: HTMLElement;
readonly newContainer: HTMLElement;
}
export class Sortable<T = SortableEventNames> extends Draggable<T> {}
/**
* Swappable
*/
export type SwappableEventNames =
| 'swappable:start'
| 'swappable:swap'
| 'swappable:swapped'
| 'swappable:stop'
| DraggableEventNames;
export class SwappableEvent extends AbstractEvent {
readonly dragEvent: DragEvent;
}
export class SwappableStartEvent extends SwappableEvent {}
export class SwappableSwapEvent extends SwappableEvent {
readonly over: HTMLElement;
readonly overContainer: HTMLElement;
}
export class SwappableSwappedEvent extends SwappableEvent {
readonly swappedElement: HTMLElement;
}
export class SwappableStopEvent extends SwappableEvent {}
export class Swappable<T = SwappableEventNames> extends Draggable<T> {}
/**
* Collidable Plugin
*/
export type CollidableEventNames = 'collidable:in' | 'collidable:out';
export class CollidableEvent extends AbstractEvent {
readonly dragEvent: DragEvent;
readonly collidingElement: HTMLElement;
}
export class CollidableInEvent extends CollidableEvent {}
export class CollidableOutEvent extends CollidableEvent {}
export type Collidables =
| string
| NodeList
| HTMLElement[]
| (() => NodeList | HTMLElement[]);
class Collidable extends AbstractPlugin {
protected attach(): void;
protected detach(): void;
}
/**
* ResizeMirror Plugin
*/
class ResizeMirror extends AbstractPlugin {
protected attach(): void;
protected detach(): void;
}
/**
* Snappable Plugin
*/
export type SnappableEventNames = 'snap:in' | 'snap:out';
export class SnapEvent extends AbstractEvent {
readonly dragEvent: DragEvent;
readonly snappable: HTMLElement;
}
export class SnapInEvent extends SnapEvent {}
export class SnapOutEvent extends SnapEvent {}
class Snappable extends AbstractPlugin {
protected attach(): void;
protected detach(): void;
}
/**
* SwapAnimation Plugin
*/
export interface SwapAnimationOptions {
duration: number;
easingFunction: string;
horizontal: boolean;
}
class SwapAnimation extends AbstractPlugin {
protected attach(): void;
protected detach(): void;
}
/**
* SortAnimation
*/
export interface SortAnimationOptions {
duration?: number;
easingFunction?: string;
}
class SortAnimation extends AbstractPlugin {
protected attach(): void;
protected detach(): void;
}
export const Plugins: {
Collidable: typeof Collidable;
SwapAnimation: typeof SwapAnimation;
SortAnimation: typeof SortAnimation;
ResizeMirror: typeof ResizeMirror;
Snappable: typeof Snappable;
};
}