Draggable Widgetversion added: 1.0
Description: Allow elements to be moved using the mouse.
Options
addClassesType: Boolean
Default:
true
If set to
false, will prevent the ui-draggable class from being added. This may be desired as a performance optimization when calling .draggable() on hundreds of elements.appendToType: jQuery or Element or Selector or String
Default:
"parent"
Which element the draggable helper should be appended to while dragging.
Multiple types supported:- jQuery: A jQuery object containing the element to append the helper to.
- Element: The element to append the helper to.
- Selector: A selector specifying which element to append the helper to.
-
String: The string
"parent"will cause the helper to be a sibling of the draggable.
axisType: String
Default:
false
Constrains dragging to either the horizontal (x) or vertical (y) axis. Possible values:
"x", "y".cancelType: Selector
Default:
"input,textarea,button,select,option"
Prevents dragging from starting on specified elements.
connectToSortableType: Selector
Default:
false
Allows the draggable to be dropped onto the specified sortables. If this option is used, a draggable can be dropped onto a sortable list and then becomes part of it. Note: The
helper option must be set to "clone" in order to work flawlessly. Requires the jQuery UI Sortable plugin to be included.containmentType: Selector or Element or String or Array
Default:
false
Constrains dragging to within the bounds of the specified element or region.
Multiple types supported:- Selector: The draggable element will be contained to the bounding box of the first element found by the selector. If no element is found, no containment will be set.
- Element: The draggable element will be contained to the bounding box of this element.
-
String: Possible values:
"parent","document","window". -
Array: An array defining a bounding box in the form
[ x1, y1, x2, y2 ].
cursorAtType: Object
Default:
false
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:
{ top, left, right, bottom }.delayType: Number
Default:
0
Time in milliseconds after mousedown until dragging should start. This option can be used to prevent unwanted drags when clicking on an element.
distanceType: Number
Default:
1
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.
gridType: Array
Default:
false
Snaps the dragging helper to a grid, every x and y pixels. The array must be of the form
[ x, y ].handleType: Selector or Element
Default:
false
If specified, restricts dragging from starting unless the mousedown occurs on the specified element(s).
helperType: String or Function()
Default:
"original"
Allows for a helper element to be used for dragging display.
Multiple types supported:-
String: If set to
"clone", then the element will be cloned and the clone will be dragged. - Function: A function that will return a DOMElement to use while dragging.
iframeFixType: Boolean or Selector
Default:
false
Prevent iframes from capturing the mousemove events during a drag. Useful in combination with the
Multiple types supported:cursorAt option, or in any case where the mouse cursor may not be over the helper.-
Boolean: When set to
true, transparent overlays will be placed over all iframes on the page. - Selector: Any iframes matching the selector will be covered by transparent overlays.
refreshPositionsType: Boolean
Default:
false
If set to
true, all droppable positions are calculated on every mousemove.
Caution: This solves issues on highly dynamic pages, but dramatically decreases performance.
revertType: Boolean or String
Default:
false
Whether the element should revert to its start position when dragging stops.
Multiple types supported:-
Boolean: If set to
truethe element will always revert. -
String: If set to
"invalid", revert will only occur if the draggable has not been dropped on a droppable. For"valid", it's the other way around.
revertDurationType: Number
Default:
500
The duration of the revert animation, in milliseconds. Ignored if the
revert option is false.scopeType: String
Default:
"default"
Used to group sets of draggable and droppable items, in addition to droppable's
accept option. A draggable with the same scope value as a droppable will be accepted by the droppable.scrollSensitivityType: Number
Default:
20
Distance in pixels from the edge of the viewport after which the viewport should scroll. Distance is relative to pointer, not the draggable. Ignored if the
scroll option is false.scrollSpeedType: Number
Default:
20
The speed at which the window should scroll once the mouse pointer gets within the
scrollSensitivity distance. Ignored if the scroll option is false.snapType: Boolean or Selector
Default:
false
Whether the element should snap to other elements.
Multiple types supported:-
Boolean: When set to
true, the element will snap to all other draggable elements. - Selector: A selector specifying which elements to snap to.
snapModeType: String
Default:
"both"
Determines which edges of snap elements the draggable will snap to. Ignored if the
snap option is false. Possible values: "inner", "outer", "both".snapToleranceType: Number
Default:
20
The distance in pixels from the snap element edges at which snapping should occur. Ignored if the
snap option is false.stackType: Selector
Default:
false
Controls the z-index of the set of elements that match the selector, always brings the currently dragged item to the front. Very useful in things like window managers.
Methods
destroy()
Removes the draggable functionality completely. This will return the element back to its pre-init state.
disable()
Disables the draggable.
enable()
Enables the draggable.
option( optionName ) Returns: Object
Gets the value currently associated with the specified
optionName.-
optionNameType: StringThe name of the option to get.
option() Returns: PlainObject
Gets an object containing key/value pairs representing the current draggable options hash.
option( optionName, value )
Sets the value of the draggable option associated with the specified
optionName.option( options )
Sets one or more options for the draggable.
-
optionsType: ObjectA map of option-value pairs to set.
widget() Returns: jQuery
Returns a
jQuery object containing the draggable element.
Events
drag( event, ui )
Triggered while the mouse is moved during the dragging.
start( event, ui )
Triggered when dragging starts.
stop( event, ui )
Triggered when dragging stops.
Make the selected elements draggable by mouse. If you want not just drag, but drag & drop, see the jQuery UI Droppable plugin, which provides a drop target for draggables.
Example:
A simple jQuery UI Draggable
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 | <!doctype html><html lang="en"><head> <meta charset="utf-8"> <title>draggable demo</title> <style> #draggable { width: 100px; height: 100px; background: #ccc; } </style></head><body><div id="draggable">Drag me</div><script>$( "#draggable" ).draggable();</script></body></html> |