droppable.html 51 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324
  1. <!doctype html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>jQuery UI droppable 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. "Droppable Widget",
  19. "excerpt":
  20. "Create targets for draggable elements.",
  21. "termSlugs": {
  22. "category": [
  23. "interactions"
  24. ]
  25. }
  26. }</script><article id="droppable1" class="entry widget"><h2 class="section-title">
  27. <span>Droppable 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>Create targets for draggable elements.</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-accept">accept</a></div>
  35. <div><a href="#option-activeClass">activeClass</a></div>
  36. <div><a href="#option-addClasses">addClasses</a></div>
  37. <div><a href="#option-disabled">disabled</a></div>
  38. <div><a href="#option-greedy">greedy</a></div>
  39. <div><a href="#option-hoverClass">hoverClass</a></div>
  40. <div><a href="#option-scope">scope</a></div>
  41. <div><a href="#option-tolerance">tolerance</a></div>
  42. </div>
  43. <div class="quick-nav-section">
  44. <h3>Methods</h3>
  45. <div><a href="#method-destroy">destroy</a></div>
  46. <div><a href="#method-disable">disable</a></div>
  47. <div><a href="#method-enable">enable</a></div>
  48. <div><a href="#method-option">option</a></div>
  49. <div><a href="#method-widget">widget</a></div>
  50. </div>
  51. <div class="quick-nav-section">
  52. <h3>Events</h3>
  53. <div><a href="#event-activate">activate</a></div>
  54. <div><a href="#event-create">create</a></div>
  55. <div><a href="#event-deactivate">deactivate</a></div>
  56. <div><a href="#event-drop">drop</a></div>
  57. <div><a href="#event-out">out</a></div>
  58. <div><a href="#event-over">over</a></div>
  59. </div></section><div class="longdesc" id="entry-longdesc">
  60. <p>The jQuery UI Droppable plugin makes selected elements droppable (meaning they accept being dropped on by <a href="/draggable/">draggables</a>). You can specify which draggables each will accept.</p>
  61. <h3>Dependencies</h3>
  62. <ul>
  63. <li><a href="/category/ui-core/">UI Core</a></li>
  64. <li><a href="/jQuery.widget/">Widget Factory</a></li>
  65. <li><a href="/mouse/">Mouse Interaction</a></li>
  66. </ul>
  67. </div>
  68. <section id="options"><header><h2>Options</h2></header><div id="option-accept" class="api-item first-item">
  69. <h3>accept<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/#Function">Function</a>()</span>
  70. </h3>
  71. <div class="default">
  72. <strong>Default: </strong><code>"*"</code>
  73. </div>
  74. <div>Controls which draggable elements are accepted by the droppable.</div>
  75. <strong>Multiple types supported:</strong><ul>
  76. <li>
  77. <strong>Selector</strong>: A selector indicating which draggable elements are accepted.</li>
  78. <li>
  79. <strong>Function</strong>: A function that will be called for each draggable on the page (passed as the first argument to the function). The function must return <code>true</code> if the draggable should be accepted.</li>
  80. </ul>
  81. <strong>Code examples:</strong><p>Initialize the droppable with the <code>accept</code> option specified:</p>
  82. <div class="syntaxhighlighter javascript nogutter">
  83. <table>
  84. <tbody>
  85. <tr>
  86. <td class="gutter">
  87. <div class="line n1">1</div>
  88. </td>
  89. <td class="code">
  90. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).droppable({ accept: <span class="string">".special"</span> });</code></div></div></pre>
  91. </td>
  92. </tr>
  93. </tbody>
  94. </table>
  95. </div>
  96. <p>Get or set the <code>accept</code> option, after initialization:</p>
  97. <div class="syntaxhighlighter javascript nogutter">
  98. <table>
  99. <tbody>
  100. <tr>
  101. <td class="gutter">
  102. <div class="line n1">1</div>
  103. <div class="line n2">2</div>
  104. <div class="line n3">3</div>
  105. <div class="line n4">4</div>
  106. <div class="line n5">5</div>
  107. </td>
  108. <td class="code">
  109. <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> accept = $( <span class="string">".selector"</span> ).droppable( <span class="string">"option"</span>, <span class="string">"accept"</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> ).droppable( <span class="string">"option"</span>, <span class="string">"accept"</span>, <span class="string">".special"</span> );</code></div></div></pre>
  110. </td>
  111. </tr>
  112. </tbody>
  113. </table>
  114. </div>
  115. </div>
  116. <div id="option-activeClass" class="api-item">
  117. <h3>activeClass<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#String">String</a></span>
  118. </h3>
  119. <div class="default">
  120. <strong>Default: </strong><code>false</code>
  121. </div>
  122. <div>If specified, the class will be added to the droppable while an acceptable draggable is being dragged.</div>
  123. <strong>Code examples:</strong><p>Initialize the droppable with the <code>activeClass</code> option specified:</p>
  124. <div class="syntaxhighlighter javascript nogutter">
  125. <table>
  126. <tbody>
  127. <tr>
  128. <td class="gutter">
  129. <div class="line n1">1</div>
  130. </td>
  131. <td class="code">
  132. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).droppable({ activeClass: <span class="string">"ui-state-highlight"</span> });</code></div></div></pre>
  133. </td>
  134. </tr>
  135. </tbody>
  136. </table>
  137. </div>
  138. <p>Get or set the <code>activeClass</code> option, after initialization:</p>
  139. <div class="syntaxhighlighter javascript nogutter">
  140. <table>
  141. <tbody>
  142. <tr>
  143. <td class="gutter">
  144. <div class="line n1">1</div>
  145. <div class="line n2">2</div>
  146. <div class="line n3">3</div>
  147. <div class="line n4">4</div>
  148. <div class="line n5">5</div>
  149. </td>
  150. <td class="code">
  151. <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> activeClass = $( <span class="string">".selector"</span> ).droppable( <span class="string">"option"</span>, <span class="string">"activeClass"</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> ).droppable( <span class="string">"option"</span>, <span class="string">"activeClass"</span>, <span class="string">"ui-state-highlight"</span> );</code></div></div></pre>
  152. </td>
  153. </tr>
  154. </tbody>
  155. </table>
  156. </div>
  157. </div>
  158. <div id="option-addClasses" class="api-item">
  159. <h3>addClasses<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Boolean">Boolean</a></span>
  160. </h3>
  161. <div class="default">
  162. <strong>Default: </strong><code>true</code>
  163. </div>
  164. <div>If set to <code>false</code>, will prevent the <code>ui-droppable</code> class from being added. This may be desired as a performance optimization when calling <code>.droppable()</code> init on hundreds of elements.</div>
  165. <strong>Code examples:</strong><p>Initialize the droppable with the <code>addClasses</code> option specified:</p>
  166. <div class="syntaxhighlighter javascript nogutter">
  167. <table>
  168. <tbody>
  169. <tr>
  170. <td class="gutter">
  171. <div class="line n1">1</div>
  172. </td>
  173. <td class="code">
  174. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).droppable({ addClasses: <span class="literal">false</span> });</code></div></div></pre>
  175. </td>
  176. </tr>
  177. </tbody>
  178. </table>
  179. </div>
  180. <p>Get or set the <code>addClasses</code> option, after initialization:</p>
  181. <div class="syntaxhighlighter javascript nogutter">
  182. <table>
  183. <tbody>
  184. <tr>
  185. <td class="gutter">
  186. <div class="line n1">1</div>
  187. <div class="line n2">2</div>
  188. <div class="line n3">3</div>
  189. <div class="line n4">4</div>
  190. <div class="line n5">5</div>
  191. </td>
  192. <td class="code">
  193. <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> ).droppable( <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> ).droppable( <span class="string">"option"</span>, <span class="string">"addClasses"</span>, <span class="literal">false</span> );</code></div></div></pre>
  194. </td>
  195. </tr>
  196. </tbody>
  197. </table>
  198. </div>
  199. </div>
  200. <div id="option-disabled" class="api-item">
  201. <h3>disabled<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Boolean">Boolean</a></span>
  202. </h3>
  203. <div class="default">
  204. <strong>Default: </strong><code>false</code>
  205. </div>
  206. <div>Disables the droppable if set to <code>true</code>.</div>
  207. <strong>Code examples:</strong><p>Initialize the droppable with the <code>disabled</code> option specified:</p>
  208. <div class="syntaxhighlighter javascript nogutter">
  209. <table>
  210. <tbody>
  211. <tr>
  212. <td class="gutter">
  213. <div class="line n1">1</div>
  214. </td>
  215. <td class="code">
  216. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).droppable({ disabled: <span class="literal">true</span> });</code></div></div></pre>
  217. </td>
  218. </tr>
  219. </tbody>
  220. </table>
  221. </div>
  222. <p>Get or set the <code>disabled</code> option, after initialization:</p>
  223. <div class="syntaxhighlighter javascript nogutter">
  224. <table>
  225. <tbody>
  226. <tr>
  227. <td class="gutter">
  228. <div class="line n1">1</div>
  229. <div class="line n2">2</div>
  230. <div class="line n3">3</div>
  231. <div class="line n4">4</div>
  232. <div class="line n5">5</div>
  233. </td>
  234. <td class="code">
  235. <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> ).droppable( <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> ).droppable( <span class="string">"option"</span>, <span class="string">"disabled"</span>, <span class="literal">true</span> );</code></div></div></pre>
  236. </td>
  237. </tr>
  238. </tbody>
  239. </table>
  240. </div>
  241. </div>
  242. <div id="option-greedy" class="api-item">
  243. <h3>greedy<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Boolean">Boolean</a></span>
  244. </h3>
  245. <div class="default">
  246. <strong>Default: </strong><code>false</code>
  247. </div>
  248. <div>By default, when an element is dropped on nested droppables, each droppable will receive the element. However, by setting this option to <code>true</code>, any parent droppables will not receive the element. The <code>drop</code> event will still bubble normally, but the <code>event.target</code> can be checked to see which droppable received the draggable element.</div>
  249. <strong>Code examples:</strong><p>Initialize the droppable with the <code>greedy</code> option specified:</p>
  250. <div class="syntaxhighlighter javascript nogutter">
  251. <table>
  252. <tbody>
  253. <tr>
  254. <td class="gutter">
  255. <div class="line n1">1</div>
  256. </td>
  257. <td class="code">
  258. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).droppable({ greedy: <span class="literal">true</span> });</code></div></div></pre>
  259. </td>
  260. </tr>
  261. </tbody>
  262. </table>
  263. </div>
  264. <p>Get or set the <code>greedy</code> option, after initialization:</p>
  265. <div class="syntaxhighlighter javascript nogutter">
  266. <table>
  267. <tbody>
  268. <tr>
  269. <td class="gutter">
  270. <div class="line n1">1</div>
  271. <div class="line n2">2</div>
  272. <div class="line n3">3</div>
  273. <div class="line n4">4</div>
  274. <div class="line n5">5</div>
  275. </td>
  276. <td class="code">
  277. <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> greedy = $( <span class="string">".selector"</span> ).droppable( <span class="string">"option"</span>, <span class="string">"greedy"</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> ).droppable( <span class="string">"option"</span>, <span class="string">"greedy"</span>, <span class="literal">true</span> );</code></div></div></pre>
  278. </td>
  279. </tr>
  280. </tbody>
  281. </table>
  282. </div>
  283. </div>
  284. <div id="option-hoverClass" class="api-item">
  285. <h3>hoverClass<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#String">String</a></span>
  286. </h3>
  287. <div class="default">
  288. <strong>Default: </strong><code>false</code>
  289. </div>
  290. <div>If specified, the class will be added to the droppable while an acceptable draggable is being hovered over the droppable.</div>
  291. <strong>Code examples:</strong><p>Initialize the droppable with the <code>hoverClass</code> option specified:</p>
  292. <div class="syntaxhighlighter javascript nogutter">
  293. <table>
  294. <tbody>
  295. <tr>
  296. <td class="gutter">
  297. <div class="line n1">1</div>
  298. </td>
  299. <td class="code">
  300. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).droppable({ hoverClass: <span class="string">"drop-hover"</span> });</code></div></div></pre>
  301. </td>
  302. </tr>
  303. </tbody>
  304. </table>
  305. </div>
  306. <p>Get or set the <code>hoverClass</code> option, after initialization:</p>
  307. <div class="syntaxhighlighter javascript nogutter">
  308. <table>
  309. <tbody>
  310. <tr>
  311. <td class="gutter">
  312. <div class="line n1">1</div>
  313. <div class="line n2">2</div>
  314. <div class="line n3">3</div>
  315. <div class="line n4">4</div>
  316. <div class="line n5">5</div>
  317. </td>
  318. <td class="code">
  319. <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> hoverClass = $( <span class="string">".selector"</span> ).droppable( <span class="string">"option"</span>, <span class="string">"hoverClass"</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> ).droppable( <span class="string">"option"</span>, <span class="string">"hoverClass"</span>, <span class="string">"drop-hover"</span> );</code></div></div></pre>
  320. </td>
  321. </tr>
  322. </tbody>
  323. </table>
  324. </div>
  325. </div>
  326. <div id="option-scope" class="api-item">
  327. <h3>scope<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#String">String</a></span>
  328. </h3>
  329. <div class="default">
  330. <strong>Default: </strong><code>"default"</code>
  331. </div>
  332. <div>Used to group sets of draggable and droppable items, in addition to the <a href="#option-accept"><code>accept</code></a> option. A draggable with the same scope value as a droppable will be accepted.</div>
  333. <strong>Code examples:</strong><p>Initialize the droppable with the <code>scope</code> option specified:</p>
  334. <div class="syntaxhighlighter javascript nogutter">
  335. <table>
  336. <tbody>
  337. <tr>
  338. <td class="gutter">
  339. <div class="line n1">1</div>
  340. </td>
  341. <td class="code">
  342. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).droppable({ scope: <span class="string">"tasks"</span> });</code></div></div></pre>
  343. </td>
  344. </tr>
  345. </tbody>
  346. </table>
  347. </div>
  348. <p>Get or set the <code>scope</code> option, after initialization:</p>
  349. <div class="syntaxhighlighter javascript nogutter">
  350. <table>
  351. <tbody>
  352. <tr>
  353. <td class="gutter">
  354. <div class="line n1">1</div>
  355. <div class="line n2">2</div>
  356. <div class="line n3">3</div>
  357. <div class="line n4">4</div>
  358. <div class="line n5">5</div>
  359. </td>
  360. <td class="code">
  361. <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> ).droppable( <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> ).droppable( <span class="string">"option"</span>, <span class="string">"scope"</span>, <span class="string">"tasks"</span> );</code></div></div></pre>
  362. </td>
  363. </tr>
  364. </tbody>
  365. </table>
  366. </div>
  367. </div>
  368. <div id="option-tolerance" class="api-item">
  369. <h3>tolerance<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#String">String</a></span>
  370. </h3>
  371. <div class="default">
  372. <strong>Default: </strong><code>"intersect"</code>
  373. </div>
  374. <div>
  375. Specifies which mode to use for testing whether a draggable is hovering over a droppable. Possible values:
  376. <ul>
  377. <li>
  378. <code>"fit"</code>: Draggable overlaps the droppable entirely.</li>
  379. <li>
  380. <code>"intersect"</code>: Draggable overlaps the droppable at least 50% in both directions.</li>
  381. <li>
  382. <code>"pointer"</code>: Mouse pointer overlaps the droppable.</li>
  383. <li>
  384. <code>"touch"</code>: Draggable overlaps the droppable any amount.</li>
  385. </ul>
  386. </div>
  387. <strong>Code examples:</strong><p>Initialize the droppable with the <code>tolerance</code> option specified:</p>
  388. <div class="syntaxhighlighter javascript nogutter">
  389. <table>
  390. <tbody>
  391. <tr>
  392. <td class="gutter">
  393. <div class="line n1">1</div>
  394. </td>
  395. <td class="code">
  396. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).droppable({ tolerance: <span class="string">"fit"</span> });</code></div></div></pre>
  397. </td>
  398. </tr>
  399. </tbody>
  400. </table>
  401. </div>
  402. <p>Get or set the <code>tolerance</code> option, after initialization:</p>
  403. <div class="syntaxhighlighter javascript nogutter">
  404. <table>
  405. <tbody>
  406. <tr>
  407. <td class="gutter">
  408. <div class="line n1">1</div>
  409. <div class="line n2">2</div>
  410. <div class="line n3">3</div>
  411. <div class="line n4">4</div>
  412. <div class="line n5">5</div>
  413. </td>
  414. <td class="code">
  415. <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> tolerance = $( <span class="string">".selector"</span> ).droppable( <span class="string">"option"</span>, <span class="string">"tolerance"</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> ).droppable( <span class="string">"option"</span>, <span class="string">"tolerance"</span>, <span class="string">"fit"</span> );</code></div></div></pre>
  416. </td>
  417. </tr>
  418. </tbody>
  419. </table>
  420. </div>
  421. </div></section><section id="methods"><header><h2>Methods</h2></header><div id="method-destroy"><div class="api-item first-item">
  422. <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>
  423. </h3>
  424. <div>
  425. Removes the droppable functionality completely. This will return the element back to its pre-init state.
  426. </div>
  427. <ul><li><div class="null-signature">This method does not accept any arguments.</div></li></ul>
  428. <div>
  429. <strong>Code examples:</strong><p>Invoke the destroy method:</p>
  430. <div class="syntaxhighlighter javascript nogutter">
  431. <table>
  432. <tbody>
  433. <tr>
  434. <td class="gutter">
  435. <div class="line n1">1</div>
  436. </td>
  437. <td class="code">
  438. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).droppable( <span class="string">"destroy"</span> );</code></div></div></pre>
  439. </td>
  440. </tr>
  441. </tbody>
  442. </table>
  443. </div>
  444. </div>
  445. </div></div>
  446. <div id="method-disable"><div class="api-item">
  447. <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>
  448. </h3>
  449. <div>
  450. Disables the droppable.
  451. </div>
  452. <ul><li><div class="null-signature">This method does not accept any arguments.</div></li></ul>
  453. <div>
  454. <strong>Code examples:</strong><p>Invoke the disable method:</p>
  455. <div class="syntaxhighlighter javascript nogutter">
  456. <table>
  457. <tbody>
  458. <tr>
  459. <td class="gutter">
  460. <div class="line n1">1</div>
  461. </td>
  462. <td class="code">
  463. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).droppable( <span class="string">"disable"</span> );</code></div></div></pre>
  464. </td>
  465. </tr>
  466. </tbody>
  467. </table>
  468. </div>
  469. </div>
  470. </div></div>
  471. <div id="method-enable"><div class="api-item">
  472. <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>
  473. </h3>
  474. <div>
  475. Enables the droppable.
  476. </div>
  477. <ul><li><div class="null-signature">This method does not accept any arguments.</div></li></ul>
  478. <div>
  479. <strong>Code examples:</strong><p>Invoke the enable method:</p>
  480. <div class="syntaxhighlighter javascript nogutter">
  481. <table>
  482. <tbody>
  483. <tr>
  484. <td class="gutter">
  485. <div class="line n1">1</div>
  486. </td>
  487. <td class="code">
  488. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).droppable( <span class="string">"enable"</span> );</code></div></div></pre>
  489. </td>
  490. </tr>
  491. </tbody>
  492. </table>
  493. </div>
  494. </div>
  495. </div></div>
  496. <div id="method-option">
  497. <div class="api-item">
  498. <h3>option( optionName )<span class="returns">Returns: <a href="http://api.jquery.com/Types/#Object">Object</a></span>
  499. </h3>
  500. <div>Gets the value currently associated with the specified <code>optionName</code>.</div>
  501. <ul><li>
  502. <div><strong>optionName</strong></div>
  503. <div>Type: <a href="http://api.jquery.com/Types/#String">String</a>
  504. </div>
  505. <div>The name of the option to get.</div>
  506. </li></ul>
  507. <div>
  508. <strong>Code examples:</strong><p>Invoke the method:</p>
  509. <div class="syntaxhighlighter javascript nogutter">
  510. <table>
  511. <tbody>
  512. <tr>
  513. <td class="gutter">
  514. <div class="line n1">1</div>
  515. </td>
  516. <td class="code">
  517. <pre><div class="container"><div class="line"><code><span class="keyword">var</span> isDisabled = $( <span class="string">".selector"</span> ).droppable( <span class="string">"option"</span>, <span class="string">"disabled"</span> );</code></div></div></pre>
  518. </td>
  519. </tr>
  520. </tbody>
  521. </table>
  522. </div>
  523. </div>
  524. </div>
  525. <div class="api-item">
  526. <h3>option()<span class="returns">Returns: <a href="http://api.jquery.com/Types/#PlainObject">PlainObject</a></span>
  527. </h3>
  528. <div>Gets an object containing key/value pairs representing the current droppable options hash.</div>
  529. <ul><li><div class="null-signature">This signature does not accept any arguments.</div></li></ul>
  530. <div>
  531. <strong>Code examples:</strong><p>Invoke the method:</p>
  532. <div class="syntaxhighlighter javascript nogutter">
  533. <table>
  534. <tbody>
  535. <tr>
  536. <td class="gutter">
  537. <div class="line n1">1</div>
  538. </td>
  539. <td class="code">
  540. <pre><div class="container"><div class="line"><code><span class="keyword">var</span> options = $( <span class="string">".selector"</span> ).droppable( <span class="string">"option"</span> );</code></div></div></pre>
  541. </td>
  542. </tr>
  543. </tbody>
  544. </table>
  545. </div>
  546. </div>
  547. </div>
  548. <div class="api-item">
  549. <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>
  550. </h3>
  551. <div>Sets the value of the droppable option associated with the specified <code>optionName</code>.</div>
  552. <ul>
  553. <li>
  554. <div><strong>optionName</strong></div>
  555. <div>Type: <a href="http://api.jquery.com/Types/#String">String</a>
  556. </div>
  557. <div>The name of the option to set.</div>
  558. </li>
  559. <li>
  560. <div><strong>value</strong></div>
  561. <div>Type: <a href="http://api.jquery.com/Types/#Object">Object</a>
  562. </div>
  563. <div>A value to set for the option.</div>
  564. </li>
  565. </ul>
  566. <div>
  567. <strong>Code examples:</strong><p>Invoke the method:</p>
  568. <div class="syntaxhighlighter javascript nogutter">
  569. <table>
  570. <tbody>
  571. <tr>
  572. <td class="gutter">
  573. <div class="line n1">1</div>
  574. </td>
  575. <td class="code">
  576. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).droppable( <span class="string">"option"</span>, <span class="string">"disabled"</span>, <span class="literal">true</span> );</code></div></div></pre>
  577. </td>
  578. </tr>
  579. </tbody>
  580. </table>
  581. </div>
  582. </div>
  583. </div>
  584. <div class="api-item">
  585. <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>
  586. </h3>
  587. <div>Sets one or more options for the droppable.</div>
  588. <ul><li>
  589. <div><strong>options</strong></div>
  590. <div>Type: <a href="http://api.jquery.com/Types/#Object">Object</a>
  591. </div>
  592. <div>A map of option-value pairs to set.</div>
  593. </li></ul>
  594. <div>
  595. <strong>Code examples:</strong><p>Invoke the method:</p>
  596. <div class="syntaxhighlighter javascript nogutter">
  597. <table>
  598. <tbody>
  599. <tr>
  600. <td class="gutter">
  601. <div class="line n1">1</div>
  602. </td>
  603. <td class="code">
  604. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).droppable( <span class="string">"option"</span>, { disabled: <span class="literal">true</span> } );</code></div></div></pre>
  605. </td>
  606. </tr>
  607. </tbody>
  608. </table>
  609. </div>
  610. </div>
  611. </div>
  612. </div>
  613. <div id="method-widget"><div class="api-item">
  614. <h3>widget()<span class="returns">Returns: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a></span>
  615. </h3>
  616. <div>
  617. Returns a <code>jQuery</code> object containing the droppable element.
  618. </div>
  619. <ul><li><div class="null-signature">This method does not accept any arguments.</div></li></ul>
  620. <div>
  621. <strong>Code examples:</strong><p>Invoke the widget method:</p>
  622. <div class="syntaxhighlighter javascript nogutter">
  623. <table>
  624. <tbody>
  625. <tr>
  626. <td class="gutter">
  627. <div class="line n1">1</div>
  628. </td>
  629. <td class="code">
  630. <pre><div class="container"><div class="line"><code><span class="keyword">var</span> widget = $( <span class="string">".selector"</span> ).droppable( <span class="string">"widget"</span> );</code></div></div></pre>
  631. </td>
  632. </tr>
  633. </tbody>
  634. </table>
  635. </div>
  636. </div>
  637. </div></div></section><section id="events"><header><h2>Events</h2></header><div id="event-activate" class="api-item first-item">
  638. <h3>activate( event, ui )<span class="returns">Type: <code>dropactivate</code></span>
  639. </h3>
  640. <div>Triggered when an accepted draggable starts dragging. This can be useful if you want to make the droppable "light up" when it can be dropped on.</div>
  641. <ul>
  642. <li>
  643. <div><strong>event</strong></div>
  644. <div>Type: <a href="http://api.jquery.com/Types/#Event">Event</a>
  645. </div>
  646. <div></div>
  647. </li>
  648. <li>
  649. <div><strong>ui</strong></div>
  650. <div>Type: <a href="http://api.jquery.com/Types/#Object">Object</a>
  651. </div>
  652. <div></div>
  653. <ul>
  654. <li>
  655. <div><strong>draggable</strong></div>
  656. <div>Type: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a>
  657. </div>
  658. <div>A jQuery object representing the draggable element.</div>
  659. </li>
  660. <li>
  661. <div><strong>helper</strong></div>
  662. <div>Type: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a>
  663. </div>
  664. <div>A jQuery object representing the helper that is being dragged.</div>
  665. </li>
  666. <li>
  667. <div><strong>position</strong></div>
  668. <div>Type: <a href="http://api.jquery.com/Types/#Object">Object</a>
  669. </div>
  670. <div>Current CSS position of the draggable helper as <code>{ top, left }</code> object.</div>
  671. </li>
  672. <li>
  673. <div><strong>offset</strong></div>
  674. <div>Type: <a href="http://api.jquery.com/Types/#Object">Object</a>
  675. </div>
  676. <div>Current offset position of the draggable helper as <code>{ top, left }</code> object.</div>
  677. </li>
  678. </ul>
  679. </li>
  680. </ul>
  681. <div>
  682. <strong>Code examples:</strong><p>Initialize the droppable with the activate callback specified:</p>
  683. <div class="syntaxhighlighter javascript nogutter">
  684. <table>
  685. <tbody>
  686. <tr>
  687. <td class="gutter">
  688. <div class="line n1">1</div>
  689. <div class="line n2">2</div>
  690. <div class="line n3">3</div>
  691. </td>
  692. <td class="code">
  693. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).droppable({</code></div></div><div class="container"><div class="line"><code> activate: <span class="keyword">function</span>( event, ui ) {}</code></div></div><div class="container"><div class="line"><code>});</code></div></div></pre>
  694. </td>
  695. </tr>
  696. </tbody>
  697. </table>
  698. </div>
  699. <p>Bind an event listener to the dropactivate event:</p>
  700. <div class="syntaxhighlighter javascript nogutter">
  701. <table>
  702. <tbody>
  703. <tr>
  704. <td class="gutter">
  705. <div class="line n1">1</div>
  706. </td>
  707. <td class="code">
  708. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).on( <span class="string">"dropactivate"</span>, <span class="keyword">function</span>( event, ui ) {} );</code></div></div></pre>
  709. </td>
  710. </tr>
  711. </tbody>
  712. </table>
  713. </div>
  714. </div>
  715. </div>
  716. <div id="event-create" class="api-item">
  717. <h3>create( event, ui )<span class="returns">Type: <code>dropcreate</code></span>
  718. </h3>
  719. <div>
  720. Triggered when the droppable is created.
  721. </div>
  722. <ul>
  723. <li>
  724. <div><strong>event</strong></div>
  725. <div>Type: <a href="http://api.jquery.com/Types/#Event">Event</a>
  726. </div>
  727. <div></div>
  728. </li>
  729. <li>
  730. <div><strong>ui</strong></div>
  731. <div>Type: <a href="http://api.jquery.com/Types/#Object">Object</a>
  732. </div>
  733. <div></div>
  734. </li>
  735. </ul>
  736. <p><em>Note: The <code>ui</code> object is empty but included for consistency with other events.</em></p>
  737. <div>
  738. <strong>Code examples:</strong><p>Initialize the droppable with the create callback specified:</p>
  739. <div class="syntaxhighlighter javascript nogutter">
  740. <table>
  741. <tbody>
  742. <tr>
  743. <td class="gutter">
  744. <div class="line n1">1</div>
  745. <div class="line n2">2</div>
  746. <div class="line n3">3</div>
  747. </td>
  748. <td class="code">
  749. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).droppable({</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>
  750. </td>
  751. </tr>
  752. </tbody>
  753. </table>
  754. </div>
  755. <p>Bind an event listener to the dropcreate event:</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> ).on( <span class="string">"dropcreate"</span>, <span class="keyword">function</span>( event, ui ) {} );</code></div></div></pre>
  765. </td>
  766. </tr>
  767. </tbody>
  768. </table>
  769. </div>
  770. </div>
  771. </div>
  772. <div id="event-deactivate" class="api-item">
  773. <h3>deactivate( event, ui )<span class="returns">Type: <code>dropdeactivate</code></span>
  774. </h3>
  775. <div>Triggered when an accepted draggable stops dragging.</div>
  776. <ul>
  777. <li>
  778. <div><strong>event</strong></div>
  779. <div>Type: <a href="http://api.jquery.com/Types/#Event">Event</a>
  780. </div>
  781. <div></div>
  782. </li>
  783. <li>
  784. <div><strong>ui</strong></div>
  785. <div>Type: <a href="http://api.jquery.com/Types/#Object">Object</a>
  786. </div>
  787. <div></div>
  788. <ul>
  789. <li>
  790. <div><strong>draggable</strong></div>
  791. <div>Type: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a>
  792. </div>
  793. <div>A jQuery object representing the draggable element.</div>
  794. </li>
  795. <li>
  796. <div><strong>helper</strong></div>
  797. <div>Type: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a>
  798. </div>
  799. <div>A jQuery object representing the helper that is being dragged.</div>
  800. </li>
  801. <li>
  802. <div><strong>position</strong></div>
  803. <div>Type: <a href="http://api.jquery.com/Types/#Object">Object</a>
  804. </div>
  805. <div>Current CSS position of the draggable helper as <code>{ top, left }</code> object.</div>
  806. </li>
  807. <li>
  808. <div><strong>offset</strong></div>
  809. <div>Type: <a href="http://api.jquery.com/Types/#Object">Object</a>
  810. </div>
  811. <div>Current offset position of the draggable helper as <code>{ top, left }</code> object.</div>
  812. </li>
  813. </ul>
  814. </li>
  815. </ul>
  816. <div>
  817. <strong>Code examples:</strong><p>Initialize the droppable with the deactivate callback specified:</p>
  818. <div class="syntaxhighlighter javascript nogutter">
  819. <table>
  820. <tbody>
  821. <tr>
  822. <td class="gutter">
  823. <div class="line n1">1</div>
  824. <div class="line n2">2</div>
  825. <div class="line n3">3</div>
  826. </td>
  827. <td class="code">
  828. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).droppable({</code></div></div><div class="container"><div class="line"><code> deactivate: <span class="keyword">function</span>( event, ui ) {}</code></div></div><div class="container"><div class="line"><code>});</code></div></div></pre>
  829. </td>
  830. </tr>
  831. </tbody>
  832. </table>
  833. </div>
  834. <p>Bind an event listener to the dropdeactivate event:</p>
  835. <div class="syntaxhighlighter javascript nogutter">
  836. <table>
  837. <tbody>
  838. <tr>
  839. <td class="gutter">
  840. <div class="line n1">1</div>
  841. </td>
  842. <td class="code">
  843. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).on( <span class="string">"dropdeactivate"</span>, <span class="keyword">function</span>( event, ui ) {} );</code></div></div></pre>
  844. </td>
  845. </tr>
  846. </tbody>
  847. </table>
  848. </div>
  849. </div>
  850. </div>
  851. <div id="event-drop" class="api-item">
  852. <h3>drop( event, ui )<span class="returns">Type: <code>drop</code></span>
  853. </h3>
  854. <div>Triggered when an accepted draggable is dropped on the droppable (based on the<a href="#option-tolerance"><code>tolerance</code></a> option).</div>
  855. <ul>
  856. <li>
  857. <div><strong>event</strong></div>
  858. <div>Type: <a href="http://api.jquery.com/Types/#Event">Event</a>
  859. </div>
  860. <div></div>
  861. </li>
  862. <li>
  863. <div><strong>ui</strong></div>
  864. <div>Type: <a href="http://api.jquery.com/Types/#Object">Object</a>
  865. </div>
  866. <div></div>
  867. <ul>
  868. <li>
  869. <div><strong>draggable</strong></div>
  870. <div>Type: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a>
  871. </div>
  872. <div>A jQuery object representing the draggable element.</div>
  873. </li>
  874. <li>
  875. <div><strong>helper</strong></div>
  876. <div>Type: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a>
  877. </div>
  878. <div>A jQuery object representing the helper that is being dragged.</div>
  879. </li>
  880. <li>
  881. <div><strong>position</strong></div>
  882. <div>Type: <a href="http://api.jquery.com/Types/#Object">Object</a>
  883. </div>
  884. <div>Current CSS position of the draggable helper as <code>{ top, left }</code> object.</div>
  885. </li>
  886. <li>
  887. <div><strong>offset</strong></div>
  888. <div>Type: <a href="http://api.jquery.com/Types/#Object">Object</a>
  889. </div>
  890. <div>Current offset position of the draggable helper as <code>{ top, left }</code> object.</div>
  891. </li>
  892. </ul>
  893. </li>
  894. </ul>
  895. <div>
  896. <strong>Code examples:</strong><p>Initialize the droppable with the drop callback specified:</p>
  897. <div class="syntaxhighlighter javascript nogutter">
  898. <table>
  899. <tbody>
  900. <tr>
  901. <td class="gutter">
  902. <div class="line n1">1</div>
  903. <div class="line n2">2</div>
  904. <div class="line n3">3</div>
  905. </td>
  906. <td class="code">
  907. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).droppable({</code></div></div><div class="container"><div class="line"><code> drop: <span class="keyword">function</span>( event, ui ) {}</code></div></div><div class="container"><div class="line"><code>});</code></div></div></pre>
  908. </td>
  909. </tr>
  910. </tbody>
  911. </table>
  912. </div>
  913. <p>Bind an event listener to the drop event:</p>
  914. <div class="syntaxhighlighter javascript nogutter">
  915. <table>
  916. <tbody>
  917. <tr>
  918. <td class="gutter">
  919. <div class="line n1">1</div>
  920. </td>
  921. <td class="code">
  922. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).on( <span class="string">"drop"</span>, <span class="keyword">function</span>( event, ui ) {} );</code></div></div></pre>
  923. </td>
  924. </tr>
  925. </tbody>
  926. </table>
  927. </div>
  928. </div>
  929. </div>
  930. <div id="event-out" class="api-item">
  931. <h3>out( event, ui )<span class="returns">Type: <code>dropout</code></span>
  932. </h3>
  933. <div>Triggered when an accepted draggable is dragged out of the droppable (based on the<a href="#option-tolerance"><code>tolerance</code></a> option).</div>
  934. <ul>
  935. <li>
  936. <div><strong>event</strong></div>
  937. <div>Type: <a href="http://api.jquery.com/Types/#Event">Event</a>
  938. </div>
  939. <div></div>
  940. </li>
  941. <li>
  942. <div><strong>ui</strong></div>
  943. <div>Type: <a href="http://api.jquery.com/Types/#Object">Object</a>
  944. </div>
  945. <div></div>
  946. </li>
  947. </ul>
  948. <p><em>Note: The <code>ui</code> object is empty but included for consistency with other events.</em></p>
  949. <div>
  950. <strong>Code examples:</strong><p>Initialize the droppable with the out callback specified:</p>
  951. <div class="syntaxhighlighter javascript nogutter">
  952. <table>
  953. <tbody>
  954. <tr>
  955. <td class="gutter">
  956. <div class="line n1">1</div>
  957. <div class="line n2">2</div>
  958. <div class="line n3">3</div>
  959. </td>
  960. <td class="code">
  961. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).droppable({</code></div></div><div class="container"><div class="line"><code> out: <span class="keyword">function</span>( event, ui ) {}</code></div></div><div class="container"><div class="line"><code>});</code></div></div></pre>
  962. </td>
  963. </tr>
  964. </tbody>
  965. </table>
  966. </div>
  967. <p>Bind an event listener to the dropout event:</p>
  968. <div class="syntaxhighlighter javascript nogutter">
  969. <table>
  970. <tbody>
  971. <tr>
  972. <td class="gutter">
  973. <div class="line n1">1</div>
  974. </td>
  975. <td class="code">
  976. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).on( <span class="string">"dropout"</span>, <span class="keyword">function</span>( event, ui ) {} );</code></div></div></pre>
  977. </td>
  978. </tr>
  979. </tbody>
  980. </table>
  981. </div>
  982. </div>
  983. </div>
  984. <div id="event-over" class="api-item">
  985. <h3>over( event, ui )<span class="returns">Type: <code>dropover</code></span>
  986. </h3>
  987. <div>Triggered when an accepted draggable is dragged over the droppable (based on the<a href="#option-tolerance"><code>tolerance</code></a> option).</div>
  988. <ul>
  989. <li>
  990. <div><strong>event</strong></div>
  991. <div>Type: <a href="http://api.jquery.com/Types/#Event">Event</a>
  992. </div>
  993. <div></div>
  994. </li>
  995. <li>
  996. <div><strong>ui</strong></div>
  997. <div>Type: <a href="http://api.jquery.com/Types/#Object">Object</a>
  998. </div>
  999. <div></div>
  1000. <ul>
  1001. <li>
  1002. <div><strong>draggable</strong></div>
  1003. <div>Type: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a>
  1004. </div>
  1005. <div>A jQuery object representing the draggable element.</div>
  1006. </li>
  1007. <li>
  1008. <div><strong>helper</strong></div>
  1009. <div>Type: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a>
  1010. </div>
  1011. <div>A jQuery object representing the helper that is being dragged.</div>
  1012. </li>
  1013. <li>
  1014. <div><strong>position</strong></div>
  1015. <div>Type: <a href="http://api.jquery.com/Types/#Object">Object</a>
  1016. </div>
  1017. <div>Current CSS position of the draggable helper as <code>{ top, left }</code> object.</div>
  1018. </li>
  1019. <li>
  1020. <div><strong>offset</strong></div>
  1021. <div>Type: <a href="http://api.jquery.com/Types/#Object">Object</a>
  1022. </div>
  1023. <div>Current offset position of the draggable helper as <code>{ top, left }</code> object.</div>
  1024. </li>
  1025. </ul>
  1026. </li>
  1027. </ul>
  1028. <div>
  1029. <strong>Code examples:</strong><p>Initialize the droppable with the over callback specified:</p>
  1030. <div class="syntaxhighlighter javascript nogutter">
  1031. <table>
  1032. <tbody>
  1033. <tr>
  1034. <td class="gutter">
  1035. <div class="line n1">1</div>
  1036. <div class="line n2">2</div>
  1037. <div class="line n3">3</div>
  1038. </td>
  1039. <td class="code">
  1040. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).droppable({</code></div></div><div class="container"><div class="line"><code> over: <span class="keyword">function</span>( event, ui ) {}</code></div></div><div class="container"><div class="line"><code>});</code></div></div></pre>
  1041. </td>
  1042. </tr>
  1043. </tbody>
  1044. </table>
  1045. </div>
  1046. <p>Bind an event listener to the dropover event:</p>
  1047. <div class="syntaxhighlighter javascript nogutter">
  1048. <table>
  1049. <tbody>
  1050. <tr>
  1051. <td class="gutter">
  1052. <div class="line n1">1</div>
  1053. </td>
  1054. <td class="code">
  1055. <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).on( <span class="string">"dropover"</span>, <span class="keyword">function</span>( event, ui ) {} );</code></div></div></pre>
  1056. </td>
  1057. </tr>
  1058. </tbody>
  1059. </table>
  1060. </div>
  1061. </div>
  1062. </div></section><section class="entry-examples" id="entry-examples"><header><h2>Example:</h2></header><div class="entry-example" id="example-0">
  1063. <h4><span class="desc">A pair of draggable and droppable elements.</span></h4>
  1064. <div class="syntaxhighlighter xml ">
  1065. <table>
  1066. <tbody>
  1067. <tr>
  1068. <td class="gutter">
  1069. <div class="line n1">1</div>
  1070. <div class="line n2">2</div>
  1071. <div class="line n3">3</div>
  1072. <div class="line n4">4</div>
  1073. <div class="line n5">5</div>
  1074. <div class="line n6">6</div>
  1075. <div class="line n7">7</div>
  1076. <div class="line n8">8</div>
  1077. <div class="line n9">9</div>
  1078. <div class="line n10">10</div>
  1079. <div class="line n11">11</div>
  1080. <div class="line n12">12</div>
  1081. <div class="line n13">13</div>
  1082. <div class="line n14">14</div>
  1083. <div class="line n15">15</div>
  1084. <div class="line n16">16</div>
  1085. <div class="line n17">17</div>
  1086. <div class="line n18">18</div>
  1087. <div class="line n19">19</div>
  1088. <div class="line n20">20</div>
  1089. <div class="line n21">21</div>
  1090. <div class="line n22">22</div>
  1091. <div class="line n23">23</div>
  1092. <div class="line n24">24</div>
  1093. <div class="line n25">25</div>
  1094. <div class="line n26">26</div>
  1095. <div class="line n27">27</div>
  1096. <div class="line n28">28</div>
  1097. <div class="line n29">29</div>
  1098. <div class="line n30">30</div>
  1099. <div class="line n31">31</div>
  1100. <div class="line n32">32</div>
  1101. <div class="line n33">33</div>
  1102. <div class="line n34">34</div>
  1103. <div class="line n35">35</div>
  1104. <div class="line n36">36</div>
  1105. <div class="line n37">37</div>
  1106. <div class="line n38">38</div>
  1107. <div class="line n39">39</div>
  1108. <div class="line n40">40</div>
  1109. <div class="line n41">41</div>
  1110. <div class="line n42">42</div>
  1111. </td>
  1112. <td class="code">
  1113. <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>droppable 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="id">#droppable</span> <span class="rules">{</span></code></div></div><div class="container"><div class="line"><code> <span class="rule"><span class="attribute">position</span>:<span class="value"> absolute;</span></span></code></div></div><div class="container"><div class="line"><code> <span class="rule"><span class="attribute">left</span>:<span class="value"> <span class="number">250</span>px;</span></span></code></div></div><div class="container"><div class="line"><code> <span class="rule"><span class="attribute">top</span>:<span class="value"> <span class="number">0</span>;</span></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">125</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">125</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">#999</span>;</span></span></code></div></div><div class="container"><div class="line"><code> <span class="rule"><span class="attribute">color</span>:<span class="value"> <span class="hexcolor">#fff</span>;</span></span></code></div></div><div class="container"><div class="line"><code> <span class="rule"><span class="attribute">padding</span>:<span class="value"> <span class="number">10</span>px;</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">"droppable"</span>&gt;</span>Drop here<span class="tag">&lt;/<span class="title">div</span>&gt;</span></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="string">"#droppable"</span> ).droppable({</code></div></div><div class="container"><div class="line"><code> drop: <span class="keyword">function</span>() {</code></div></div><div class="container"><div class="line"><code> alert( <span class="string">"dropped"</span> );</code></div></div><div class="container"><div class="line"><code> }</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></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>
  1114. </td>
  1115. </tr>
  1116. </tbody>
  1117. </table>
  1118. </div>
  1119. <h4>Demo:</h4>
  1120. <div class="demo code-demo"></div>
  1121. </div></section>
  1122. </div></article>
  1123. </body>
  1124. </html>