UNPKG

25.4 kBHTMLView Raw
1<!DOCTYPE html>
2<html lang="en">
3<head>
4 <meta charset="utf-8">
5 <meta name="viewport" content="width=device-width,initial-scale=1">
6 <title>interact - Documentation</title>
7
8 <script src="scripts/prettify/prettify.js"></script>
9 <script src="scripts/prettify/lang-css.js"></script>
10 <!--[if lt IE 9]>
11 <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
12 <![endif]-->
13 <link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
14 <link type="text/css" rel="stylesheet" href="styles/prettify.css">
15 <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
16</head>
17<body>
18
19<input type="checkbox" id="nav-trigger" class="nav-trigger" />
20<label for="nav-trigger" class="navicon-button x">
21 <div class="navicon"></div>
22</label>
23
24<label for="nav-trigger" class="overlay"></label>
25
26<nav>
27 <li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Classes</li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="DropEvent_DropEvent.html">DropEvent</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Interactable.html">Interactable</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Interactable.html#context">context</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Interactable.html#deltaSource">deltaSource</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Interactable.html#draggable">draggable</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Interactable.html#dropCheck">dropCheck</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Interactable.html#dropzone">dropzone</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Interactable.html#fire">fire</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Interactable.html#gesturable">gesturable</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Interactable.html#getRect">getRect</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Interactable.html#off">off</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Interactable.html#on">on</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Interactable.html#origin">origin</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Interactable.html#rectChecker">rectChecker</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Interactable.html#reflow">reflow</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Interactable.html#resizable">resizable</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Interactable.html#set">set</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Interactable.html#unset">unset</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="InteractEvent_InteractEvent.html">InteractEvent</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Interaction_Interaction.html">Interaction</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="module.exports_module.exports.html">exports</a></span></li><li class="nav-heading">Modules</li><li class="nav-heading"><span class="nav-item-type type-module">M</span><span class="nav-item-name"><a href="module-interact.html">interact</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-interact.html#.isSet">isSet</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-interact.html#.maxInteractions">maxInteractions</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-interact.html#.off">off</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-interact.html#.on">on</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-interact.html#.pointerMoveTolerance">pointerMoveTolerance</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-interact.html#.stop">stop</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-interact.html#.supportsPointerEvent">supportsPointerEvent</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-interact.html#.supportsTouch">supportsTouch</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-interact.html#.use">use</a></span></li><li class="nav-heading"><span class="nav-item-type type-module">M</span><span class="nav-item-name"><a href="module-modifiers_aspectRatio.html">modifiers/aspectRatio</a></span></li><li class="nav-heading"><span class="nav-item-type type-module">M</span><span class="nav-item-name"><a href="module-modifiers_snapEdges.html">modifiers/snapEdges</a></span></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#interact">interact</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#preventDefault">preventDefault</a></span></li>
28</nav>
29
30<div class="code-col-bg"></div>
31
32<div id="main">
33
34 <h1 class="page-title">interact</h1>
35
36
37
38
39
40
41
42<section>
43
44<header>
45
46
47
48</header>
49
50<article>
51 <div class="container-overview">
52
53
54
55
56
57 </div>
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72 <h3 class="subsection-title">Methods</h3>
73
74
75
76<div class="section-method">
77
78
79
80 <h4 class="name" id=".isSet"><span class="type-signature">(static) </span>isSet<span class="signature">(element)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
81
82
83
84
85
86<div class="description">
87 <p>Check if an element or selector has been set with the <a href="global.html#interact"><code>interact</code></a>
88function</p>
89</div>
90
91
92
93
94
95<dl class="details">
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 <dt class="tag-source">Source:</dt>
123 <dd class="tag-source"><ul class="dummy"><li>
124 <a href="packages_@interactjs_core_interactStatic.ts.html">packages/@interactjs/core/interactStatic.ts</a>, <a href="packages_@interactjs_core_interactStatic.ts.html#line108">line 108</a>
125 </li></ul></dd>
126
127
128
129
130
131
132
133</dl>
134
135
136
137
138
139
140
141
142
143 <h5>Parameters:</h5>
144
145
146<table class="params">
147 <thead>
148 <tr>
149
150 <th>Name</th>
151
152
153 <th>Type</th>
154
155
156
157
158
159 <th class="last">Description</th>
160 </tr>
161 </thead>
162
163 <tbody>
164
165
166 <tr>
167
168 <td class="name"><code>element</code></td>
169
170
171 <td class="type">
172
173
174<span class="param-type"><code>Element</code></span>
175
176
177
178 </td>
179
180
181
182
183
184 <td class="param-description last">
185 <p>The Element being searched for</p>
186
187 </td>
188 </tr>
189
190
191 </tbody>
192</table>
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207<div class="section-returns">
208<h5>Returns:</h5>
209
210
211
212<dl class="param-type">
213 <dt>
214 Type:
215 </dt>
216 <dd>
217
218<span class="param-type"><code>boolean</code></span>
219
220
221 </dd>
222</dl>
223
224
225<div class="param-desc">
226 <p>Indicates if the element or CSS selector was previously
227passed to interact</p>
228</div>
229
230
231</div>
232
233
234
235</div>
236
237
238
239<div class="section-method">
240
241
242
243 <h4 class="name" id=".maxInteractions"><span class="type-signature">(static) </span>maxInteractions<span class="signature">(newValue<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
244
245
246
247
248
249<div class="description">
250 <p>Returns or sets the maximum number of concurrent interactions allowed. By
251default only 1 interaction is allowed at a time (for backwards
252compatibility). To allow multiple interactions on the same Interactables and
253elements, you need to enable it in the draggable, resizable and gesturable
254<code>'max'</code> and <code>'maxPerElement'</code> options.</p>
255</div>
256
257
258
259
260
261<dl class="details">
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 <dt class="tag-source">Source:</dt>
289 <dd class="tag-source"><ul class="dummy"><li>
290 <a href="packages_@interactjs_auto-start_base.ts.html">packages/@interactjs/auto-start/base.ts</a>, <a href="packages_@interactjs_auto-start_base.ts.html#line86">line 86</a>
291 </li></ul></dd>
292
293
294
295
296
297
298
299</dl>
300
301
302
303
304
305
306
307
308
309 <h5>Parameters:</h5>
310
311
312<table class="params">
313 <thead>
314 <tr>
315
316 <th>Name</th>
317
318
319 <th>Type</th>
320
321
322 <th>Attributes</th>
323
324
325
326
327 <th class="last">Description</th>
328 </tr>
329 </thead>
330
331 <tbody>
332
333
334 <tr>
335
336 <td class="name"><code>newValue</code></td>
337
338
339 <td class="type">
340
341
342<span class="param-type"><code>number</code></span>
343
344
345
346 </td>
347
348
349 <td class="attributes">
350
351 &lt;optional><br>
352
353
354
355
356
357 </td>
358
359
360
361
362 <td class="param-description last">
363 <p>Any number. newValue &lt;= 0 means no interactions.</p>
364
365 </td>
366 </tr>
367
368
369 </tbody>
370</table>
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387</div>
388
389
390
391<div class="section-method">
392
393
394
395 <h4 class="name" id=".off"><span class="type-signature">(static) </span>off<span class="signature">(type, listener, options)</span><span class="type-signature"> &rarr; {object}</span></h4>
396
397
398
399
400
401<div class="description">
402 <p>Removes a global InteractEvent listener or DOM event from <code>document</code></p>
403</div>
404
405
406
407
408
409<dl class="details">
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 <dt class="tag-source">Source:</dt>
437 <dd class="tag-source"><ul class="dummy"><li>
438 <a href="packages_@interactjs_core_interactStatic.ts.html">packages/@interactjs/core/interactStatic.ts</a>, <a href="packages_@interactjs_core_interactStatic.ts.html#line172">line 172</a>
439 </li></ul></dd>
440
441
442
443
444
445
446
447</dl>
448
449
450
451
452
453
454
455
456
457 <h5>Parameters:</h5>
458
459
460<table class="params">
461 <thead>
462 <tr>
463
464 <th>Name</th>
465
466
467 <th>Type</th>
468
469
470
471
472
473 <th class="last">Description</th>
474 </tr>
475 </thead>
476
477 <tbody>
478
479
480 <tr>
481
482 <td class="name"><code>type</code></td>
483
484
485 <td class="type">
486
487
488<span class="param-type"><code>string</code></span>
489|
490
491<span class="param-type"><code>array</code></span>
492|
493
494<span class="param-type"><code>object</code></span>
495
496
497
498 </td>
499
500
501
502
503
504 <td class="param-description last">
505 <p>The types of events that were listened
506for</p>
507
508 </td>
509 </tr>
510
511
512
513 <tr>
514
515 <td class="name"><code>listener</code></td>
516
517
518 <td class="type">
519
520
521<span class="param-type"><code>function</code></span>
522
523
524
525 </td>
526
527
528
529
530
531 <td class="param-description last">
532 <p>The listener function to be removed</p>
533
534 </td>
535 </tr>
536
537
538
539 <tr>
540
541 <td class="name"><code>options</code></td>
542
543
544 <td class="type">
545
546
547<span class="param-type"><code>object</code></span>
548|
549
550<span class="param-type"><code>boolean</code></span>
551
552
553
554 </td>
555
556
557
558
559
560 <td class="param-description last">
561 <p>[options] object or useCapture flag for
562removeEventListener</p>
563
564 </td>
565 </tr>
566
567
568 </tbody>
569</table>
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584<div class="section-returns">
585<h5>Returns:</h5>
586
587
588
589<dl class="param-type">
590 <dt>
591 Type:
592 </dt>
593 <dd>
594
595<span class="param-type"><code>object</code></span>
596
597
598 </dd>
599</dl>
600
601
602<div class="param-desc">
603 <p>interact</p>
604</div>
605
606
607</div>
608
609
610
611</div>
612
613
614
615<div class="section-method">
616
617
618
619 <h4 class="name" id=".on"><span class="type-signature">(static) </span>on<span class="signature">(type, listener, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {object}</span></h4>
620
621
622
623
624
625<div class="description">
626 <p>Add a global listener for an InteractEvent or adds a DOM event to <code>document</code></p>
627</div>
628
629
630
631
632
633<dl class="details">
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660 <dt class="tag-source">Source:</dt>
661 <dd class="tag-source"><ul class="dummy"><li>
662 <a href="packages_@interactjs_core_interactStatic.ts.html">packages/@interactjs/core/interactStatic.ts</a>, <a href="packages_@interactjs_core_interactStatic.ts.html#line122">line 122</a>
663 </li></ul></dd>
664
665
666
667
668
669
670
671</dl>
672
673
674
675
676
677
678
679
680
681 <h5>Parameters:</h5>
682
683
684<table class="params">
685 <thead>
686 <tr>
687
688 <th>Name</th>
689
690
691 <th>Type</th>
692
693
694 <th>Attributes</th>
695
696
697
698
699 <th class="last">Description</th>
700 </tr>
701 </thead>
702
703 <tbody>
704
705
706 <tr>
707
708 <td class="name"><code>type</code></td>
709
710
711 <td class="type">
712
713
714<span class="param-type"><code>string</code></span>
715|
716
717<span class="param-type"><code>array</code></span>
718|
719
720<span class="param-type"><code>object</code></span>
721
722
723
724 </td>
725
726
727 <td class="attributes">
728
729
730
731
732
733 </td>
734
735
736
737
738 <td class="param-description last">
739 <p>The types of events to listen for</p>
740
741 </td>
742 </tr>
743
744
745
746 <tr>
747
748 <td class="name"><code>listener</code></td>
749
750
751 <td class="type">
752
753
754<span class="param-type"><code>function</code></span>
755
756
757
758 </td>
759
760
761 <td class="attributes">
762
763
764
765
766
767 </td>
768
769
770
771
772 <td class="param-description last">
773 <p>The function event (s)</p>
774
775 </td>
776 </tr>
777
778
779
780 <tr>
781
782 <td class="name"><code>options</code></td>
783
784
785 <td class="type">
786
787
788<span class="param-type"><code>object</code></span>
789|
790
791<span class="param-type"><code>boolean</code></span>
792
793
794
795 </td>
796
797
798 <td class="attributes">
799
800 &lt;optional><br>
801
802
803
804
805
806 </td>
807
808
809
810
811 <td class="param-description last">
812 <p>object or useCapture flag for
813addEventListener</p>
814
815 </td>
816 </tr>
817
818
819 </tbody>
820</table>
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835<div class="section-returns">
836<h5>Returns:</h5>
837
838
839
840<dl class="param-type">
841 <dt>
842 Type:
843 </dt>
844 <dd>
845
846<span class="param-type"><code>object</code></span>
847
848
849 </dd>
850</dl>
851
852
853<div class="param-desc">
854 <p>interact</p>
855</div>
856
857
858</div>
859
860
861
862</div>
863
864
865
866<div class="section-method">
867
868
869
870 <h4 class="name" id=".pointerMoveTolerance"><span class="type-signature">(static) </span>pointerMoveTolerance<span class="signature">(newValue<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="global.html#interact">interact</a>|number}</span></h4>
871
872
873
874
875
876<div class="description">
877 <p>Returns or sets the distance the pointer must be moved before an action
878sequence occurs. This also affects tolerance for tap events.</p>
879</div>
880
881
882
883
884
885<dl class="details">
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912 <dt class="tag-source">Source:</dt>
913 <dd class="tag-source"><ul class="dummy"><li>
914 <a href="packages_@interactjs_core_interactStatic.ts.html">packages/@interactjs/core/interactStatic.ts</a>, <a href="packages_@interactjs_core_interactStatic.ts.html#line257">line 257</a>
915 </li></ul></dd>
916
917
918
919
920
921
922
923</dl>
924
925
926
927
928
929
930
931
932
933 <h5>Parameters:</h5>
934
935
936<table class="params">
937 <thead>
938 <tr>
939
940 <th>Name</th>
941
942
943 <th>Type</th>
944
945
946 <th>Attributes</th>
947
948
949
950
951 <th class="last">Description</th>
952 </tr>
953 </thead>
954
955 <tbody>
956
957
958 <tr>
959
960 <td class="name"><code>newValue</code></td>
961
962
963 <td class="type">
964
965
966<span class="param-type"><code>number</code></span>
967
968
969
970 </td>
971
972
973 <td class="attributes">
974
975 &lt;optional><br>
976
977
978
979
980
981 </td>
982
983
984
985
986 <td class="param-description last">
987 <p>The movement from the start position must be greater than this value</p>
988
989 </td>
990 </tr>
991
992
993 </tbody>
994</table>
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009<div class="section-returns">
1010<h5>Returns:</h5>
1011
1012
1013
1014<dl class="param-type">
1015 <dt>
1016 Type:
1017 </dt>
1018 <dd>
1019
1020<span class="param-type"><code><a href="global.html#interact">interact</a></code></span>
1021|
1022
1023<span class="param-type"><code>number</code></span>
1024
1025
1026 </dd>
1027</dl>
1028
1029
1030
1031</div>
1032
1033
1034
1035</div>
1036
1037
1038
1039<div class="section-method">
1040
1041
1042
1043 <h4 class="name" id=".stop"><span class="type-signature">(static) </span>stop<span class="signature">()</span><span class="type-signature"> &rarr; {object}</span></h4>
1044
1045
1046
1047
1048
1049<div class="description">
1050 <p>Cancels all interactions (end events are not fired)</p>
1051</div>
1052
1053
1054
1055
1056
1057<dl class="details">
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084 <dt class="tag-source">Source:</dt>
1085 <dd class="tag-source"><ul class="dummy"><li>
1086 <a href="packages_@interactjs_core_interactStatic.ts.html">packages/@interactjs/core/interactStatic.ts</a>, <a href="packages_@interactjs_core_interactStatic.ts.html#line242">line 242</a>
1087 </li></ul></dd>
1088
1089
1090
1091
1092
1093
1094
1095</dl>
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117<div class="section-returns">
1118<h5>Returns:</h5>
1119
1120
1121
1122<dl class="param-type">
1123 <dt>
1124 Type:
1125 </dt>
1126 <dd>
1127
1128<span class="param-type"><code>object</code></span>
1129
1130
1131 </dd>
1132</dl>
1133
1134
1135<div class="param-desc">
1136 <p>interact</p>
1137</div>
1138
1139
1140</div>
1141
1142
1143
1144</div>
1145
1146
1147
1148<div class="section-method">
1149
1150
1151
1152 <h4 class="name" id=".supportsPointerEvent"><span class="type-signature">(static) </span>supportsPointerEvent<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162<dl class="details">
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189 <dt class="tag-source">Source:</dt>
1190 <dd class="tag-source"><ul class="dummy"><li>
1191 <a href="packages_@interactjs_core_interactStatic.ts.html">packages/@interactjs/core/interactStatic.ts</a>, <a href="packages_@interactjs_core_interactStatic.ts.html#line233">line 233</a>
1192 </li></ul></dd>
1193
1194
1195
1196
1197
1198
1199
1200</dl>
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222<div class="section-returns">
1223<h5>Returns:</h5>
1224
1225
1226
1227<dl class="param-type">
1228 <dt>
1229 Type:
1230 </dt>
1231 <dd>
1232
1233<span class="param-type"><code>boolean</code></span>
1234
1235
1236 </dd>
1237</dl>
1238
1239
1240<div class="param-desc">
1241 <p>Whether or not the browser supports PointerEvents</p>
1242</div>
1243
1244
1245</div>
1246
1247
1248
1249</div>
1250
1251
1252
1253<div class="section-method">
1254
1255
1256
1257 <h4 class="name" id=".supportsTouch"><span class="type-signature">(static) </span>supportsTouch<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267<dl class="details">
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294 <dt class="tag-source">Source:</dt>
1295 <dd class="tag-source"><ul class="dummy"><li>
1296 <a href="packages_@interactjs_core_interactStatic.ts.html">packages/@interactjs/core/interactStatic.ts</a>, <a href="packages_@interactjs_core_interactStatic.ts.html#line224">line 224</a>
1297 </li></ul></dd>
1298
1299
1300
1301
1302
1303
1304
1305</dl>
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327<div class="section-returns">
1328<h5>Returns:</h5>
1329
1330
1331
1332<dl class="param-type">
1333 <dt>
1334 Type:
1335 </dt>
1336 <dd>
1337
1338<span class="param-type"><code>boolean</code></span>
1339
1340
1341 </dd>
1342</dl>
1343
1344
1345<div class="param-desc">
1346 <p>Whether or not the browser supports touch input</p>
1347</div>
1348
1349
1350</div>
1351
1352
1353
1354</div>
1355
1356
1357
1358<div class="section-method">
1359
1360
1361
1362 <h4 class="name" id=".use"><span class="type-signature">(static) </span>use<span class="signature">(plugin)</span><span class="type-signature"> &rarr; {Interact.InteractStatic}</span></h4>
1363
1364
1365
1366
1367
1368<div class="description">
1369 <p>Use a plugin</p>
1370</div>
1371
1372
1373
1374
1375
1376<dl class="details">
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403 <dt class="tag-source">Source:</dt>
1404 <dd class="tag-source"><ul class="dummy"><li>
1405 <a href="packages_@interactjs_core_interactStatic.ts.html">packages/@interactjs/core/interactStatic.ts</a>, <a href="packages_@interactjs_core_interactStatic.ts.html#line93">line 93</a>
1406 </li></ul></dd>
1407
1408
1409
1410
1411
1412
1413
1414</dl>
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424 <h5>Parameters:</h5>
1425
1426
1427<table class="params">
1428 <thead>
1429 <tr>
1430
1431 <th>Name</th>
1432
1433
1434 <th>Type</th>
1435
1436
1437
1438
1439
1440 <th class="last">Description</th>
1441 </tr>
1442 </thead>
1443
1444 <tbody>
1445
1446
1447 <tr>
1448
1449 <td class="name"><code>plugin</code></td>
1450
1451
1452 <td class="type">
1453
1454
1455<span class="param-type"><code>Object</code></span>
1456
1457
1458
1459 </td>
1460
1461
1462
1463
1464
1465 <td class="param-description last">
1466
1467
1468
1469
1470<table class="params">
1471 <thead>
1472 <tr>
1473
1474 <th>Name</th>
1475
1476
1477 <th>Type</th>
1478
1479
1480
1481
1482
1483 <th class="last">Description</th>
1484 </tr>
1485 </thead>
1486
1487 <tbody>
1488
1489
1490 <tr>
1491
1492 <td class="name"><code>install</code></td>
1493
1494
1495 <td class="type">
1496
1497
1498<span class="param-type"><code>function</code></span>
1499
1500
1501
1502 </td>
1503
1504
1505
1506
1507
1508 <td class="param-description last">
1509
1510
1511 </td>
1512 </tr>
1513
1514
1515 </tbody>
1516</table>
1517
1518
1519 </td>
1520 </tr>
1521
1522
1523 </tbody>
1524</table>
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539<div class="section-returns">
1540<h5>Returns:</h5>
1541
1542
1543
1544<dl class="param-type">
1545 <dt>
1546 Type:
1547 </dt>
1548 <dd>
1549
1550<span class="param-type"><code>Interact.InteractStatic</code></span>
1551
1552
1553 </dd>
1554</dl>
1555
1556
1557
1558</div>
1559
1560
1561
1562</div>
1563
1564
1565
1566
1567
1568
1569
1570</article>
1571
1572</section>
1573
1574
1575
1576
1577</div>
1578
1579<script>prettyPrint();</script>
1580<script src="scripts/linenumber.js"></script>
1581</body>
1582</html>
\No newline at end of file