Skip to content

Commit de30ed8

Browse files
committed
Draggable: Document ui.position modification in drag event
Fixes jquerygh-221 Closes jquerygh-253
1 parent 5952ee7 commit de30ed8

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

entries/draggable.xml

+15-2
Original file line numberDiff line numberDiff line change
@@ -174,19 +174,32 @@
174174
</argument>
175175
</event>
176176
<event name="drag">
177-
<desc>Triggered while the mouse is moved during the dragging.</desc>
177+
<desc>Triggered while the mouse is moved during the dragging, immediately before the current move happens.</desc>
178178
<argument name="event" type="Event"/>
179179
<argument name="ui" type="Object">
180180
<property name="helper" type="jQuery">
181181
<desc>The jQuery object representing the helper that's being dragged.</desc>
182182
</property>
183183
<property name="position" type="Object">
184-
<desc>Current CSS position of the helper as <code>{ top, left }</code> object.</desc>
184+
<desc>Current CSS position of the helper as <code>{ top, left }</code> object. The values may be changed to modify where the element will be positioned. This is useful for custom containment, snapping, etc.</desc>
185185
</property>
186186
<property name="offset" type="Object">
187187
<desc>Current offset position of the helper as <code>{ top, left }</code> object.</desc>
188188
</property>
189189
</argument>
190+
<example>
191+
<desc>Constrain movement via <code>ui.position</code>:</desc>
192+
<code><![CDATA[
193+
$( ".selector" ).draggable({
194+
drag: function( event, ui ) {
195+
196+
// Keep the left edge of the element
197+
// at least 100 pixels from the container
198+
ui.position.left = Math.min( 100, ui.position.left );
199+
}
200+
});
201+
]]></code>
202+
</example>
190203
</event>
191204
<event name="stop">
192205
<desc>Triggered when dragging stops.</desc>

0 commit comments

Comments
 (0)