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

Description: Reorder elements in a list or grid using the mouse.

QuickNavExamples

Options

Methods

Events

The jQuery UI Sortable plugin makes selected elements sortable by dragging with the mouse.

Note: In order to sort table rows, the tbody must be made sortable, not the table.

Theming

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

• ui-sortable: The sortable element.
  • ui-sortable-handle: The handle of each sortable item, specified using the handle option. By default, each sortable item itself is also the handle.
  • ui-sortable-placeholder: The element used to show the future position of the item currently being sorted.
• ui-sortable-helper: The element shown while dragging a sortable item. The element actually used depends on the helper option.

Dependencies

• UI Core
• Widget Factory
• Mouse Interaction

Options

appendTo

Default: "parent"

Defines where the helper that moves with the mouse is being appended to during the drag (for example, to resolve overlap/zIndex issues).

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 sortable item.

Code examples:

Initialize the sortable with the appendTo option specified:

Get or set the appendTo option, after initialization:

axis

Default: false

If defined, the items can be dragged only horizontally or vertically. Possible values: "x", "y".

Code examples:

Initialize the sortable with the axis option specified:

Get or set the axis option, after initialization:

cancel

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

Prevents sorting if you start on elements matching the selector.

Code examples:

Initialize the sortable 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 sortable with the classes option specified, changing the theming for the ui-sortable class:

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

connectWith

Default: false

A selector of other sortable elements that the items from this list should be connected to. This is a one-way relationship, if you want the items to be connected in both directions, the connectWith option must be set on both sortable elements.

Code examples:

Initialize the sortable with the connectWith option specified:

Get or set the connectWith option, after initialization:

containment

Default: false

Defines a bounding box that the sortable items are constrained to while dragging.

Note: The element specified for containment must have a calculated width and height (though it need not be explicit). For example, if you have float: left sortable children and specify containment: "parent" be sure to have float: left on the sortable/parent container as well or it will have height: 0, causing undefined behavior.

Multiple types supported:

• Element: An element to use as the container.
• Selector: A selector specifying an element to use as the container.
• String: A string identifying an element to use as the container. Possible values: "parent", "document", "window".

Code examples:

Initialize the sortable with the containment option specified:

Get or set the containment option, after initialization:

cursor

Default: "auto"

Defines the cursor that is being shown while sorting.

Code examples:

Initialize the sortable with the cursor option specified:

Get or set the cursor option, after initialization:

cursorAt

Default: false

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: { top, left, right, bottom }.

Code examples:

Initialize the sortable with the cursorAt option specified:

Get or set the cursorAt option, after initialization:

delay

Default: 0

Time in milliseconds to define when the sorting should start. Adding a delay helps preventing unwanted drags when clicking on an element. (version deprecated: 1.12)

Code examples:

Initialize the sortable with the delay option specified:

Get or set the delay option, after initialization:

disabled

Default: false

Disables the sortable if set to true.

Code examples:

Initialize the sortable with the disabled option specified:

Get or set the disabled option, after initialization:

distance

Default: 1

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

Code examples:

Initialize the sortable with the distance option specified:

Get or set the distance option, after initialization:

dropOnEmpty

Default: true

If false, items from this sortable can't be dropped on an empty connect sortable (see the connectWith option.

Code examples:

Initialize the sortable with the dropOnEmpty option specified:

Get or set the dropOnEmpty option, after initialization:

forceHelperSize

Default: false

If true, forces the helper to have a size.

Code examples:

Initialize the sortable with the forceHelperSize option specified:

Get or set the forceHelperSize option, after initialization:

forcePlaceholderSize

Default: false

If true, forces the placeholder to have a size.

Code examples:

Initialize the sortable with the forcePlaceholderSize option specified:

Get or set the forcePlaceholderSize option, after initialization:

grid

Default: false

Snaps the sorting element or helper to a grid, every x and y pixels. Array values: [ x, y ].

Code examples:

Initialize the sortable with the grid option specified:

Get or set the grid option, after initialization:

handle

Default: false

Restricts sort start click to the specified element.

Code examples:

Initialize the sortable 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. The function receives the event and the jQuery element being sorted.

Code examples:

Initialize the sortable with the helper option specified:

Get or set the helper option, after initialization:

items

Default: "> *"

Specifies which items inside the element should be sortable.

Code examples:

Initialize the sortable with the items option specified:

Get or set the items option, after initialization:

opacity

Default: false

Defines the opacity of the helper while sorting. From 0.01 to 1.

Code examples:

Initialize the sortable with the opacity option specified:

Get or set the opacity option, after initialization:

placeholder

Default: false

A class name that gets applied to the otherwise white space.

Code examples:

Initialize the sortable with the placeholder option specified:

Get or set the placeholder option, after initialization:

revert

Default: false

Whether the sortable items should revert to their new positions using a smooth animation.

Multiple types supported:

• Boolean: When set to true, the items will animate with the default duration.
• Number: The duration for the animation, in milliseconds.

Code examples:

Initialize the sortable with the revert option specified:

Get or set the revert option, after initialization:

tolerance

Default: "intersect"

Specifies which mode to use for testing whether the item being moved is hovering over another item. Possible values:

• "intersect": The item overlaps the other item by at least 50%.
• "pointer": The mouse pointer overlaps the other item.

Code examples:

Initialize the sortable with the tolerance option specified:

Get or set the tolerance option, after initialization:

zIndex

Default: 1000

Z-index for element/helper while being sorted.

Code examples:

Initialize the sortable with the zIndex option specified:

Get or set the zIndex option, after initialization:

Methods

cancel()Returns: jQuery (plugin only)

Cancels a change in the current sortable and reverts it to the state prior to when the current sort was started. Useful in the stop and receive callback functions.

• This method does not accept any arguments.

Code examples:

Invoke the cancel method:

destroy()Returns: jQuery (plugin only)

Removes the sortable 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 sortable.

• This method does not accept any arguments.

Code examples:

Invoke the disable method:

enable()Returns: jQuery (plugin only)

Enables the sortable.

• This method does not accept any arguments.

Code examples:

Invoke the enable method:

instance()Returns: Object

Retrieves the sortable'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 sortable 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 sortable 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 sortable 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 sortable.

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

Code examples:

Invoke the method:

refresh()Returns: jQuery (plugin only)

Refresh the sortable items. Triggers the reloading of all sortable items, causing new items to be recognized.

• This method does not accept any arguments.

Code examples:

Invoke the refresh method:

refreshPositions()Returns: jQuery (plugin only)

Refresh the cached positions of the sortable items. Calling this method refreshes the cached item positions of all sortables.

• This method does not accept any arguments.

Code examples:

Invoke the refreshPositions method:

serialize( options )Returns: String

Serializes the sortable's item ids into a form/ajax submittable string. Calling this method produces a hash that can be appended to any url to easily submit a new item order back to the server.

It works by default by looking at the id of each item in the format "setname_number", and it spits out a hash like "setname[]=number&setname[]=number".

Note: If serialize returns an empty string, make sure the id attributes include an underscore. They must be in the form: "setnumber" For example, a 3 element list with id attributes "foo1", "foo5", "foo2" will serialize to "foo[]=1&foo[]=5&foo[]=2". You can use an underscore, equal sign or hyphen to separate the set and number. For example "foo=1", "foo-1", and "foo1" all serialize to "foo[]=1".

• options
  Options to customize the serialization.
  • key (default: the part of the attribute in front of the separator)
    Replaces part1[] with the specified value.
  • attribute (default: "id")
    The name of the attribute to use for the values.
  • expression (default: /(.+)[-=_](.+)/)
    A regular expression used to split the attribute value into key and value parts.

Code examples:

Invoke the serialize method:

toArray( options )Returns: Array

Serializes the sortable's item id's into an array of string.

• options
  Options to customize the serialization.
  • attribute (default: "id")
    The name of the attribute to use for the values.

Code examples:

Invoke the toArray method:

Events

activate( event, ui )Type: sortactivate

This event is triggered when using connected lists, every connected list on drag start receives it.

• event
• ui
  • helper
    The jQuery object representing the helper being sorted.
  • item
    The jQuery object representing the current dragged element.
  • offset
    The current absolute position of the helper represented as { top, left }.
  • position
    The current position of the helper represented as { top, left }.
  • originalPosition
    The original position of the element represented as { top, left }.
  • sender
    The sortable that the item comes from if moving from one sortable to another.
  • placeholder
    The jQuery object representing the element being used as a placeholder.

Code examples:

Initialize the sortable with the activate callback specified:

Bind an event listener to the sortactivate event:

beforeStop( event, ui )Type: sortbeforestop

This event is triggered when sorting stops, but when the placeholder/helper is still available.

• event
• ui
  • helper
    The jQuery object representing the helper being sorted.
  • item
    The jQuery object representing the current dragged element.
  • offset
    The current absolute position of the helper represented as { top, left }.
  • position
    The current position of the helper represented as { top, left }.
  • originalPosition
    The original position of the element represented as { top, left }.
  • sender
    The sortable that the item comes from if moving from one sortable to another.
  • placeholder
    The jQuery object representing the element being used as a placeholder.

Code examples:

Initialize the sortable with the beforeStop callback specified:

Bind an event listener to the sortbeforestop event:

change( event, ui )Type: sortchange

This event is triggered during sorting, but only when the DOM position has changed.

• event
• ui
  • helper
    The jQuery object representing the helper being sorted.
  • item
    The jQuery object representing the current dragged element.
  • offset
    The current absolute position of the helper represented as { top, left }.
  • position
    The current position of the helper represented as { top, left }.
  • originalPosition
    The original position of the element represented as { top, left }.
  • sender
    The sortable that the item comes from if moving from one sortable to another.
  • placeholder
    The jQuery object representing the element being used as a placeholder.

Code examples:

Initialize the sortable with the change callback specified:

Bind an event listener to the sortchange event:

create( event, ui )Type: sortcreate

Triggered when the sortable is created.

• event
• ui

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

Code examples:

Initialize the sortable with the create callback specified:

Bind an event listener to the sortcreate event:

deactivate( event, ui )Type: sortdeactivate

This event is triggered when sorting was stopped, is propagated to all possible connected lists.

• event
• ui
  • helper
    The jQuery object representing the helper being sorted.
  • item
    The jQuery object representing the current dragged element.
  • offset
    The current absolute position of the helper represented as { top, left }.
  • position
    The current position of the helper represented as { top, left }.
  • originalPosition
    The original position of the element represented as { top, left }.
  • sender
    The sortable that the item comes from if moving from one sortable to another.
  • placeholder
    The jQuery object representing the element being used as a placeholder.

Code examples:

Initialize the sortable with the deactivate callback specified:

Bind an event listener to the sortdeactivate event:

out( event, ui )Type: sortout

This event is triggered when a sortable item is moved away from a sortable list.

Note: This event is also triggered when a sortable item is dropped.

• event
• ui
  • helper
    The jQuery object representing the helper being sorted.
  • item
    The jQuery object representing the current dragged element.
  • offset
    The current absolute position of the helper represented as { top, left }.
  • position
    The current position of the helper represented as { top, left }.
  • originalPosition
    The original position of the element represented as { top, left }.
  • sender
    The sortable that the item comes from if moving from one sortable to another.
  • placeholder
    The jQuery object representing the element being used as a placeholder.

Code examples:

Initialize the sortable with the out callback specified:

Bind an event listener to the sortout event:

over( event, ui )Type: sortover

This event is triggered when a sortable item is moved into a sortable list.

• event
• ui
  • helper
    The jQuery object representing the helper being sorted.
  • item
    The jQuery object representing the current dragged element.
  • offset
    The current absolute position of the helper represented as { top, left }.
  • position
    The current position of the helper represented as { top, left }.
  • originalPosition
    The original position of the element represented as { top, left }.
  • sender
    The sortable that the item comes from if moving from one sortable to another.
  • placeholder
    The jQuery object representing the element being used as a placeholder.

Code examples:

Initialize the sortable with the over callback specified:

Bind an event listener to the sortover event:

receive( event, ui )Type: sortreceive

This event is triggered when an item from a connected sortable list has been dropped into another list. The latter is the event target.

• event
• ui
  • helper
    The jQuery object representing the helper being sorted.
  • item
    The jQuery object representing the current dragged element.
  • offset
    The current absolute position of the helper represented as { top, left }.
  • position
    The current position of the helper represented as { top, left }.
  • originalPosition
    The original position of the element represented as { top, left }.
  • sender
    The sortable that the item comes from if moving from one sortable to another.
  • placeholder
    The jQuery object representing the element being used as a placeholder.

Code examples:

Initialize the sortable with the receive callback specified:

Bind an event listener to the sortreceive event:

remove( event, ui )Type: sortremove

This event is triggered when a sortable item from the list has been dropped into another. The former is the event target.

• event
• ui
  • helper
    The jQuery object representing the helper being sorted.
  • item
    The jQuery object representing the current dragged element.
  • offset
    The current absolute position of the helper represented as { top, left }.
  • position
    The current position of the helper represented as { top, left }.
  • originalPosition
    The original position of the element represented as { top, left }.
  • placeholder
    The jQuery object representing the element being used as a placeholder.

Code examples:

Initialize the sortable with the remove callback specified:

Bind an event listener to the sortremove event:

sort( event, ui )Type: sort

This event is triggered during sorting.

• event
• ui
  • helper
    The jQuery object representing the helper being sorted.
  • item
    The jQuery object representing the current dragged element.
  • offset
    The current absolute position of the helper represented as { top, left }.
  • position
    The current position of the helper represented as { top, left }.
  • originalPosition
    The original position of the element represented as { top, left }.
  • sender
    The sortable that the item comes from if moving from one sortable to another.
  • placeholder
    The jQuery object representing the element being used as a placeholder.

Code examples:

Initialize the sortable with the sort callback specified:

Bind an event listener to the sort event:

start( event, ui )Type: sortstart

This event is triggered when sorting starts.

• event
• ui
  • helper
    The jQuery object representing the helper being sorted.
  • item
    The jQuery object representing the current dragged element.
  • offset
    The current absolute position of the helper represented as { top, left }.
  • position
    The current position of the helper represented as { top, left }.
  • originalPosition
    The original position of the element represented as { top, left }.
  • sender
    The sortable that the item comes from if moving from one sortable to another.
  • placeholder
    The jQuery object representing the element being used as a placeholder.

Code examples:

Initialize the sortable with the start callback specified:

Bind an event listener to the sortstart event:

stop( event, ui )Type: sortstop

This event is triggered when sorting has stopped.

• event
• ui
  • helper
    The jQuery object representing the helper being sorted.
  • item
    The jQuery object representing the current dragged element.
  • offset
    The current absolute position of the helper represented as { top, left }.
  • position
    The current position of the helper represented as { top, left }.
  • originalPosition
    The original position of the element represented as { top, left }.
  • sender
    The sortable that the item comes from if moving from one sortable to another.
  • placeholder
    The jQuery object representing the element being used as a placeholder.

Code examples:

Initialize the sortable with the stop callback specified:

Bind an event listener to the sortstop event:

update( event, ui )Type: sortupdate

This event is triggered when the user stopped sorting and the DOM position has changed.

• event
• ui
  • helper
    The jQuery object representing the helper being sorted.
  • item
    The jQuery object representing the current dragged element.
  • offset
    The current absolute position of the helper represented as { top, left }.
  • position
    The current position of the helper represented as { top, left }.
  • originalPosition
    The original position of the element represented as { top, left }.
  • sender
    The sortable that the item comes from if moving from one sortable to another.
  • placeholder
    The jQuery object representing the element being used as a placeholder.

Code examples:

Initialize the sortable with the update callback specified:

Bind an event listener to the sortupdate event:

Example:

A simple jQuery UI Sortable.

Demo: