Skip to content

Commit b1c62a5

Browse files
committed
Interactions: distance and delay options are deprecated
Fixes gh-238 Closes gh-250
1 parent ce1afa8 commit b1c62a5

File tree

5 files changed

+10
-0
lines changed

5 files changed

+10
-0
lines changed

entries/draggable.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,12 @@
6666
<desc>Sets the offset of the dragging helper relative to the mouse cursor. Coordinates can be given as a hash using a combination of one or two keys: <code>{ top, left, right, bottom }</code>.</desc>
6767
</option>
6868
<option name="delay" type="Number" default="0" example-value="300">
69+
<deprecated>1.12</deprecated>
6970
<desc>Time in milliseconds after mousedown until dragging should start. This option can be used to prevent unwanted drags when clicking on an element.</desc>
7071
</option>
7172
<xi:include href="../includes/widget-option-disabled.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
7273
<option name="distance" type="Number" default="1" example-value="10">
74+
<deprecated>1.12</deprecated>
7375
<desc>Distance in pixels after mousedown the mouse must move before dragging should start. This option can be used to prevent unwanted drags when clicking on an element.</desc>
7476
</option>
7577
<option name="grid" type="Array" default="false" example-value="[ 50, 20 ]">

entries/mouse.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,11 @@
1515
<desc>Prevents interactions from starting on specified elements.</desc>
1616
</option>
1717
<option name="delay" type="Number" default="0" example-value="300">
18+
<deprecated>1.12</deprecated>
1819
<desc>Time in milliseconds after mousedown until the interaction should start. This option can be used to prevent unwanted interactions when clicking on an element.</desc>
1920
</option>
2021
<option name="distance" type="Number" default="1" example-value="10">
22+
<deprecated>1.12</deprecated>
2123
<desc>Distance in pixels after mousedown the mouse must move before the interaction should start. This option can be used to prevent unwanted interactions when clicking on an element.</desc>
2224
</option>
2325
</options>

entries/resizable.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,12 @@
6464
</type>
6565
</option>
6666
<option name="delay" type="Number" default="0" example-value='150'>
67+
<deprecated>1.12</deprecated>
6768
<desc>Tolerance, in milliseconds, for when resizing should start. If specified, resizing will not start until after mouse is moved beyond duration. This can help prevent unintended resizing when clicking on an element.</desc>
6869
</option>
6970
<xi:include href="../includes/widget-option-disabled.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
7071
<option name="distance" type="Number" default="1" example-value='30'>
72+
<deprecated>1.12</deprecated>
7173
<desc>Tolerance, in pixels, for when resizing should start. If specified, resizing will not start until after mouse is moved beyond distance. This can help prevent unintended resizing when clicking on an element.</desc>
7274
</option>
7375
<option name="ghost" type="Boolean" default="false" example-value='true'>

entries/selectable.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,12 @@
2525
<desc>Prevents selecting if you start on elements matching the selector.</desc>
2626
</option>
2727
<option name="delay" type="Integer" default="0" example-value='150'>
28+
<deprecated>1.12</deprecated>
2829
<desc>Time in milliseconds to define when the selecting should start. This helps prevent unwanted selections when clicking on an element.</desc>
2930
</option>
3031
<xi:include href="../includes/widget-option-disabled.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
3132
<option name="distance" type="Number" default="0" example-value='30'>
33+
<deprecated>1.12</deprecated>
3234
<desc>Tolerance, in pixels, for when selecting should start. If specified, selecting will not start until the mouse has been dragged beyond the specified distance.</desc>
3335
</option>
3436
<option name="filter" type="Selector" default='"*"' example-value='"li"'>

entries/sortable.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,12 @@
6262
<desc>Moves the sorting element or helper so the cursor always appears to drag from the same position. Coordinates can be given as a hash using a combination of one or two keys: <code>{ top, left, right, bottom }</code>.</desc>
6363
</option>
6464
<option name="delay" type="Integer" default="0" example-value='150'>
65+
<deprecated>1.12</deprecated>
6566
<desc>Time in milliseconds to define when the sorting should start. Adding a delay helps preventing unwanted drags when clicking on an element.</desc>
6667
</option>
6768
<xi:include href="../includes/widget-option-disabled.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
6869
<option name="distance" type="Number" default="1" example-value='5'>
70+
<deprecated>1.12</deprecated>
6971
<desc>Tolerance, in pixels, for when sorting should start. If specified, sorting will not start until after mouse is dragged beyond distance. Can be used to allow for clicks on elements within a handle.</desc>
7072
</option>
7173
<option name="dropOnEmpty" type="Boolean" default="true" example-value='false'>

0 commit comments

Comments
 (0)