Skip to content

Sortable events: Consolidating and documenting the placeholder property #147

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

Sortable events: Consolidating and documenting the placeholder property #147

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9bc937e
Sortable: Consolidating duplicated ui argument of events into a commo…
tjvantoll Jun 12, 2013
3b82987
Sortable: Document the placeholder property in the ui argument of eve…
tjvantoll Jun 12, 2013
03ca5f0
Sortable: Consistent formatting of ui argument property descriptions.
tjvantoll Jun 12, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
252 changes: 12 additions & 240 deletions entries/sortable.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,293 +139,65 @@
<event name="start">
<desc>This event is triggered when sorting starts.</desc>
<argument name="event" type="Event"/>
<argument name="ui" type="Object">
<property name="helper" type="jQuery">
<desc>The jQuery object representing the helper being sorted</desc>
</property>
<property name="item" type="jQuery">
<desc>The jQuery object representing the current dragged element</desc>
</property>
<property name="offset" type="Object">
<desc>The current absolute position of the helper represented as <code>{ top, left }</code></desc>
</property>
<property name="position" type="Object">
<desc>The current position of the helper represented as <code>{ top, left }</code></desc>
</property>
<property name="originalPosition" type="Object">
<desc>The original position of the element represented as <code>{ top, left }</code></desc>
</property>
<property name="sender" type="jQuery">
<desc>The sortable that the item comes from if moving from one sortable to another</desc>
</property>
</argument>
<xi:include href="../includes/sortable-argument-ui.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
</event>
<event name="sort">
<desc>This event is triggered during sorting.</desc>
<argument name="event" type="Event"/>
<argument name="ui" type="Object">
<property name="helper" type="jQuery">
<desc>The jQuery object representing the helper being sorted</desc>
</property>
<property name="item" type="jQuery">
<desc>The jQuery object representing the current dragged element</desc>
</property>
<property name="offset" type="Object">
<desc>The current absolute position of the helper represented as <code>{ top, left }</code></desc>
</property>
<property name="position" type="Object">
<desc>The current position of the helper represented as <code>{ top, left }</code></desc>
</property>
<property name="originalPosition" type="Object">
<desc>The original position of the element represented as <code>{ top, left }</code></desc>
</property>
<property name="sender" type="jQuery">
<desc>The sortable that the item comes from if moving from one sortable to another</desc>
</property>
</argument>
<xi:include href="../includes/sortable-argument-ui.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
</event>
<event name="change">
<desc>This event is triggered during sorting, but only when the DOM position has changed.</desc>
<argument name="event" type="Event"/>
<argument name="ui" type="Object">
<property name="helper" type="jQuery">
<desc>The jQuery object representing the helper being sorted</desc>
</property>
<property name="item" type="jQuery">
<desc>The jQuery object representing the current dragged element</desc>
</property>
<property name="offset" type="Object">
<desc>The current absolute position of the helper represented as <code>{ top, left }</code></desc>
</property>
<property name="position" type="Object">
<desc>The current position of the helper represented as <code>{ top, left }</code></desc>
</property>
<property name="originalPosition" type="Object">
<desc>The original position of the element represented as <code>{ top, left }</code></desc>
</property>
<property name="sender" type="jQuery">
<desc>The sortable that the item comes from if moving from one sortable to another</desc>
</property>
</argument>
<xi:include href="../includes/sortable-argument-ui.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
</event>
<event name="beforeStop">
<desc>This event is triggered when sorting stops, but when the placeholder/helper is still available.</desc>
<argument name="event" type="Event"/>
<argument name="ui" type="Object">
<property name="helper" type="jQuery">
<desc>The jQuery object representing the helper being sorted</desc>
</property>
<property name="item" type="jQuery">
<desc>The jQuery object representing the current dragged element</desc>
</property>
<property name="offset" type="Object">
<desc>The current absolute position of the helper represented as <code>{ top, left }</code></desc>
</property>
<property name="position" type="Object">
<desc>The current position of the helper represented as <code>{ top, left }</code></desc>
</property>
<property name="originalPosition" type="Object">
<desc>The original position of the element represented as <code>{ top, left }</code></desc>
</property>
<property name="sender" type="jQuery">
<desc>The sortable that the item comes from if moving from one sortable to another</desc>
</property>
</argument>
<xi:include href="../includes/sortable-argument-ui.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
</event>
<event name="stop">
<desc>This event is triggered when sorting has stopped.</desc>
<argument name="event" type="Event"/>
<argument name="ui" type="Object">
<property name="helper" type="jQuery">
<desc>The jQuery object representing the helper being sorted</desc>
</property>
<property name="item" type="jQuery">
<desc>The jQuery object representing the current dragged element</desc>
</property>
<property name="offset" type="Object">
<desc>The current absolute position of the helper represented as <code>{ top, left }</code></desc>
</property>
<property name="position" type="Object">
<desc>The current position of the helper represented as <code>{ top, left }</code></desc>
</property>
<property name="originalPosition" type="Object">
<desc>The original position of the element represented as <code>{ top, left }</code></desc>
</property>
<property name="sender" type="jQuery">
<desc>The sortable that the item comes from if moving from one sortable to another</desc>
</property>
</argument>
<xi:include href="../includes/sortable-argument-ui.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
</event>
<event name="update">
<desc>This event is triggered when the user stopped sorting and the DOM position has changed.</desc>
<argument name="event" type="Event"/>
<argument name="ui" type="Object">
<property name="helper" type="jQuery">
<desc>The jQuery object representing the helper being sorted</desc>
</property>
<property name="item" type="jQuery">
<desc>The jQuery object representing the current dragged element</desc>
</property>
<property name="offset" type="Object">
<desc>The current absolute position of the helper represented as <code>{ top, left }</code></desc>
</property>
<property name="position" type="Object">
<desc>The current position of the helper represented as <code>{ top, left }</code></desc>
</property>
<property name="originalPosition" type="Object">
<desc>The original position of the element represented as <code>{ top, left }</code></desc>
</property>
<property name="sender" type="jQuery">
<desc>The sortable that the item comes from if moving from one sortable to another</desc>
</property>
</argument>
<xi:include href="../includes/sortable-argument-ui.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
</event>
<event name="receive">
<desc>This event is triggered when a connected sortable list has received an item from another list.</desc>
<argument name="event" type="Event"/>
<argument name="ui" type="Object">
<property name="helper" type="jQuery">
<desc>The jQuery object representing the helper being sorted</desc>
</property>
<property name="item" type="jQuery">
<desc>The jQuery object representing the current dragged element</desc>
</property>
<property name="offset" type="Object">
<desc>The current absolute position of the helper represented as <code>{ top, left }</code></desc>
</property>
<property name="position" type="Object">
<desc>The current position of the helper represented as <code>{ top, left }</code></desc>
</property>
<property name="originalPosition" type="Object">
<desc>The original position of the element represented as <code>{ top, left }</code></desc>
</property>
<property name="sender" type="jQuery">
<desc>The sortable that the item comes from if moving from one sortable to another</desc>
</property>
</argument>
<xi:include href="../includes/sortable-argument-ui.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
</event>
<event name="remove">
<desc>This event is triggered when a sortable item has been dragged out from the list and into another.</desc>
<argument name="event" type="Event"/>
<argument name="ui" type="Object">
<property name="helper" type="jQuery">
<desc>The jQuery object representing the helper being sorted</desc>
</property>
<property name="item" type="jQuery">
<desc>The jQuery object representing the current dragged element</desc>
</property>
<property name="offset" type="Object">
<desc>The current absolute position of the helper represented as <code>{ top, left }</code></desc>
</property>
<property name="position" type="Object">
<desc>The current position of the helper represented as <code>{ top, left }</code></desc>
</property>
<property name="originalPosition" type="Object">
<desc>The original position of the element represented as <code>{ top, left }</code></desc>
</property>
<property name="sender" type="jQuery">
<desc>The sortable that the item comes from if moving from one sortable to another</desc>
</property>
</argument>
<xi:include href="../includes/sortable-argument-ui.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
</event>
<event name="over">
<desc>This event is triggered when a sortable item is moved into a sortable list.</desc>
<argument name="event" type="Event"/>
<argument name="ui" type="Object">
<property name="helper" type="jQuery">
<desc>The jQuery object representing the helper being sorted</desc>
</property>
<property name="item" type="jQuery">
<desc>The jQuery object representing the current dragged element</desc>
</property>
<property name="offset" type="Object">
<desc>The current absolute position of the helper represented as <code>{ top, left }</code></desc>
</property>
<property name="position" type="Object">
<desc>The current position of the helper represented as <code>{ top, left }</code></desc>
</property>
<property name="originalPosition" type="Object">
<desc>The original position of the element represented as <code>{ top, left }</code></desc>
</property>
<property name="sender" type="jQuery">
<desc>The sortable that the item comes from if moving from one sortable to another</desc>
</property>
</argument>
<xi:include href="../includes/sortable-argument-ui.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
</event>
<event name="out">
<desc>
<p>This event is triggered when a sortable item is moved away from a sortable list.</p>
<p><em>Note: This event is also triggered when a sortable item is dropped.</em></p>
</desc>
<argument name="event" type="Event"/>
<argument name="ui" type="Object">
<property name="helper" type="jQuery">
<desc>The jQuery object representing the helper being sorted</desc>
</property>
<property name="item" type="jQuery">
<desc>The jQuery object representing the current dragged element</desc>
</property>
<property name="offset" type="Object">
<desc>The current absolute position of the helper represented as <code>{ top, left }</code></desc>
</property>
<property name="position" type="Object">
<desc>The current position of the helper represented as <code>{ top, left }</code></desc>
</property>
<property name="originalPosition" type="Object">
<desc>The original position of the element represented as <code>{ top, left }</code></desc>
</property>
<property name="sender" type="jQuery">
<desc>The sortable that the item comes from if moving from one sortable to another</desc>
</property>
</argument>
<xi:include href="../includes/sortable-argument-ui.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
</event>
<event name="activate">
<desc>This event is triggered when using connected lists, every connected list on drag start receives it.</desc>
<argument name="event" type="Event"/>
<argument name="ui" type="Object">
<property name="helper" type="jQuery">
<desc>The jQuery object representing the helper being sorted</desc>
</property>
<property name="item" type="jQuery">
<desc>The jQuery object representing the current dragged element</desc>
</property>
<property name="offset" type="Object">
<desc>The current absolute position of the helper represented as <code>{ top, left }</code></desc>
</property>
<property name="position" type="Object">
<desc>The current position of the helper represented as <code>{ top, left }</code></desc>
</property>
<property name="originalPosition" type="Object">
<desc>The original position of the element represented as <code>{ top, left }</code></desc>
</property>
<property name="sender" type="jQuery">
<desc>The sortable that the item comes from if moving from one sortable to another</desc>
</property>
</argument>
<xi:include href="../includes/sortable-argument-ui.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
</event>
<event name="deactivate">
<desc>This event is triggered when sorting was stopped, is propagated to all possible connected lists.</desc>
<argument name="event" type="Event"/>
<argument name="ui" type="Object">
<property name="helper" type="jQuery">
<desc>The jQuery object representing the helper being sorted</desc>
</property>
<property name="item" type="jQuery">
<desc>The jQuery object representing the current dragged element</desc>
</property>
<property name="offset" type="Object">
<desc>The current absolute position of the helper represented as <code>{ top, left }</code></desc>
</property>
<property name="position" type="Object">
<desc>The current position of the helper represented as <code>{ top, left }</code></desc>
</property>
<property name="originalPosition" type="Object">
<desc>The original position of the element represented as <code>{ top, left }</code></desc>
</property>
<property name="sender" type="jQuery">
<desc>The sortable that the item comes from if moving from one sortable to another</desc>
</property>
</argument>
<xi:include href="../includes/sortable-argument-ui.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
</event>
</events>
<methods>
Expand Down
23 changes: 23 additions & 0 deletions includes/sortable-argument-ui.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<argument name="ui" type="Object">
<property name="helper" type="jQuery">
<desc>The jQuery object representing the helper being sorted.</desc>
</property>
<property name="item" type="jQuery">
<desc>The jQuery object representing the current dragged element.</desc>
</property>
<property name="offset" type="Object">
<desc>The current absolute position of the helper represented as <code>{ top, left }</code>.</desc>
</property>
<property name="position" type="Object">
<desc>The current position of the helper represented as <code>{ top, left }</code>.</desc>
</property>
<property name="originalPosition" type="Object">
<desc>The original position of the element represented as <code>{ top, left }</code>.</desc>
</property>
<property name="sender" type="jQuery">
<desc>The sortable that the item comes from if moving from one sortable to another.</desc>
</property>
<property name="placeholder" type="jQuery">
<desc>The jQuery object representing the element being used as a placeholder.</desc>
</property>
</argument>