draggable.html 89 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214
  1. <!doctype html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>jQuery UI draggable documentation</title>
  6. <style>
  7. body {
  8. font-family: "Trebuchet MS", "Arial", "Helvetica", "Verdana", "sans-serif"
  9. }
  10. .gutter {
  11. display: none;
  12. }
  13. </style>
  14. </head>
  15. <body>
  16. <script>{
  17. "title":
  18. "Draggable Widget",
  19. "excerpt":
  20. "Allow elements to be moved using the mouse.",
  21. "termSlugs": {
  22. "category": [
  23. "interactions"
  24. ]
  25. }
  26. }</script><article id="draggable1" class="entry widget"><h2 class="section-title">
  27. <span>Draggable Widget</span><span class="version-details">version added: 1.0</span>
  28. </h2>
  29. <div class="entry-wrapper">
  30. <p class="desc"><strong>Description: </strong>Allow elements to be moved using the mouse.</p>
  31. <section id="quick-nav"><header><h2>QuickNav<a href="#entry-examples">Examples</a>
  32. </h2></header><div class="quick-nav-section">
  33. <h3>Options</h3>
  34. <div><a href="#option-addClasses">addClasses</a></div>
  35. <div><a href="#option-appendTo">appendTo</a></div>
  36. <div><a href="#option-axis">axis</a></div>
  37. <div><a href="#option-cancel">cancel</a></div>
  38. <div><a href="#option-connectToSortable">connectToSortable</a></div>
  39. <div><a href="#option-containment">containment</a></div>
  40. <div><a href="#option-cursor">cursor</a></div>
  41. <div><a href="#option-cursorAt">cursorAt</a></div>
  42. <div><a href="#option-delay">delay</a></div>
  43. <div><a href="#option-disabled">disabled</a></div>
  44. <div><a href="#option-distance">distance</a></div>
  45. <div><a href="#option-grid">grid</a></div>
  46. <div><a href="#option-handle">handle</a></div>
  47. <div><a href="#option-helper">helper</a></div>
  48. <div><a href="#option-iframeFix">iframeFix</a></div>
  49. <div><a href="#option-opacity">opacity</a></div>
  50. <div><a href="#option-refreshPositions">refreshPositions</a></div>
  51. <div><a href="#option-revert">revert</a></div>
  52. <div><a href="#option-revertDuration">revertDuration</a></div>
  53. <div><a href="#option-scope">scope</a></div>
  54. <div><a href="#option-scroll">scroll</a></div>
  55. <div><a href="#option-scrollSensitivity">scrollSensitivity</a></div>
  56. <div><a href="#option-scrollSpeed">scrollSpeed</a></div>
  57. <div><a href="#option-snap">snap</a></div>
  58. <div><a href="#option-snapMode">snapMode</a></div>
  59. <div><a href="#option-snapTolerance">snapTolerance</a></div>
  60. <div><a href="#option-stack">stack</a></div>
  61. <div><a href="#option-zIndex">zIndex</a></div>
  62. </div>
  63. <div class="quick-nav-section">
  64. <h3>Methods</h3>
  65. <div><a href="#method-destroy">destroy</a></div>
  66. <div><a href="#method-disable">disable</a></div>
  67. <div><a href="#method-enable">enable</a></div>
  68. <div><a href="#method-option">option</a></div>
  69. <div><a href="#method-widget">widget</a></div>
  70. </div>
  71. <div class="quick-nav-section">
  72. <h3>Events</h3>
  73. <div><a href="#event-create">create</a></div>
  74. <div><a href="#event-drag">drag</a></div>
  75. <div><a href="#event-start">start</a></div>
  76. <div><a href="#event-stop">stop</a></div>
  77. </div></section><div class="longdesc" id="entry-longdesc">
  78. <p>Make the selected elements draggable by mouse. If you want not just drag, but drag &amp; drop, see the <a href="/droppable/">jQuery UI Droppable plugin</a>, which provides a drop target for draggables.</p>
  79. <h3>Dependencies</h3>
  80. <ul>
  81. <li><a href="/category/ui-core/">UI Core</a></li>
  82. <li><a href="/jQuery.widget/">Widget Factory</a></li>
  83. <li><a href="/mouse/">Mouse Interaction</a></li>
  84. </ul>
  85. </div>
  86. <section id="options"><header><h2>Options</h2></header><div id="option-addClasses" class="api-item first-item">
  87. <h3>addClasses<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Boolean">Boolean</a></span>
  88. </h3>
  89. <div class="default">
  90. <strong>Default: </strong><code>true</code>
  91. </div>
  92. <div>If set to <code>false</code>, will prevent the <code>ui-draggable</code> class from being added. This may be desired as a performance optimization when calling <code>.draggable()</code> on hundreds of elements.</div>
  93. <strong>Code examples:</strong><p>Initialize the draggable with the <code>addClasses</code> option specified:</p>
  94. <div class="syntaxhighlighter javascript nogutter">
  95. <table>
  96. <tbody>
  97. <tr>
  98. <td class="gutter">
  99. <div class="line n1">1</div>
  100. </td>
  101. <td class="code">
  102. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable({ addClasses: <span class="literal">false</span> });</code></div></div></pre>
  103. </td>
  104. </tr>
  105. </tbody>
  106. </table>
  107. </div>
  108. <p>Get or set the <code>addClasses</code> option, after initialization:</p>
  109. <div class="syntaxhighlighter javascript nogutter">
  110. <table>
  111. <tbody>
  112. <tr>
  113. <td class="gutter">
  114. <div class="line n1">1</div>
  115. <div class="line n2">2</div>
  116. <div class="line n3">3</div>
  117. <div class="line n4">4</div>
  118. <div class="line n5">5</div>
  119. </td>
  120. <td class="code">
  121. <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> addClasses = $( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"addClasses"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"addClasses"</span>, <span class="literal">false</span> );</code></div></div></pre>
  122. </td>
  123. </tr>
  124. </tbody>
  125. </table>
  126. </div>
  127. </div>
  128. <div id="option-appendTo" class="api-item">
  129. <h3>appendTo<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#jQuery">jQuery</a> or <a href="http://api.jquery.com/Types/#Element">Element</a> or <a href="http://api.jquery.com/Types/#Selector">Selector</a> or <a href="http://api.jquery.com/Types/#String">String</a></span>
  130. </h3>
  131. <div class="default">
  132. <strong>Default: </strong><code>"parent"</code>
  133. </div>
  134. <div>Which element the draggable helper should be appended to while dragging.</div>
  135. <strong>Multiple types supported:</strong><ul>
  136. <li>
  137. <strong>jQuery</strong>: A jQuery object containing the element to append the helper to.</li>
  138. <li>
  139. <strong>Element</strong>: The element to append the helper to.</li>
  140. <li>
  141. <strong>Selector</strong>: A selector specifying which element to append the helper to.</li>
  142. <li>
  143. <strong>String</strong>: The string <code>"parent"</code> will cause the helper to be a sibling of the draggable.</li>
  144. </ul>
  145. <strong>Code examples:</strong><p>Initialize the draggable with the <code>appendTo</code> option specified:</p>
  146. <div class="syntaxhighlighter javascript nogutter">
  147. <table>
  148. <tbody>
  149. <tr>
  150. <td class="gutter">
  151. <div class="line n1">1</div>
  152. </td>
  153. <td class="code">
  154. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable({ appendTo: <span class="string">"body"</span> });</code></div></div></pre>
  155. </td>
  156. </tr>
  157. </tbody>
  158. </table>
  159. </div>
  160. <p>Get or set the <code>appendTo</code> option, after initialization:</p>
  161. <div class="syntaxhighlighter javascript nogutter">
  162. <table>
  163. <tbody>
  164. <tr>
  165. <td class="gutter">
  166. <div class="line n1">1</div>
  167. <div class="line n2">2</div>
  168. <div class="line n3">3</div>
  169. <div class="line n4">4</div>
  170. <div class="line n5">5</div>
  171. </td>
  172. <td class="code">
  173. <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> appendTo = $( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"appendTo"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"appendTo"</span>, <span class="string">"body"</span> );</code></div></div></pre>
  174. </td>
  175. </tr>
  176. </tbody>
  177. </table>
  178. </div>
  179. </div>
  180. <div id="option-axis" class="api-item">
  181. <h3>axis<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#String">String</a></span>
  182. </h3>
  183. <div class="default">
  184. <strong>Default: </strong><code>false</code>
  185. </div>
  186. <div>Constrains dragging to either the horizontal (x) or vertical (y) axis. Possible values: <code>"x"</code>, <code>"y"</code>.</div>
  187. <strong>Code examples:</strong><p>Initialize the draggable with the <code>axis</code> option specified:</p>
  188. <div class="syntaxhighlighter javascript nogutter">
  189. <table>
  190. <tbody>
  191. <tr>
  192. <td class="gutter">
  193. <div class="line n1">1</div>
  194. </td>
  195. <td class="code">
  196. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable({ axis: <span class="string">"x"</span> });</code></div></div></pre>
  197. </td>
  198. </tr>
  199. </tbody>
  200. </table>
  201. </div>
  202. <p>Get or set the <code>axis</code> option, after initialization:</p>
  203. <div class="syntaxhighlighter javascript nogutter">
  204. <table>
  205. <tbody>
  206. <tr>
  207. <td class="gutter">
  208. <div class="line n1">1</div>
  209. <div class="line n2">2</div>
  210. <div class="line n3">3</div>
  211. <div class="line n4">4</div>
  212. <div class="line n5">5</div>
  213. </td>
  214. <td class="code">
  215. <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> axis = $( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"axis"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"axis"</span>, <span class="string">"x"</span> );</code></div></div></pre>
  216. </td>
  217. </tr>
  218. </tbody>
  219. </table>
  220. </div>
  221. </div>
  222. <div id="option-cancel" class="api-item">
  223. <h3>cancel<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Selector">Selector</a></span>
  224. </h3>
  225. <div class="default">
  226. <strong>Default: </strong><code>"input,textarea,button,select,option"</code>
  227. </div>
  228. <div>Prevents dragging from starting on specified elements.</div>
  229. <strong>Code examples:</strong><p>Initialize the draggable with the <code>cancel</code> option specified:</p>
  230. <div class="syntaxhighlighter javascript nogutter">
  231. <table>
  232. <tbody>
  233. <tr>
  234. <td class="gutter">
  235. <div class="line n1">1</div>
  236. </td>
  237. <td class="code">
  238. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable({ cancel: <span class="string">".title"</span> });</code></div></div></pre>
  239. </td>
  240. </tr>
  241. </tbody>
  242. </table>
  243. </div>
  244. <p>Get or set the <code>cancel</code> option, after initialization:</p>
  245. <div class="syntaxhighlighter javascript nogutter">
  246. <table>
  247. <tbody>
  248. <tr>
  249. <td class="gutter">
  250. <div class="line n1">1</div>
  251. <div class="line n2">2</div>
  252. <div class="line n3">3</div>
  253. <div class="line n4">4</div>
  254. <div class="line n5">5</div>
  255. </td>
  256. <td class="code">
  257. <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> cancel = $( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"cancel"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"cancel"</span>, <span class="string">".title"</span> );</code></div></div></pre>
  258. </td>
  259. </tr>
  260. </tbody>
  261. </table>
  262. </div>
  263. </div>
  264. <div id="option-connectToSortable" class="api-item">
  265. <h3>connectToSortable<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Selector">Selector</a></span>
  266. </h3>
  267. <div class="default">
  268. <strong>Default: </strong><code>false</code>
  269. </div>
  270. <div>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 <a href="#option-helper"><code>helper</code></a> option must be set to <code>"clone"</code> in order to work flawlessly. Requires the <a href="/sortable/">jQuery UI Sortable plugin</a> to be included.</div>
  271. <strong>Code examples:</strong><p>Initialize the draggable with the <code>connectToSortable</code> option specified:</p>
  272. <div class="syntaxhighlighter javascript nogutter">
  273. <table>
  274. <tbody>
  275. <tr>
  276. <td class="gutter">
  277. <div class="line n1">1</div>
  278. </td>
  279. <td class="code">
  280. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable({ connectToSortable: <span class="string">"#my-sortable"</span> });</code></div></div></pre>
  281. </td>
  282. </tr>
  283. </tbody>
  284. </table>
  285. </div>
  286. <p>Get or set the <code>connectToSortable</code> option, after initialization:</p>
  287. <div class="syntaxhighlighter javascript nogutter">
  288. <table>
  289. <tbody>
  290. <tr>
  291. <td class="gutter">
  292. <div class="line n1">1</div>
  293. <div class="line n2">2</div>
  294. <div class="line n3">3</div>
  295. <div class="line n4">4</div>
  296. <div class="line n5">5</div>
  297. </td>
  298. <td class="code">
  299. <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> connectToSortable = $( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"connectToSortable"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"connectToSortable"</span>, <span class="string">"#my-sortable"</span> );</code></div></div></pre>
  300. </td>
  301. </tr>
  302. </tbody>
  303. </table>
  304. </div>
  305. </div>
  306. <div id="option-containment" class="api-item">
  307. <h3>containment<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Selector">Selector</a> or <a href="http://api.jquery.com/Types/#Element">Element</a> or <a href="http://api.jquery.com/Types/#String">String</a> or <a href="http://api.jquery.com/Types/#Array">Array</a></span>
  308. </h3>
  309. <div class="default">
  310. <strong>Default: </strong><code>false</code>
  311. </div>
  312. <div>Constrains dragging to within the bounds of the specified element or region.</div>
  313. <strong>Multiple types supported:</strong><ul>
  314. <li>
  315. <strong>Selector</strong>: 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.</li>
  316. <li>
  317. <strong>Element</strong>: The draggable element will be contained to the bounding box of this element.</li>
  318. <li>
  319. <strong>String</strong>: Possible values: <code>"parent"</code>, <code>"document"</code>, <code>"window"</code>.</li>
  320. <li>
  321. <strong>Array</strong>: An array defining a bounding box in the form <code>[ x1, y1, x2, y2 ]</code>.</li>
  322. </ul>
  323. <strong>Code examples:</strong><p>Initialize the draggable with the <code>containment</code> option specified:</p>
  324. <div class="syntaxhighlighter javascript nogutter">
  325. <table>
  326. <tbody>
  327. <tr>
  328. <td class="gutter">
  329. <div class="line n1">1</div>
  330. </td>
  331. <td class="code">
  332. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable({ containment: <span class="string">"parent"</span> });</code></div></div></pre>
  333. </td>
  334. </tr>
  335. </tbody>
  336. </table>
  337. </div>
  338. <p>Get or set the <code>containment</code> option, after initialization:</p>
  339. <div class="syntaxhighlighter javascript nogutter">
  340. <table>
  341. <tbody>
  342. <tr>
  343. <td class="gutter">
  344. <div class="line n1">1</div>
  345. <div class="line n2">2</div>
  346. <div class="line n3">3</div>
  347. <div class="line n4">4</div>
  348. <div class="line n5">5</div>
  349. </td>
  350. <td class="code">
  351. <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> containment = $( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"containment"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"containment"</span>, <span class="string">"parent"</span> );</code></div></div></pre>
  352. </td>
  353. </tr>
  354. </tbody>
  355. </table>
  356. </div>
  357. </div>
  358. <div id="option-cursor" class="api-item">
  359. <h3>cursor<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#String">String</a></span>
  360. </h3>
  361. <div class="default">
  362. <strong>Default: </strong><code>"auto"</code>
  363. </div>
  364. <div>The CSS cursor during the drag operation.</div>
  365. <strong>Code examples:</strong><p>Initialize the draggable with the <code>cursor</code> option specified:</p>
  366. <div class="syntaxhighlighter javascript nogutter">
  367. <table>
  368. <tbody>
  369. <tr>
  370. <td class="gutter">
  371. <div class="line n1">1</div>
  372. </td>
  373. <td class="code">
  374. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable({ cursor: <span class="string">"crosshair"</span> });</code></div></div></pre>
  375. </td>
  376. </tr>
  377. </tbody>
  378. </table>
  379. </div>
  380. <p>Get or set the <code>cursor</code> option, after initialization:</p>
  381. <div class="syntaxhighlighter javascript nogutter">
  382. <table>
  383. <tbody>
  384. <tr>
  385. <td class="gutter">
  386. <div class="line n1">1</div>
  387. <div class="line n2">2</div>
  388. <div class="line n3">3</div>
  389. <div class="line n4">4</div>
  390. <div class="line n5">5</div>
  391. </td>
  392. <td class="code">
  393. <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> cursor = $( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"cursor"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"cursor"</span>, <span class="string">"crosshair"</span> );</code></div></div></pre>
  394. </td>
  395. </tr>
  396. </tbody>
  397. </table>
  398. </div>
  399. </div>
  400. <div id="option-cursorAt" class="api-item">
  401. <h3>cursorAt<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Object">Object</a></span>
  402. </h3>
  403. <div class="default">
  404. <strong>Default: </strong><code>false</code>
  405. </div>
  406. <div>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>.</div>
  407. <strong>Code examples:</strong><p>Initialize the draggable with the <code>cursorAt</code> option specified:</p>
  408. <div class="syntaxhighlighter javascript nogutter">
  409. <table>
  410. <tbody>
  411. <tr>
  412. <td class="gutter">
  413. <div class="line n1">1</div>
  414. </td>
  415. <td class="code">
  416. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable({ cursorAt: { left: <span class="number">5</span> } });</code></div></div></pre>
  417. </td>
  418. </tr>
  419. </tbody>
  420. </table>
  421. </div>
  422. <p>Get or set the <code>cursorAt</code> option, after initialization:</p>
  423. <div class="syntaxhighlighter javascript nogutter">
  424. <table>
  425. <tbody>
  426. <tr>
  427. <td class="gutter">
  428. <div class="line n1">1</div>
  429. <div class="line n2">2</div>
  430. <div class="line n3">3</div>
  431. <div class="line n4">4</div>
  432. <div class="line n5">5</div>
  433. </td>
  434. <td class="code">
  435. <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> cursorAt = $( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"cursorAt"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"cursorAt"</span>, { left: <span class="number">5</span> } );</code></div></div></pre>
  436. </td>
  437. </tr>
  438. </tbody>
  439. </table>
  440. </div>
  441. </div>
  442. <div id="option-delay" class="api-item">
  443. <h3>delay<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Number">Number</a></span>
  444. </h3>
  445. <div class="default">
  446. <strong>Default: </strong><code>0</code>
  447. </div>
  448. <div>Time in milliseconds after mousedown until dragging should start. This option can be used to prevent unwanted drags when clicking on an element.</div>
  449. <strong>Code examples:</strong><p>Initialize the draggable with the <code>delay</code> option specified:</p>
  450. <div class="syntaxhighlighter javascript nogutter">
  451. <table>
  452. <tbody>
  453. <tr>
  454. <td class="gutter">
  455. <div class="line n1">1</div>
  456. </td>
  457. <td class="code">
  458. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable({ delay: <span class="number">300</span> });</code></div></div></pre>
  459. </td>
  460. </tr>
  461. </tbody>
  462. </table>
  463. </div>
  464. <p>Get or set the <code>delay</code> option, after initialization:</p>
  465. <div class="syntaxhighlighter javascript nogutter">
  466. <table>
  467. <tbody>
  468. <tr>
  469. <td class="gutter">
  470. <div class="line n1">1</div>
  471. <div class="line n2">2</div>
  472. <div class="line n3">3</div>
  473. <div class="line n4">4</div>
  474. <div class="line n5">5</div>
  475. </td>
  476. <td class="code">
  477. <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> delay = $( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"delay"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"delay"</span>, <span class="number">300</span> );</code></div></div></pre>
  478. </td>
  479. </tr>
  480. </tbody>
  481. </table>
  482. </div>
  483. </div>
  484. <div id="option-disabled" class="api-item">
  485. <h3>disabled<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Boolean">Boolean</a></span>
  486. </h3>
  487. <div class="default">
  488. <strong>Default: </strong><code>false</code>
  489. </div>
  490. <div>Disables the draggable if set to <code>true</code>.</div>
  491. <strong>Code examples:</strong><p>Initialize the draggable with the <code>disabled</code> option specified:</p>
  492. <div class="syntaxhighlighter javascript nogutter">
  493. <table>
  494. <tbody>
  495. <tr>
  496. <td class="gutter">
  497. <div class="line n1">1</div>
  498. </td>
  499. <td class="code">
  500. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable({ disabled: <span class="literal">true</span> });</code></div></div></pre>
  501. </td>
  502. </tr>
  503. </tbody>
  504. </table>
  505. </div>
  506. <p>Get or set the <code>disabled</code> option, after initialization:</p>
  507. <div class="syntaxhighlighter javascript nogutter">
  508. <table>
  509. <tbody>
  510. <tr>
  511. <td class="gutter">
  512. <div class="line n1">1</div>
  513. <div class="line n2">2</div>
  514. <div class="line n3">3</div>
  515. <div class="line n4">4</div>
  516. <div class="line n5">5</div>
  517. </td>
  518. <td class="code">
  519. <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> disabled = $( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"disabled"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"disabled"</span>, <span class="literal">true</span> );</code></div></div></pre>
  520. </td>
  521. </tr>
  522. </tbody>
  523. </table>
  524. </div>
  525. </div>
  526. <div id="option-distance" class="api-item">
  527. <h3>distance<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Number">Number</a></span>
  528. </h3>
  529. <div class="default">
  530. <strong>Default: </strong><code>1</code>
  531. </div>
  532. <div>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.</div>
  533. <strong>Code examples:</strong><p>Initialize the draggable with the <code>distance</code> option specified:</p>
  534. <div class="syntaxhighlighter javascript nogutter">
  535. <table>
  536. <tbody>
  537. <tr>
  538. <td class="gutter">
  539. <div class="line n1">1</div>
  540. </td>
  541. <td class="code">
  542. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable({ distance: <span class="number">10</span> });</code></div></div></pre>
  543. </td>
  544. </tr>
  545. </tbody>
  546. </table>
  547. </div>
  548. <p>Get or set the <code>distance</code> option, after initialization:</p>
  549. <div class="syntaxhighlighter javascript nogutter">
  550. <table>
  551. <tbody>
  552. <tr>
  553. <td class="gutter">
  554. <div class="line n1">1</div>
  555. <div class="line n2">2</div>
  556. <div class="line n3">3</div>
  557. <div class="line n4">4</div>
  558. <div class="line n5">5</div>
  559. </td>
  560. <td class="code">
  561. <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> distance = $( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"distance"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"distance"</span>, <span class="number">10</span> );</code></div></div></pre>
  562. </td>
  563. </tr>
  564. </tbody>
  565. </table>
  566. </div>
  567. </div>
  568. <div id="option-grid" class="api-item">
  569. <h3>grid<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Array">Array</a></span>
  570. </h3>
  571. <div class="default">
  572. <strong>Default: </strong><code>false</code>
  573. </div>
  574. <div>Snaps the dragging helper to a grid, every x and y pixels. The array must be of the form <code>[ x, y ]</code>.</div>
  575. <strong>Code examples:</strong><p>Initialize the draggable with the <code>grid</code> option specified:</p>
  576. <div class="syntaxhighlighter javascript nogutter">
  577. <table>
  578. <tbody>
  579. <tr>
  580. <td class="gutter">
  581. <div class="line n1">1</div>
  582. </td>
  583. <td class="code">
  584. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable({ grid: [ <span class="number">50</span>, <span class="number">20</span> ] });</code></div></div></pre>
  585. </td>
  586. </tr>
  587. </tbody>
  588. </table>
  589. </div>
  590. <p>Get or set the <code>grid</code> option, after initialization:</p>
  591. <div class="syntaxhighlighter javascript nogutter">
  592. <table>
  593. <tbody>
  594. <tr>
  595. <td class="gutter">
  596. <div class="line n1">1</div>
  597. <div class="line n2">2</div>
  598. <div class="line n3">3</div>
  599. <div class="line n4">4</div>
  600. <div class="line n5">5</div>
  601. </td>
  602. <td class="code">
  603. <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> grid = $( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"grid"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"grid"</span>, [ <span class="number">50</span>, <span class="number">20</span> ] );</code></div></div></pre>
  604. </td>
  605. </tr>
  606. </tbody>
  607. </table>
  608. </div>
  609. </div>
  610. <div id="option-handle" class="api-item">
  611. <h3>handle<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Selector">Selector</a> or <a href="http://api.jquery.com/Types/#Element">Element</a></span>
  612. </h3>
  613. <div class="default">
  614. <strong>Default: </strong><code>false</code>
  615. </div>
  616. <div>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.</div>
  617. <strong>Code examples:</strong><p>Initialize the draggable with the <code>handle</code> option specified:</p>
  618. <div class="syntaxhighlighter javascript nogutter">
  619. <table>
  620. <tbody>
  621. <tr>
  622. <td class="gutter">
  623. <div class="line n1">1</div>
  624. </td>
  625. <td class="code">
  626. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable({ handle: <span class="string">"h2"</span> });</code></div></div></pre>
  627. </td>
  628. </tr>
  629. </tbody>
  630. </table>
  631. </div>
  632. <p>Get or set the <code>handle</code> option, after initialization:</p>
  633. <div class="syntaxhighlighter javascript nogutter">
  634. <table>
  635. <tbody>
  636. <tr>
  637. <td class="gutter">
  638. <div class="line n1">1</div>
  639. <div class="line n2">2</div>
  640. <div class="line n3">3</div>
  641. <div class="line n4">4</div>
  642. <div class="line n5">5</div>
  643. </td>
  644. <td class="code">
  645. <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> handle = $( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"handle"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"handle"</span>, <span class="string">"h2"</span> );</code></div></div></pre>
  646. </td>
  647. </tr>
  648. </tbody>
  649. </table>
  650. </div>
  651. </div>
  652. <div id="option-helper" class="api-item">
  653. <h3>helper<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#String">String</a> or <a href="http://api.jquery.com/Types/#Function">Function</a>()</span>
  654. </h3>
  655. <div class="default">
  656. <strong>Default: </strong><code>"original"</code>
  657. </div>
  658. <div>Allows for a helper element to be used for dragging display.</div>
  659. <strong>Multiple types supported:</strong><ul>
  660. <li>
  661. <strong>String</strong>: If set to <code>"clone"</code>, then the element will be cloned and the clone will be dragged.</li>
  662. <li>
  663. <strong>Function</strong>: A function that will return a DOMElement to use while dragging.</li>
  664. </ul>
  665. <strong>Code examples:</strong><p>Initialize the draggable with the <code>helper</code> option specified:</p>
  666. <div class="syntaxhighlighter javascript nogutter">
  667. <table>
  668. <tbody>
  669. <tr>
  670. <td class="gutter">
  671. <div class="line n1">1</div>
  672. </td>
  673. <td class="code">
  674. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable({ helper: <span class="string">"clone"</span> });</code></div></div></pre>
  675. </td>
  676. </tr>
  677. </tbody>
  678. </table>
  679. </div>
  680. <p>Get or set the <code>helper</code> option, after initialization:</p>
  681. <div class="syntaxhighlighter javascript nogutter">
  682. <table>
  683. <tbody>
  684. <tr>
  685. <td class="gutter">
  686. <div class="line n1">1</div>
  687. <div class="line n2">2</div>
  688. <div class="line n3">3</div>
  689. <div class="line n4">4</div>
  690. <div class="line n5">5</div>
  691. </td>
  692. <td class="code">
  693. <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> helper = $( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"helper"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"helper"</span>, <span class="string">"clone"</span> );</code></div></div></pre>
  694. </td>
  695. </tr>
  696. </tbody>
  697. </table>
  698. </div>
  699. </div>
  700. <div id="option-iframeFix" class="api-item">
  701. <h3>iframeFix<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Boolean">Boolean</a> or <a href="http://api.jquery.com/Types/#Selector">Selector</a></span>
  702. </h3>
  703. <div class="default">
  704. <strong>Default: </strong><code>false</code>
  705. </div>
  706. <div>Prevent iframes from capturing the mousemove events during a drag. Useful in combination with the <a href="#option-cursorAt"><code>cursorAt</code></a> option, or in any case where the mouse cursor may not be over the helper.</div>
  707. <strong>Multiple types supported:</strong><ul>
  708. <li>
  709. <strong>Boolean</strong>: When set to <code>true</code>, transparent overlays will be placed over all iframes on the page.</li>
  710. <li>
  711. <strong>Selector</strong>: Any iframes matching the selector will be covered by transparent overlays.</li>
  712. </ul>
  713. <strong>Code examples:</strong><p>Initialize the draggable with the <code>iframeFix</code> option specified:</p>
  714. <div class="syntaxhighlighter javascript nogutter">
  715. <table>
  716. <tbody>
  717. <tr>
  718. <td class="gutter">
  719. <div class="line n1">1</div>
  720. </td>
  721. <td class="code">
  722. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable({ iframeFix: <span class="literal">true</span> });</code></div></div></pre>
  723. </td>
  724. </tr>
  725. </tbody>
  726. </table>
  727. </div>
  728. <p>Get or set the <code>iframeFix</code> option, after initialization:</p>
  729. <div class="syntaxhighlighter javascript nogutter">
  730. <table>
  731. <tbody>
  732. <tr>
  733. <td class="gutter">
  734. <div class="line n1">1</div>
  735. <div class="line n2">2</div>
  736. <div class="line n3">3</div>
  737. <div class="line n4">4</div>
  738. <div class="line n5">5</div>
  739. </td>
  740. <td class="code">
  741. <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> iframeFix = $( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"iframeFix"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"iframeFix"</span>, <span class="literal">true</span> );</code></div></div></pre>
  742. </td>
  743. </tr>
  744. </tbody>
  745. </table>
  746. </div>
  747. </div>
  748. <div id="option-opacity" class="api-item">
  749. <h3>opacity<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Number">Number</a></span>
  750. </h3>
  751. <div class="default">
  752. <strong>Default: </strong><code>false</code>
  753. </div>
  754. <div>Opacity for the helper while being dragged.</div>
  755. <strong>Code examples:</strong><p>Initialize the draggable with the <code>opacity</code> option specified:</p>
  756. <div class="syntaxhighlighter javascript nogutter">
  757. <table>
  758. <tbody>
  759. <tr>
  760. <td class="gutter">
  761. <div class="line n1">1</div>
  762. </td>
  763. <td class="code">
  764. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable({ opacity: <span class="number">0.35</span> });</code></div></div></pre>
  765. </td>
  766. </tr>
  767. </tbody>
  768. </table>
  769. </div>
  770. <p>Get or set the <code>opacity</code> option, after initialization:</p>
  771. <div class="syntaxhighlighter javascript nogutter">
  772. <table>
  773. <tbody>
  774. <tr>
  775. <td class="gutter">
  776. <div class="line n1">1</div>
  777. <div class="line n2">2</div>
  778. <div class="line n3">3</div>
  779. <div class="line n4">4</div>
  780. <div class="line n5">5</div>
  781. </td>
  782. <td class="code">
  783. <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> opacity = $( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"opacity"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"opacity"</span>, <span class="number">0.35</span> );</code></div></div></pre>
  784. </td>
  785. </tr>
  786. </tbody>
  787. </table>
  788. </div>
  789. </div>
  790. <div id="option-refreshPositions" class="api-item">
  791. <h3>refreshPositions<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Boolean">Boolean</a></span>
  792. </h3>
  793. <div class="default">
  794. <strong>Default: </strong><code>false</code>
  795. </div>
  796. <div>
  797. If set to <code>true</code>, all droppable positions are calculated on every mousemove.
  798. <em>Caution: This solves issues on highly dynamic pages, but dramatically decreases performance.</em>
  799. </div>
  800. <strong>Code examples:</strong><p>Initialize the draggable with the <code>refreshPositions</code> option specified:</p>
  801. <div class="syntaxhighlighter javascript nogutter">
  802. <table>
  803. <tbody>
  804. <tr>
  805. <td class="gutter">
  806. <div class="line n1">1</div>
  807. </td>
  808. <td class="code">
  809. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable({ refreshPositions: <span class="literal">true</span> });</code></div></div></pre>
  810. </td>
  811. </tr>
  812. </tbody>
  813. </table>
  814. </div>
  815. <p>Get or set the <code>refreshPositions</code> option, after initialization:</p>
  816. <div class="syntaxhighlighter javascript nogutter">
  817. <table>
  818. <tbody>
  819. <tr>
  820. <td class="gutter">
  821. <div class="line n1">1</div>
  822. <div class="line n2">2</div>
  823. <div class="line n3">3</div>
  824. <div class="line n4">4</div>
  825. <div class="line n5">5</div>
  826. </td>
  827. <td class="code">
  828. <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> refreshPositions = $( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"refreshPositions"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"refreshPositions"</span>, <span class="literal">true</span> );</code></div></div></pre>
  829. </td>
  830. </tr>
  831. </tbody>
  832. </table>
  833. </div>
  834. </div>
  835. <div id="option-revert" class="api-item">
  836. <h3>revert<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Boolean">Boolean</a> or <a href="http://api.jquery.com/Types/#String">String</a> or <a href="http://api.jquery.com/Types/#Function">Function</a>()</span>
  837. </h3>
  838. <div class="default">
  839. <strong>Default: </strong><code>false</code>
  840. </div>
  841. <div>Whether the element should revert to its start position when dragging stops.</div>
  842. <strong>Multiple types supported:</strong><ul>
  843. <li>
  844. <strong>Boolean</strong>: If set to <code>true</code> the element will always revert.</li>
  845. <li>
  846. <strong>String</strong>: If set to <code>"invalid"</code>, revert will only occur if the draggable has not been dropped on a droppable. For <code>"valid"</code>, it's the other way around.</li>
  847. <li>
  848. <strong>Function</strong>: A function to determine whether the element should revert to its start position. The function must return <code>true</code> to revert the element.</li>
  849. </ul>
  850. <strong>Code examples:</strong><p>Initialize the draggable with the <code>revert</code> option specified:</p>
  851. <div class="syntaxhighlighter javascript nogutter">
  852. <table>
  853. <tbody>
  854. <tr>
  855. <td class="gutter">
  856. <div class="line n1">1</div>
  857. </td>
  858. <td class="code">
  859. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable({ revert: <span class="literal">true</span> });</code></div></div></pre>
  860. </td>
  861. </tr>
  862. </tbody>
  863. </table>
  864. </div>
  865. <p>Get or set the <code>revert</code> option, after initialization:</p>
  866. <div class="syntaxhighlighter javascript nogutter">
  867. <table>
  868. <tbody>
  869. <tr>
  870. <td class="gutter">
  871. <div class="line n1">1</div>
  872. <div class="line n2">2</div>
  873. <div class="line n3">3</div>
  874. <div class="line n4">4</div>
  875. <div class="line n5">5</div>
  876. </td>
  877. <td class="code">
  878. <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> revert = $( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"revert"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"revert"</span>, <span class="literal">true</span> );</code></div></div></pre>
  879. </td>
  880. </tr>
  881. </tbody>
  882. </table>
  883. </div>
  884. </div>
  885. <div id="option-revertDuration" class="api-item">
  886. <h3>revertDuration<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Number">Number</a></span>
  887. </h3>
  888. <div class="default">
  889. <strong>Default: </strong><code>500</code>
  890. </div>
  891. <div>The duration of the revert animation, in milliseconds. Ignored if the <a href="#option-revert"><code>revert</code></a> option is <code>false</code>.</div>
  892. <strong>Code examples:</strong><p>Initialize the draggable with the <code>revertDuration</code> option specified:</p>
  893. <div class="syntaxhighlighter javascript nogutter">
  894. <table>
  895. <tbody>
  896. <tr>
  897. <td class="gutter">
  898. <div class="line n1">1</div>
  899. </td>
  900. <td class="code">
  901. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable({ revertDuration: <span class="number">200</span> });</code></div></div></pre>
  902. </td>
  903. </tr>
  904. </tbody>
  905. </table>
  906. </div>
  907. <p>Get or set the <code>revertDuration</code> option, after initialization:</p>
  908. <div class="syntaxhighlighter javascript nogutter">
  909. <table>
  910. <tbody>
  911. <tr>
  912. <td class="gutter">
  913. <div class="line n1">1</div>
  914. <div class="line n2">2</div>
  915. <div class="line n3">3</div>
  916. <div class="line n4">4</div>
  917. <div class="line n5">5</div>
  918. </td>
  919. <td class="code">
  920. <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> revertDuration = $( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"revertDuration"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"revertDuration"</span>, <span class="number">200</span> );</code></div></div></pre>
  921. </td>
  922. </tr>
  923. </tbody>
  924. </table>
  925. </div>
  926. </div>
  927. <div id="option-scope" class="api-item">
  928. <h3>scope<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#String">String</a></span>
  929. </h3>
  930. <div class="default">
  931. <strong>Default: </strong><code>"default"</code>
  932. </div>
  933. <div>Used to group sets of draggable and droppable items, in addition to droppable's <a href="/droppable#option-accept"><code>accept</code></a> option. A draggable with the same <code>scope</code> value as a droppable will be accepted by the droppable.</div>
  934. <strong>Code examples:</strong><p>Initialize the draggable with the <code>scope</code> option specified:</p>
  935. <div class="syntaxhighlighter javascript nogutter">
  936. <table>
  937. <tbody>
  938. <tr>
  939. <td class="gutter">
  940. <div class="line n1">1</div>
  941. </td>
  942. <td class="code">
  943. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable({ scope: <span class="string">"tasks"</span> });</code></div></div></pre>
  944. </td>
  945. </tr>
  946. </tbody>
  947. </table>
  948. </div>
  949. <p>Get or set the <code>scope</code> option, after initialization:</p>
  950. <div class="syntaxhighlighter javascript nogutter">
  951. <table>
  952. <tbody>
  953. <tr>
  954. <td class="gutter">
  955. <div class="line n1">1</div>
  956. <div class="line n2">2</div>
  957. <div class="line n3">3</div>
  958. <div class="line n4">4</div>
  959. <div class="line n5">5</div>
  960. </td>
  961. <td class="code">
  962. <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> scope = $( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"scope"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"scope"</span>, <span class="string">"tasks"</span> );</code></div></div></pre>
  963. </td>
  964. </tr>
  965. </tbody>
  966. </table>
  967. </div>
  968. </div>
  969. <div id="option-scroll" class="api-item">
  970. <h3>scroll<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Boolean">Boolean</a></span>
  971. </h3>
  972. <div class="default">
  973. <strong>Default: </strong><code>true</code>
  974. </div>
  975. <div>If set to <code>true</code>, container auto-scrolls while dragging.</div>
  976. <strong>Code examples:</strong><p>Initialize the draggable with the <code>scroll</code> option specified:</p>
  977. <div class="syntaxhighlighter javascript nogutter">
  978. <table>
  979. <tbody>
  980. <tr>
  981. <td class="gutter">
  982. <div class="line n1">1</div>
  983. </td>
  984. <td class="code">
  985. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable({ scroll: <span class="literal">false</span> });</code></div></div></pre>
  986. </td>
  987. </tr>
  988. </tbody>
  989. </table>
  990. </div>
  991. <p>Get or set the <code>scroll</code> option, after initialization:</p>
  992. <div class="syntaxhighlighter javascript nogutter">
  993. <table>
  994. <tbody>
  995. <tr>
  996. <td class="gutter">
  997. <div class="line n1">1</div>
  998. <div class="line n2">2</div>
  999. <div class="line n3">3</div>
  1000. <div class="line n4">4</div>
  1001. <div class="line n5">5</div>
  1002. </td>
  1003. <td class="code">
  1004. <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> scroll = $( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"scroll"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"scroll"</span>, <span class="literal">false</span> );</code></div></div></pre>
  1005. </td>
  1006. </tr>
  1007. </tbody>
  1008. </table>
  1009. </div>
  1010. </div>
  1011. <div id="option-scrollSensitivity" class="api-item">
  1012. <h3>scrollSensitivity<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Number">Number</a></span>
  1013. </h3>
  1014. <div class="default">
  1015. <strong>Default: </strong><code>20</code>
  1016. </div>
  1017. <div>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 <a href="#option-scroll"><code>scroll</code></a> option is <code>false</code>.</div>
  1018. <strong>Code examples:</strong><p>Initialize the draggable with the <code>scrollSensitivity</code> option specified:</p>
  1019. <div class="syntaxhighlighter javascript nogutter">
  1020. <table>
  1021. <tbody>
  1022. <tr>
  1023. <td class="gutter">
  1024. <div class="line n1">1</div>
  1025. </td>
  1026. <td class="code">
  1027. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable({ scrollSensitivity: <span class="number">100</span> });</code></div></div></pre>
  1028. </td>
  1029. </tr>
  1030. </tbody>
  1031. </table>
  1032. </div>
  1033. <p>Get or set the <code>scrollSensitivity</code> option, after initialization:</p>
  1034. <div class="syntaxhighlighter javascript nogutter">
  1035. <table>
  1036. <tbody>
  1037. <tr>
  1038. <td class="gutter">
  1039. <div class="line n1">1</div>
  1040. <div class="line n2">2</div>
  1041. <div class="line n3">3</div>
  1042. <div class="line n4">4</div>
  1043. <div class="line n5">5</div>
  1044. </td>
  1045. <td class="code">
  1046. <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> scrollSensitivity = $( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"scrollSensitivity"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"scrollSensitivity"</span>, <span class="number">100</span> );</code></div></div></pre>
  1047. </td>
  1048. </tr>
  1049. </tbody>
  1050. </table>
  1051. </div>
  1052. </div>
  1053. <div id="option-scrollSpeed" class="api-item">
  1054. <h3>scrollSpeed<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Number">Number</a></span>
  1055. </h3>
  1056. <div class="default">
  1057. <strong>Default: </strong><code>20</code>
  1058. </div>
  1059. <div>The speed at which the window should scroll once the mouse pointer gets within the <a href="#option-scrollSensitivity"><code>scrollSensitivity</code></a> distance. Ignored if the <a href="#option-scroll"><code>scroll</code></a> option is <code>false</code>.</div>
  1060. <strong>Code examples:</strong><p>Initialize the draggable with the <code>scrollSpeed</code> option specified:</p>
  1061. <div class="syntaxhighlighter javascript nogutter">
  1062. <table>
  1063. <tbody>
  1064. <tr>
  1065. <td class="gutter">
  1066. <div class="line n1">1</div>
  1067. </td>
  1068. <td class="code">
  1069. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable({ scrollSpeed: <span class="number">100</span> });</code></div></div></pre>
  1070. </td>
  1071. </tr>
  1072. </tbody>
  1073. </table>
  1074. </div>
  1075. <p>Get or set the <code>scrollSpeed</code> option, after initialization:</p>
  1076. <div class="syntaxhighlighter javascript nogutter">
  1077. <table>
  1078. <tbody>
  1079. <tr>
  1080. <td class="gutter">
  1081. <div class="line n1">1</div>
  1082. <div class="line n2">2</div>
  1083. <div class="line n3">3</div>
  1084. <div class="line n4">4</div>
  1085. <div class="line n5">5</div>
  1086. </td>
  1087. <td class="code">
  1088. <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> scrollSpeed = $( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"scrollSpeed"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"scrollSpeed"</span>, <span class="number">100</span> );</code></div></div></pre>
  1089. </td>
  1090. </tr>
  1091. </tbody>
  1092. </table>
  1093. </div>
  1094. </div>
  1095. <div id="option-snap" class="api-item">
  1096. <h3>snap<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Boolean">Boolean</a> or <a href="http://api.jquery.com/Types/#Selector">Selector</a></span>
  1097. </h3>
  1098. <div class="default">
  1099. <strong>Default: </strong><code>false</code>
  1100. </div>
  1101. <div>Whether the element should snap to other elements.</div>
  1102. <strong>Multiple types supported:</strong><ul>
  1103. <li>
  1104. <strong>Boolean</strong>: When set to <code>true</code>, the element will snap to all other draggable elements.</li>
  1105. <li>
  1106. <strong>Selector</strong>: A selector specifying which elements to snap to.</li>
  1107. </ul>
  1108. <strong>Code examples:</strong><p>Initialize the draggable with the <code>snap</code> option specified:</p>
  1109. <div class="syntaxhighlighter javascript nogutter">
  1110. <table>
  1111. <tbody>
  1112. <tr>
  1113. <td class="gutter">
  1114. <div class="line n1">1</div>
  1115. </td>
  1116. <td class="code">
  1117. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable({ snap: <span class="literal">true</span> });</code></div></div></pre>
  1118. </td>
  1119. </tr>
  1120. </tbody>
  1121. </table>
  1122. </div>
  1123. <p>Get or set the <code>snap</code> option, after initialization:</p>
  1124. <div class="syntaxhighlighter javascript nogutter">
  1125. <table>
  1126. <tbody>
  1127. <tr>
  1128. <td class="gutter">
  1129. <div class="line n1">1</div>
  1130. <div class="line n2">2</div>
  1131. <div class="line n3">3</div>
  1132. <div class="line n4">4</div>
  1133. <div class="line n5">5</div>
  1134. </td>
  1135. <td class="code">
  1136. <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> snap = $( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"snap"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"snap"</span>, <span class="literal">true</span> );</code></div></div></pre>
  1137. </td>
  1138. </tr>
  1139. </tbody>
  1140. </table>
  1141. </div>
  1142. </div>
  1143. <div id="option-snapMode" class="api-item">
  1144. <h3>snapMode<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#String">String</a></span>
  1145. </h3>
  1146. <div class="default">
  1147. <strong>Default: </strong><code>"both"</code>
  1148. </div>
  1149. <div>Determines which edges of snap elements the draggable will snap to. Ignored if the <a href="#option-snap"><code>snap</code></a> option is <code>false</code>. Possible values: <code>"inner"</code>, <code>"outer"</code>, <code>"both"</code>.</div>
  1150. <strong>Code examples:</strong><p>Initialize the draggable with the <code>snapMode</code> option specified:</p>
  1151. <div class="syntaxhighlighter javascript nogutter">
  1152. <table>
  1153. <tbody>
  1154. <tr>
  1155. <td class="gutter">
  1156. <div class="line n1">1</div>
  1157. </td>
  1158. <td class="code">
  1159. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable({ snapMode: <span class="string">"inner"</span> });</code></div></div></pre>
  1160. </td>
  1161. </tr>
  1162. </tbody>
  1163. </table>
  1164. </div>
  1165. <p>Get or set the <code>snapMode</code> option, after initialization:</p>
  1166. <div class="syntaxhighlighter javascript nogutter">
  1167. <table>
  1168. <tbody>
  1169. <tr>
  1170. <td class="gutter">
  1171. <div class="line n1">1</div>
  1172. <div class="line n2">2</div>
  1173. <div class="line n3">3</div>
  1174. <div class="line n4">4</div>
  1175. <div class="line n5">5</div>
  1176. </td>
  1177. <td class="code">
  1178. <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> snapMode = $( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"snapMode"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"snapMode"</span>, <span class="string">"inner"</span> );</code></div></div></pre>
  1179. </td>
  1180. </tr>
  1181. </tbody>
  1182. </table>
  1183. </div>
  1184. </div>
  1185. <div id="option-snapTolerance" class="api-item">
  1186. <h3>snapTolerance<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Number">Number</a></span>
  1187. </h3>
  1188. <div class="default">
  1189. <strong>Default: </strong><code>20</code>
  1190. </div>
  1191. <div>The distance in pixels from the snap element edges at which snapping should occur. Ignored if the <a href="#option-snap"><code>snap</code></a> option is <code>false</code>.</div>
  1192. <strong>Code examples:</strong><p>Initialize the draggable with the <code>snapTolerance</code> option specified:</p>
  1193. <div class="syntaxhighlighter javascript nogutter">
  1194. <table>
  1195. <tbody>
  1196. <tr>
  1197. <td class="gutter">
  1198. <div class="line n1">1</div>
  1199. </td>
  1200. <td class="code">
  1201. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable({ snapTolerance: <span class="number">30</span> });</code></div></div></pre>
  1202. </td>
  1203. </tr>
  1204. </tbody>
  1205. </table>
  1206. </div>
  1207. <p>Get or set the <code>snapTolerance</code> option, after initialization:</p>
  1208. <div class="syntaxhighlighter javascript nogutter">
  1209. <table>
  1210. <tbody>
  1211. <tr>
  1212. <td class="gutter">
  1213. <div class="line n1">1</div>
  1214. <div class="line n2">2</div>
  1215. <div class="line n3">3</div>
  1216. <div class="line n4">4</div>
  1217. <div class="line n5">5</div>
  1218. </td>
  1219. <td class="code">
  1220. <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> snapTolerance = $( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"snapTolerance"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"snapTolerance"</span>, <span class="number">30</span> );</code></div></div></pre>
  1221. </td>
  1222. </tr>
  1223. </tbody>
  1224. </table>
  1225. </div>
  1226. </div>
  1227. <div id="option-stack" class="api-item">
  1228. <h3>stack<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Selector">Selector</a></span>
  1229. </h3>
  1230. <div class="default">
  1231. <strong>Default: </strong><code>false</code>
  1232. </div>
  1233. <div>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.</div>
  1234. <strong>Code examples:</strong><p>Initialize the draggable with the <code>stack</code> option specified:</p>
  1235. <div class="syntaxhighlighter javascript nogutter">
  1236. <table>
  1237. <tbody>
  1238. <tr>
  1239. <td class="gutter">
  1240. <div class="line n1">1</div>
  1241. </td>
  1242. <td class="code">
  1243. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable({ stack: <span class="string">".products"</span> });</code></div></div></pre>
  1244. </td>
  1245. </tr>
  1246. </tbody>
  1247. </table>
  1248. </div>
  1249. <p>Get or set the <code>stack</code> option, after initialization:</p>
  1250. <div class="syntaxhighlighter javascript nogutter">
  1251. <table>
  1252. <tbody>
  1253. <tr>
  1254. <td class="gutter">
  1255. <div class="line n1">1</div>
  1256. <div class="line n2">2</div>
  1257. <div class="line n3">3</div>
  1258. <div class="line n4">4</div>
  1259. <div class="line n5">5</div>
  1260. </td>
  1261. <td class="code">
  1262. <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> stack = $( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"stack"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"stack"</span>, <span class="string">".products"</span> );</code></div></div></pre>
  1263. </td>
  1264. </tr>
  1265. </tbody>
  1266. </table>
  1267. </div>
  1268. </div>
  1269. <div id="option-zIndex" class="api-item">
  1270. <h3>zIndex<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Number">Number</a></span>
  1271. </h3>
  1272. <div class="default">
  1273. <strong>Default: </strong><code>false</code>
  1274. </div>
  1275. <div>Z-index for the helper while being dragged.</div>
  1276. <strong>Code examples:</strong><p>Initialize the draggable with the <code>zIndex</code> option specified:</p>
  1277. <div class="syntaxhighlighter javascript nogutter">
  1278. <table>
  1279. <tbody>
  1280. <tr>
  1281. <td class="gutter">
  1282. <div class="line n1">1</div>
  1283. </td>
  1284. <td class="code">
  1285. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable({ zIndex: <span class="number">100</span> });</code></div></div></pre>
  1286. </td>
  1287. </tr>
  1288. </tbody>
  1289. </table>
  1290. </div>
  1291. <p>Get or set the <code>zIndex</code> option, after initialization:</p>
  1292. <div class="syntaxhighlighter javascript nogutter">
  1293. <table>
  1294. <tbody>
  1295. <tr>
  1296. <td class="gutter">
  1297. <div class="line n1">1</div>
  1298. <div class="line n2">2</div>
  1299. <div class="line n3">3</div>
  1300. <div class="line n4">4</div>
  1301. <div class="line n5">5</div>
  1302. </td>
  1303. <td class="code">
  1304. <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> zIndex = $( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"zIndex"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"zIndex"</span>, <span class="number">100</span> );</code></div></div></pre>
  1305. </td>
  1306. </tr>
  1307. </tbody>
  1308. </table>
  1309. </div>
  1310. </div></section><section id="methods"><header><h2>Methods</h2></header><div id="method-destroy"><div class="api-item first-item">
  1311. <h3>destroy()<span class="returns">Returns: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a> (<a href="http://learn.jquery.com/jquery-ui/widget-factory/widget-method-invocation/">plugin only</a>)</span>
  1312. </h3>
  1313. <div>
  1314. Removes the draggable functionality completely. This will return the element back to its pre-init state.
  1315. </div>
  1316. <ul><li><div class="null-signature">This method does not accept any arguments.</div></li></ul>
  1317. <div>
  1318. <strong>Code examples:</strong><p>Invoke the destroy method:</p>
  1319. <div class="syntaxhighlighter javascript nogutter">
  1320. <table>
  1321. <tbody>
  1322. <tr>
  1323. <td class="gutter">
  1324. <div class="line n1">1</div>
  1325. </td>
  1326. <td class="code">
  1327. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable( <span class="string">"destroy"</span> );</code></div></div></pre>
  1328. </td>
  1329. </tr>
  1330. </tbody>
  1331. </table>
  1332. </div>
  1333. </div>
  1334. </div></div>
  1335. <div id="method-disable"><div class="api-item">
  1336. <h3>disable()<span class="returns">Returns: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a> (<a href="http://learn.jquery.com/jquery-ui/widget-factory/widget-method-invocation/">plugin only</a>)</span>
  1337. </h3>
  1338. <div>
  1339. Disables the draggable.
  1340. </div>
  1341. <ul><li><div class="null-signature">This method does not accept any arguments.</div></li></ul>
  1342. <div>
  1343. <strong>Code examples:</strong><p>Invoke the disable method:</p>
  1344. <div class="syntaxhighlighter javascript nogutter">
  1345. <table>
  1346. <tbody>
  1347. <tr>
  1348. <td class="gutter">
  1349. <div class="line n1">1</div>
  1350. </td>
  1351. <td class="code">
  1352. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable( <span class="string">"disable"</span> );</code></div></div></pre>
  1353. </td>
  1354. </tr>
  1355. </tbody>
  1356. </table>
  1357. </div>
  1358. </div>
  1359. </div></div>
  1360. <div id="method-enable"><div class="api-item">
  1361. <h3>enable()<span class="returns">Returns: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a> (<a href="http://learn.jquery.com/jquery-ui/widget-factory/widget-method-invocation/">plugin only</a>)</span>
  1362. </h3>
  1363. <div>
  1364. Enables the draggable.
  1365. </div>
  1366. <ul><li><div class="null-signature">This method does not accept any arguments.</div></li></ul>
  1367. <div>
  1368. <strong>Code examples:</strong><p>Invoke the enable method:</p>
  1369. <div class="syntaxhighlighter javascript nogutter">
  1370. <table>
  1371. <tbody>
  1372. <tr>
  1373. <td class="gutter">
  1374. <div class="line n1">1</div>
  1375. </td>
  1376. <td class="code">
  1377. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable( <span class="string">"enable"</span> );</code></div></div></pre>
  1378. </td>
  1379. </tr>
  1380. </tbody>
  1381. </table>
  1382. </div>
  1383. </div>
  1384. </div></div>
  1385. <div id="method-option">
  1386. <div class="api-item">
  1387. <h3>option( optionName )<span class="returns">Returns: <a href="http://api.jquery.com/Types/#Object">Object</a></span>
  1388. </h3>
  1389. <div>Gets the value currently associated with the specified <code>optionName</code>.</div>
  1390. <ul><li>
  1391. <div><strong>optionName</strong></div>
  1392. <div>Type: <a href="http://api.jquery.com/Types/#String">String</a>
  1393. </div>
  1394. <div>The name of the option to get.</div>
  1395. </li></ul>
  1396. <div>
  1397. <strong>Code examples:</strong><p>Invoke the method:</p>
  1398. <div class="syntaxhighlighter javascript nogutter">
  1399. <table>
  1400. <tbody>
  1401. <tr>
  1402. <td class="gutter">
  1403. <div class="line n1">1</div>
  1404. </td>
  1405. <td class="code">
  1406. <pre><div class="container"><div class="line"><code><span class="keyword">var</span> isDisabled = $( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"disabled"</span> );</code></div></div></pre>
  1407. </td>
  1408. </tr>
  1409. </tbody>
  1410. </table>
  1411. </div>
  1412. </div>
  1413. </div>
  1414. <div class="api-item">
  1415. <h3>option()<span class="returns">Returns: <a href="http://api.jquery.com/Types/#PlainObject">PlainObject</a></span>
  1416. </h3>
  1417. <div>Gets an object containing key/value pairs representing the current draggable options hash.</div>
  1418. <ul><li><div class="null-signature">This signature does not accept any arguments.</div></li></ul>
  1419. <div>
  1420. <strong>Code examples:</strong><p>Invoke the method:</p>
  1421. <div class="syntaxhighlighter javascript nogutter">
  1422. <table>
  1423. <tbody>
  1424. <tr>
  1425. <td class="gutter">
  1426. <div class="line n1">1</div>
  1427. </td>
  1428. <td class="code">
  1429. <pre><div class="container"><div class="line"><code><span class="keyword">var</span> options = $( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span> );</code></div></div></pre>
  1430. </td>
  1431. </tr>
  1432. </tbody>
  1433. </table>
  1434. </div>
  1435. </div>
  1436. </div>
  1437. <div class="api-item">
  1438. <h3>option( optionName, value )<span class="returns">Returns: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a> (<a href="http://learn.jquery.com/jquery-ui/widget-factory/widget-method-invocation/">plugin only</a>)</span>
  1439. </h3>
  1440. <div>Sets the value of the draggable option associated with the specified <code>optionName</code>.</div>
  1441. <ul>
  1442. <li>
  1443. <div><strong>optionName</strong></div>
  1444. <div>Type: <a href="http://api.jquery.com/Types/#String">String</a>
  1445. </div>
  1446. <div>The name of the option to set.</div>
  1447. </li>
  1448. <li>
  1449. <div><strong>value</strong></div>
  1450. <div>Type: <a href="http://api.jquery.com/Types/#Object">Object</a>
  1451. </div>
  1452. <div>A value to set for the option.</div>
  1453. </li>
  1454. </ul>
  1455. <div>
  1456. <strong>Code examples:</strong><p>Invoke the method:</p>
  1457. <div class="syntaxhighlighter javascript nogutter">
  1458. <table>
  1459. <tbody>
  1460. <tr>
  1461. <td class="gutter">
  1462. <div class="line n1">1</div>
  1463. </td>
  1464. <td class="code">
  1465. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, <span class="string">"disabled"</span>, <span class="literal">true</span> );</code></div></div></pre>
  1466. </td>
  1467. </tr>
  1468. </tbody>
  1469. </table>
  1470. </div>
  1471. </div>
  1472. </div>
  1473. <div class="api-item">
  1474. <h3>option( options )<span class="returns">Returns: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a> (<a href="http://learn.jquery.com/jquery-ui/widget-factory/widget-method-invocation/">plugin only</a>)</span>
  1475. </h3>
  1476. <div>Sets one or more options for the draggable.</div>
  1477. <ul><li>
  1478. <div><strong>options</strong></div>
  1479. <div>Type: <a href="http://api.jquery.com/Types/#Object">Object</a>
  1480. </div>
  1481. <div>A map of option-value pairs to set.</div>
  1482. </li></ul>
  1483. <div>
  1484. <strong>Code examples:</strong><p>Invoke the method:</p>
  1485. <div class="syntaxhighlighter javascript nogutter">
  1486. <table>
  1487. <tbody>
  1488. <tr>
  1489. <td class="gutter">
  1490. <div class="line n1">1</div>
  1491. </td>
  1492. <td class="code">
  1493. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable( <span class="string">"option"</span>, { disabled: <span class="literal">true</span> } );</code></div></div></pre>
  1494. </td>
  1495. </tr>
  1496. </tbody>
  1497. </table>
  1498. </div>
  1499. </div>
  1500. </div>
  1501. </div>
  1502. <div id="method-widget"><div class="api-item">
  1503. <h3>widget()<span class="returns">Returns: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a></span>
  1504. </h3>
  1505. <div>
  1506. Returns a <code>jQuery</code> object containing the draggable element.
  1507. </div>
  1508. <ul><li><div class="null-signature">This method does not accept any arguments.</div></li></ul>
  1509. <div>
  1510. <strong>Code examples:</strong><p>Invoke the widget method:</p>
  1511. <div class="syntaxhighlighter javascript nogutter">
  1512. <table>
  1513. <tbody>
  1514. <tr>
  1515. <td class="gutter">
  1516. <div class="line n1">1</div>
  1517. </td>
  1518. <td class="code">
  1519. <pre><div class="container"><div class="line"><code><span class="keyword">var</span> widget = $( <span class="string">".selector"</span> ).draggable( <span class="string">"widget"</span> );</code></div></div></pre>
  1520. </td>
  1521. </tr>
  1522. </tbody>
  1523. </table>
  1524. </div>
  1525. </div>
  1526. </div></div></section><section id="events"><header><h2>Events</h2></header><div id="event-create" class="api-item first-item">
  1527. <h3>create( event, ui )<span class="returns">Type: <code>dragcreate</code></span>
  1528. </h3>
  1529. <div>
  1530. Triggered when the draggable is created.
  1531. </div>
  1532. <ul>
  1533. <li>
  1534. <div><strong>event</strong></div>
  1535. <div>Type: <a href="http://api.jquery.com/Types/#Event">Event</a>
  1536. </div>
  1537. <div></div>
  1538. </li>
  1539. <li>
  1540. <div><strong>ui</strong></div>
  1541. <div>Type: <a href="http://api.jquery.com/Types/#Object">Object</a>
  1542. </div>
  1543. <div></div>
  1544. </li>
  1545. </ul>
  1546. <p><em>Note: The <code>ui</code> object is empty but included for consistency with other events.</em></p>
  1547. <div>
  1548. <strong>Code examples:</strong><p>Initialize the draggable with the create callback specified:</p>
  1549. <div class="syntaxhighlighter javascript nogutter">
  1550. <table>
  1551. <tbody>
  1552. <tr>
  1553. <td class="gutter">
  1554. <div class="line n1">1</div>
  1555. <div class="line n2">2</div>
  1556. <div class="line n3">3</div>
  1557. </td>
  1558. <td class="code">
  1559. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable({</code></div></div><div class="container"><div class="line"><code> create: <span class="keyword">function</span>( event, ui ) {}</code></div></div><div class="container"><div class="line"><code>});</code></div></div></pre>
  1560. </td>
  1561. </tr>
  1562. </tbody>
  1563. </table>
  1564. </div>
  1565. <p>Bind an event listener to the dragcreate event:</p>
  1566. <div class="syntaxhighlighter javascript nogutter">
  1567. <table>
  1568. <tbody>
  1569. <tr>
  1570. <td class="gutter">
  1571. <div class="line n1">1</div>
  1572. </td>
  1573. <td class="code">
  1574. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).on( <span class="string">"dragcreate"</span>, <span class="keyword">function</span>( event, ui ) {} );</code></div></div></pre>
  1575. </td>
  1576. </tr>
  1577. </tbody>
  1578. </table>
  1579. </div>
  1580. </div>
  1581. </div>
  1582. <div id="event-drag" class="api-item">
  1583. <h3>drag( event, ui )<span class="returns">Type: <code>drag</code></span>
  1584. </h3>
  1585. <div>Triggered while the mouse is moved during the dragging.</div>
  1586. <ul>
  1587. <li>
  1588. <div><strong>event</strong></div>
  1589. <div>Type: <a href="http://api.jquery.com/Types/#Event">Event</a>
  1590. </div>
  1591. <div></div>
  1592. </li>
  1593. <li>
  1594. <div><strong>ui</strong></div>
  1595. <div>Type: <a href="http://api.jquery.com/Types/#Object">Object</a>
  1596. </div>
  1597. <div></div>
  1598. <ul>
  1599. <li>
  1600. <div><strong>helper</strong></div>
  1601. <div>Type: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a>
  1602. </div>
  1603. <div>The jQuery object representing the helper that's being dragged.</div>
  1604. </li>
  1605. <li>
  1606. <div><strong>position</strong></div>
  1607. <div>Type: <a href="http://api.jquery.com/Types/#Object">Object</a>
  1608. </div>
  1609. <div>Current CSS position of the helper as <code>{ top, left }</code> object.</div>
  1610. </li>
  1611. <li>
  1612. <div><strong>offset</strong></div>
  1613. <div>Type: <a href="http://api.jquery.com/Types/#Object">Object</a>
  1614. </div>
  1615. <div>Current offset position of the helper as <code>{ top, left }</code> object.</div>
  1616. </li>
  1617. </ul>
  1618. </li>
  1619. </ul>
  1620. <div>
  1621. <strong>Code examples:</strong><p>Initialize the draggable with the drag callback specified:</p>
  1622. <div class="syntaxhighlighter javascript nogutter">
  1623. <table>
  1624. <tbody>
  1625. <tr>
  1626. <td class="gutter">
  1627. <div class="line n1">1</div>
  1628. <div class="line n2">2</div>
  1629. <div class="line n3">3</div>
  1630. </td>
  1631. <td class="code">
  1632. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable({</code></div></div><div class="container"><div class="line"><code> drag: <span class="keyword">function</span>( event, ui ) {}</code></div></div><div class="container"><div class="line"><code>});</code></div></div></pre>
  1633. </td>
  1634. </tr>
  1635. </tbody>
  1636. </table>
  1637. </div>
  1638. <p>Bind an event listener to the drag event:</p>
  1639. <div class="syntaxhighlighter javascript nogutter">
  1640. <table>
  1641. <tbody>
  1642. <tr>
  1643. <td class="gutter">
  1644. <div class="line n1">1</div>
  1645. </td>
  1646. <td class="code">
  1647. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).on( <span class="string">"drag"</span>, <span class="keyword">function</span>( event, ui ) {} );</code></div></div></pre>
  1648. </td>
  1649. </tr>
  1650. </tbody>
  1651. </table>
  1652. </div>
  1653. </div>
  1654. </div>
  1655. <div id="event-start" class="api-item">
  1656. <h3>start( event, ui )<span class="returns">Type: <code>dragstart</code></span>
  1657. </h3>
  1658. <div>Triggered when dragging starts.</div>
  1659. <ul>
  1660. <li>
  1661. <div><strong>event</strong></div>
  1662. <div>Type: <a href="http://api.jquery.com/Types/#Event">Event</a>
  1663. </div>
  1664. <div></div>
  1665. </li>
  1666. <li>
  1667. <div><strong>ui</strong></div>
  1668. <div>Type: <a href="http://api.jquery.com/Types/#Object">Object</a>
  1669. </div>
  1670. <div></div>
  1671. <ul>
  1672. <li>
  1673. <div><strong>helper</strong></div>
  1674. <div>Type: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a>
  1675. </div>
  1676. <div>The jQuery object representing the helper that's being dragged.</div>
  1677. </li>
  1678. <li>
  1679. <div><strong>position</strong></div>
  1680. <div>Type: <a href="http://api.jquery.com/Types/#Object">Object</a>
  1681. </div>
  1682. <div>Current CSS position of the helper as <code>{ top, left }</code> object.</div>
  1683. </li>
  1684. <li>
  1685. <div><strong>offset</strong></div>
  1686. <div>Type: <a href="http://api.jquery.com/Types/#Object">Object</a>
  1687. </div>
  1688. <div>Current offset position of the helper as <code>{ top, left }</code> object.</div>
  1689. </li>
  1690. </ul>
  1691. </li>
  1692. </ul>
  1693. <div>
  1694. <strong>Code examples:</strong><p>Initialize the draggable with the start callback specified:</p>
  1695. <div class="syntaxhighlighter javascript nogutter">
  1696. <table>
  1697. <tbody>
  1698. <tr>
  1699. <td class="gutter">
  1700. <div class="line n1">1</div>
  1701. <div class="line n2">2</div>
  1702. <div class="line n3">3</div>
  1703. </td>
  1704. <td class="code">
  1705. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable({</code></div></div><div class="container"><div class="line"><code> start: <span class="keyword">function</span>( event, ui ) {}</code></div></div><div class="container"><div class="line"><code>});</code></div></div></pre>
  1706. </td>
  1707. </tr>
  1708. </tbody>
  1709. </table>
  1710. </div>
  1711. <p>Bind an event listener to the dragstart event:</p>
  1712. <div class="syntaxhighlighter javascript nogutter">
  1713. <table>
  1714. <tbody>
  1715. <tr>
  1716. <td class="gutter">
  1717. <div class="line n1">1</div>
  1718. </td>
  1719. <td class="code">
  1720. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).on( <span class="string">"dragstart"</span>, <span class="keyword">function</span>( event, ui ) {} );</code></div></div></pre>
  1721. </td>
  1722. </tr>
  1723. </tbody>
  1724. </table>
  1725. </div>
  1726. </div>
  1727. </div>
  1728. <div id="event-stop" class="api-item">
  1729. <h3>stop( event, ui )<span class="returns">Type: <code>dragstop</code></span>
  1730. </h3>
  1731. <div>Triggered when dragging stops.</div>
  1732. <ul>
  1733. <li>
  1734. <div><strong>event</strong></div>
  1735. <div>Type: <a href="http://api.jquery.com/Types/#Event">Event</a>
  1736. </div>
  1737. <div></div>
  1738. </li>
  1739. <li>
  1740. <div><strong>ui</strong></div>
  1741. <div>Type: <a href="http://api.jquery.com/Types/#Object">Object</a>
  1742. </div>
  1743. <div></div>
  1744. <ul>
  1745. <li>
  1746. <div><strong>helper</strong></div>
  1747. <div>Type: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a>
  1748. </div>
  1749. <div>The jQuery object representing the helper that's being dragged.</div>
  1750. </li>
  1751. <li>
  1752. <div><strong>position</strong></div>
  1753. <div>Type: <a href="http://api.jquery.com/Types/#Object">Object</a>
  1754. </div>
  1755. <div>Current CSS position of the helper as <code>{ top, left }</code> object.</div>
  1756. </li>
  1757. <li>
  1758. <div><strong>offset</strong></div>
  1759. <div>Type: <a href="http://api.jquery.com/Types/#Object">Object</a>
  1760. </div>
  1761. <div>Current offset position of the helper as <code>{ top, left }</code> object.</div>
  1762. </li>
  1763. </ul>
  1764. </li>
  1765. </ul>
  1766. <div>
  1767. <strong>Code examples:</strong><p>Initialize the draggable with the stop callback specified:</p>
  1768. <div class="syntaxhighlighter javascript nogutter">
  1769. <table>
  1770. <tbody>
  1771. <tr>
  1772. <td class="gutter">
  1773. <div class="line n1">1</div>
  1774. <div class="line n2">2</div>
  1775. <div class="line n3">3</div>
  1776. </td>
  1777. <td class="code">
  1778. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).draggable({</code></div></div><div class="container"><div class="line"><code> stop: <span class="keyword">function</span>( event, ui ) {}</code></div></div><div class="container"><div class="line"><code>});</code></div></div></pre>
  1779. </td>
  1780. </tr>
  1781. </tbody>
  1782. </table>
  1783. </div>
  1784. <p>Bind an event listener to the dragstop event:</p>
  1785. <div class="syntaxhighlighter javascript nogutter">
  1786. <table>
  1787. <tbody>
  1788. <tr>
  1789. <td class="gutter">
  1790. <div class="line n1">1</div>
  1791. </td>
  1792. <td class="code">
  1793. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).on( <span class="string">"dragstop"</span>, <span class="keyword">function</span>( event, ui ) {} );</code></div></div></pre>
  1794. </td>
  1795. </tr>
  1796. </tbody>
  1797. </table>
  1798. </div>
  1799. </div>
  1800. </div></section><section class="entry-examples" id="entry-examples"><header><h2>Example:</h2></header><div class="entry-example" id="example-0">
  1801. <h4><span class="desc">A simple jQuery UI Draggable</span></h4>
  1802. <div class="syntaxhighlighter xml ">
  1803. <table>
  1804. <tbody>
  1805. <tr>
  1806. <td class="gutter">
  1807. <div class="line n1">1</div>
  1808. <div class="line n2">2</div>
  1809. <div class="line n3">3</div>
  1810. <div class="line n4">4</div>
  1811. <div class="line n5">5</div>
  1812. <div class="line n6">6</div>
  1813. <div class="line n7">7</div>
  1814. <div class="line n8">8</div>
  1815. <div class="line n9">9</div>
  1816. <div class="line n10">10</div>
  1817. <div class="line n11">11</div>
  1818. <div class="line n12">12</div>
  1819. <div class="line n13">13</div>
  1820. <div class="line n14">14</div>
  1821. <div class="line n15">15</div>
  1822. <div class="line n16">16</div>
  1823. <div class="line n17">17</div>
  1824. <div class="line n18">18</div>
  1825. <div class="line n19">19</div>
  1826. <div class="line n20">20</div>
  1827. <div class="line n21">21</div>
  1828. <div class="line n22">22</div>
  1829. <div class="line n23">23</div>
  1830. <div class="line n24">24</div>
  1831. <div class="line n25">25</div>
  1832. <div class="line n26">26</div>
  1833. </td>
  1834. <td class="code">
  1835. <pre><div class="container"><div class="line"><code><span class="doctype">&lt;!doctype html&gt;</span></code></div></div><div class="container"><div class="line"><code><span class="tag">&lt;<span class="title">html</span> <span class="attribute">lang</span>=<span class="value">"en"</span>&gt;</span></code></div></div><div class="container"><div class="line"><code><span class="tag">&lt;<span class="title">head</span>&gt;</span></code></div></div><div class="container"><div class="line"><code> <span class="tag">&lt;<span class="title">meta</span> <span class="attribute">charset</span>=<span class="value">"utf-8"</span>&gt;</span></code></div></div><div class="container"><div class="line"><code> <span class="tag">&lt;<span class="title">title</span>&gt;</span>draggable demo<span class="tag">&lt;/<span class="title">title</span>&gt;</span></code></div></div><div class="container"><div class="line"><code> <span class="tag">&lt;<span class="title">link</span> <span class="attribute">rel</span>=<span class="value">"stylesheet"</span> <span class="attribute">href</span>=<span class="value">"//code.jquery.com/ui/1.10.4/themes/smoothness/jquery-ui.css"</span>&gt;</span></code></div></div><div class="container"><div class="line"><code> <span class="tag">&lt;<span class="title">style</span>&gt;</span><span class="css"></span></code></div></div><div class="container"><div class="line"><code> <span class="id">#draggable</span> <span class="rules">{</span></code></div></div><div class="container"><div class="line"><code> <span class="rule"><span class="attribute">width</span>:<span class="value"> <span class="number">100</span>px;</span></span></code></div></div><div class="container"><div class="line"><code> <span class="rule"><span class="attribute">height</span>:<span class="value"> <span class="number">100</span>px;</span></span></code></div></div><div class="container"><div class="line"><code> <span class="rule"><span class="attribute">background</span>:<span class="value"> <span class="hexcolor">#ccc</span>;</span></span></code></div></div><div class="container"><div class="line"><code> <span class="rule">}</span></code></div></div><div class="container"><div class="line"><code> <span class="tag">&lt;/<span class="title">style</span>&gt;</span></code></div></div><div class="container"><div class="line"><code> <span class="tag">&lt;<span class="title">script</span> <span class="attribute">src</span>=<span class="value">"//code.jquery.com/jquery-1.10.2.js"</span>&gt;</span><span class="javascript"></span><span class="tag">&lt;/<span class="title">script</span>&gt;</span></code></div></div><div class="container"><div class="line"><code> <span class="tag">&lt;<span class="title">script</span> <span class="attribute">src</span>=<span class="value">"//code.jquery.com/ui/1.10.4/jquery-ui.js"</span>&gt;</span><span class="javascript"></span><span class="tag">&lt;/<span class="title">script</span>&gt;</span></code></div></div><div class="container"><div class="line"><code><span class="tag">&lt;/<span class="title">head</span>&gt;</span></code></div></div><div class="container"><div class="line"><code><span class="tag">&lt;<span class="title">body</span>&gt;</span></code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="tag">&lt;<span class="title">div</span> <span class="attribute">id</span>=<span class="value">"draggable"</span>&gt;</span>Drag me<span class="tag">&lt;/<span class="title">div</span>&gt;</span></code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="tag">&lt;<span class="title">script</span>&gt;</span><span class="javascript"></span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">"#draggable"</span> ).draggable();</code></div></div><div class="container"><div class="line"><code><span class="tag">&lt;/<span class="title">script</span>&gt;</span></code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="tag">&lt;/<span class="title">body</span>&gt;</span></code></div></div><div class="container"><div class="line"><code><span class="tag">&lt;/<span class="title">html</span>&gt;</span></code></div></div></pre>
  1836. </td>
  1837. </tr>
  1838. </tbody>
  1839. </table>
  1840. </div>
  1841. <h4>Demo:</h4>
  1842. <div class="demo code-demo"></div>
  1843. </div></section>
  1844. </div></article>
  1845. </body>
  1846. </html>