Skip to content

Commit 559bf32

Browse files
petersendiditscottgonzalez
authored andcommitted
Sortable: Document options for toArray(). Fixes #79.
1 parent a4cd708 commit 559bf32

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

entries/sortable.xml

+6
Original file line numberDiff line numberDiff line change
@@ -462,6 +462,12 @@
462462
</method>
463463
<method name="toArray" return="Array" example-return-var="sortedIDs">
464464
<desc>Serializes the sortable's item id's into an array of string.</desc>
465+
<argument name="options" type="Object">
466+
<desc>Options to customize the serialization.</desc>
467+
<property name="attribute" type="String" default='"id"'>
468+
<desc>The name of the attribute to use for the values.</desc>
469+
</property>
470+
</argument>
465471
</method>
466472
<xi:include href="../includes/widget-method-widget.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
467473
</methods>

0 commit comments

Comments
 (0)