Draggable Widget | jQuery UI API Documentation (original) (raw)

Description: Allow elements to be moved using the mouse.

QuickNavExamples

Options

Methods

Events

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.

Theming

The draggable widget uses the jQuery UI CSS framework to style its look and feel. If draggable specific styling is needed, the following CSS class names can be used for overrides or as keys for the classes option:

• ui-draggable: The draggable element. When the draggable is disabled, the ui-draggable-disabled class is added. While dragging, the ui-draggable-dragging class is added.
• ui-draggable-handle: The handle of the draggable, specified using the handle option. By default, the draggable element itself is also the handle.

Dependencies

• UI Core
• Widget Factory
• Mouse Interaction

Options

addClasses

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.

Code examples:

Initialize the draggable with the addClasses option specified:

Get or set the addClasses option, after initialization:

appendTo

Default: "parent"

Which element the draggable helper should be appended to while dragging.

Note: The appendTo option only works when the helper option is set to not use the original element.

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.

Code examples:

Initialize the draggable with the appendTo option specified:

Get or set the appendTo option, after initialization:

axis

Default: false

Constrains dragging to either the horizontal (x) or vertical (y) axis. Possible values: "x", "y".

Code examples:

Initialize the draggable with the axis option specified:

Get or set the axis option, after initialization:

cancel

Default: "input,textarea,button,select,option"

Prevents dragging from starting on specified elements.

Code examples:

Initialize the draggable with the cancel option specified:

Get or set the cancel option, after initialization:

classes

Default: {}

Specify additional classes to add to the widget's elements. Any of classes specified in the Theming section can be used as keys to override their value. To learn more about this option, check out the learn article about the classes option.

Code examples:

Initialize the draggable with the classes option specified, changing the theming for the ui-draggable class:

Get or set a property of the classes option, after initialization, here reading and changing the theming for the ui-draggable class:

connectToSortable

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.

Code examples:

Initialize the draggable with the connectToSortable option specified:

Get or set the connectToSortable option, after initialization:

containment

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 ].

Code examples:

Initialize the draggable with the containment option specified:

Get or set the containment option, after initialization:

cursor

Default: "auto"

The CSS cursor during the drag operation.

Code examples:

Initialize the draggable with the cursor option specified:

Get or set the cursor option, after initialization:

cursorAt

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 }.

Code examples:

Initialize the draggable with the cursorAt option specified:

Get or set the cursorAt option, after initialization:

delay

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. (version deprecated: 1.12)

Code examples:

Initialize the draggable with the delay option specified:

Get or set the delay option, after initialization:

disabled

Default: false

Disables the draggable if set to true.

Code examples:

Initialize the draggable with the disabled option specified:

Get or set the disabled option, after initialization:

distance

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. (version deprecated: 1.12)

Code examples:

Initialize the draggable with the distance option specified:

Get or set the distance option, after initialization:

grid

Default: false

Snaps the dragging helper to a grid, every x and y pixels. The array must be of the form [ x, y ].

Code examples:

Initialize the draggable with the grid option specified:

Get or set the grid option, after initialization:

handle

Default: false

If specified, restricts dragging from starting unless the mousedown occurs on the specified element(s). Only elements that descend from the draggable element are permitted.

Code examples:

Initialize the draggable with the handle option specified:

Get or set the handle option, after initialization:

helper

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 must return a jQuery or DOMElement to use while dragging.

Code examples:

Initialize the draggable with the helper option specified:

Get or set the helper option, after initialization:

iframeFix

Default: false

Prevent iframes from capturing the mousemove events during a drag. Useful in combination with the cursorAt option, or in any case where the mouse cursor may not be over the helper.

Multiple types supported:

• 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.

Code examples:

Initialize the draggable with the iframeFix option specified:

Get or set the iframeFix option, after initialization:

opacity

Default: false

Opacity for the helper while being dragged.

Code examples:

Initialize the draggable with the opacity option specified:

Get or set the opacity option, after initialization:

refreshPositions

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.

Code examples:

Initialize the draggable with the refreshPositions option specified:

Get or set the refreshPositions option, after initialization:

revert

Default: false

Whether the element should revert to its start position when dragging stops.

Multiple types supported:

• Boolean: If set to true the 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.
• Function: A function to determine whether the element should revert to its start position. The function must return true to revert the element.

Code examples:

Initialize the draggable with the revert option specified:

Get or set the revert option, after initialization:

revertDuration

Default: 500

The duration of the revert animation, in milliseconds. Ignored if the revert option is false.

Code examples:

Initialize the draggable with the revertDuration option specified:

Get or set the revertDuration option, after initialization:

scope

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.

Code examples:

Initialize the draggable with the scope option specified:

Get or set the scope option, after initialization:

snap

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.

Code examples:

Initialize the draggable with the snap option specified:

Get or set the snap option, after initialization:

snapMode

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".

Code examples:

Initialize the draggable with the snapMode option specified:

Get or set the snapMode option, after initialization:

snapTolerance

Default: 20

The distance in pixels from the snap element edges at which snapping should occur. Ignored if the snap option is false.

Code examples:

Initialize the draggable with the snapTolerance option specified:

Get or set the snapTolerance option, after initialization:

stack

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.

Code examples:

Initialize the draggable with the stack option specified:

Get or set the stack option, after initialization:

zIndex

Default: false

Z-index for the helper while being dragged.

Code examples:

Initialize the draggable with the zIndex option specified:

Get or set the zIndex option, after initialization:

Methods

destroy()Returns: jQuery (plugin only)

Removes the draggable functionality completely. This will return the element back to its pre-init state.

• This method does not accept any arguments.

Code examples:

Invoke the destroy method:

disable()Returns: jQuery (plugin only)

Disables the draggable.

• This method does not accept any arguments.

Code examples:

Invoke the disable method:

enable()Returns: jQuery (plugin only)

Enables the draggable.

• This method does not accept any arguments.

Code examples:

Invoke the enable method:

instance()Returns: Object

Retrieves the draggable's instance object. If the element does not have an associated instance, undefined is returned.

Unlike other widget methods, instance() is safe to call on any element after the draggable plugin has loaded.

• This method does not accept any arguments.

Code examples:

Invoke the instance method:

option( optionName )Returns: Object

Gets the value currently associated with the specified optionName.

Note: For options that have objects as their value, you can get the value of a specific key by using dot notation. For example, "foo.bar" would get the value of the bar property on the foo option.

• optionName
  The name of the option to get.

Code examples:

Invoke the method:

option()Returns: PlainObject

Gets an object containing key/value pairs representing the current draggable options hash.

• This signature does not accept any arguments.

Code examples:

Invoke the method:

option( optionName, value )Returns: jQuery (plugin only)

Sets the value of the draggable option associated with the specified optionName.

Note: For options that have objects as their value, you can set the value of just one property by using dot notation for optionName. For example, "foo.bar" would update only the bar property of the foo option.

• optionName
  The name of the option to set.
• value
  A value to set for the option.

Code examples:

Invoke the method:

option( options )Returns: jQuery (plugin only)

Sets one or more options for the draggable.

• options
  A map of option-value pairs to set.

Code examples:

Invoke the method:

Events

create( event, ui )Type: dragcreate

Triggered when the draggable is created.

• event
• ui

Note: The ui object is empty but included for consistency with other events.

Code examples:

Initialize the draggable with the create callback specified:

Bind an event listener to the dragcreate event:

drag( event, ui )Type: drag

Triggered while the mouse is moved during the dragging, immediately before the current move happens.

• event
• ui
  • helper
    The jQuery object representing the helper that's being dragged.
  • position
    Current CSS position of the helper as { top, left } object. The values may be changed to modify where the element will be positioned. This is useful for custom containment, snapping, etc.
  • offset
    Current offset position of the helper as { top, left } object.

Code examples:

Initialize the draggable with the drag callback specified:

Bind an event listener to the drag event:

Constrain movement via ui.position:

start( event, ui )Type: dragstart

Triggered when dragging starts.

• event
• ui
  • helper
    The jQuery object representing the helper that's being dragged.
  • position
    Current CSS position of the helper as { top, left } object.
  • offset
    Current offset position of the helper as { top, left } object.

Code examples:

Initialize the draggable with the start callback specified:

Bind an event listener to the dragstart event:

stop( event, ui )Type: dragstop

Triggered when dragging stops.

• event
• ui
  • helper
    The jQuery object representing the helper that's being dragged.
  • position
    Current CSS position of the helper as { top, left } object.
  • offset
    Current offset position of the helper as { top, left } object.

Code examples:

Initialize the draggable with the stop callback specified:

Bind an event listener to the dragstop event:

Example:

A simple jQuery UI Draggable

Demo: