Skip to content

Commit c58debb

Browse files
committed
Droppable: Added option examples.
1 parent fd0635d commit c58debb

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

entries/droppable.xml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
</longdesc>
88
<added>1.0</added>
99
<options>
10-
<option name="accept" default='"*"'>
10+
<option name="accept" default='"*"' example-value='".special"'>
1111
<desc>Controls which draggable elements are accepted by the droppable.</desc>
1212
<type name="Selector">
1313
<desc>A selector indicating which draggable elements are accepted.</desc>
@@ -16,23 +16,23 @@
1616
<desc>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.</desc>
1717
</type>
1818
</option>
19-
<option name="activeClass" type="String" default="false">
19+
<option name="activeClass" type="String" default="false" example-value='"ui-state-highlight"'>
2020
<desc>If specified, the class will be added to the droppable while an acceptable draggable is being dragged.</desc>
2121
</option>
22-
<option name="addClasses" type="Boolean" default="true">
22+
<option name="addClasses" type="Boolean" default="true" example-value="false">
2323
<desc>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.</desc>
2424
</option>
2525
<xi:include href="../includes/widget-option-disabled.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
26-
<option name="greedy" type="Boolean" default="false">
26+
<option name="greedy" type="Boolean" default="false" example-value="true">
2727
<desc>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.</desc>
2828
</option>
29-
<option name="hoverClass" type="String" default="false">
29+
<option name="hoverClass" type="String" default="false" example-value='"drop-hover"'>
3030
<desc>If specified, the class will be added to the droppable while an acceptable draggable is being hovered over the droppable.</desc>
3131
</option>
32-
<option name="scope" type="String" default='"default"'>
32+
<option name="scope" type="String" default='"default"' example-value='"tasks"'>
3333
<desc>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.</desc>
3434
</option>
35-
<option name="tolerance" type="String" default='"intersect"'>
35+
<option name="tolerance" type="String" default='"intersect"' example-value='"fit"'>
3636
<desc>
3737
Specifies which mode to use for testing whether a draggable is hovering over a droppable. Possible values:
3838
<ul>

0 commit comments

Comments
 (0)