Skip to content

Commit 40b71d7

Browse files
committed
Added Beginning of Documentation
1 parent 49d4304 commit 40b71d7

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

docs/doc.html

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
<h3>Option</h3>
2+
<h4>add <em>boolean (true)</em></h4>
3+
<p>Apparently this option doesnt do anything, but it should enable or disable the ability to add items to a listable list.</p>
4+
<h4>add_after <em>boolean (true)</em></h4>
5+
<p>Apparently this option is broken, but if false, it should add the listable item before the field divider instead of after.</p>
6+
<h4>add_image <em>filepath ("/javascripts/listable/images/add.png")</em></h4>
7+
<p>Sets the file path for the add icon.</p>
8+
<h4>auto_build <em>boolean (true)</em></h4>
9+
<p>When true, auto_build will tell listable to build out the listable based on the hidden inputs. Leaving this as 'true' is highly recommended.</p>
10+
<h4>connectWith <em>selector ('')</em></h4>
11+
<p>This option is identical to the <a href="http://api.jqueryui.com/sortable/#option-connectWith">connectWith option for sortable</a>. It is a selector for other listable elements with which this listable should be connected to. It is a one-way relationship.</p>
12+
<h4>controls <em>boolean (true)</em></h4>
13+
<p>A boolean which turns on or off the listable controls. When false, the controls are not generated.</p>
14+
<h4>delete <em>boolean (true)</em></h4>
15+
<p>A boolean which turns on or off a listable's ability to delete items.</p>
16+
<h4>delete_confirmation <em>boolean (false)</em></h4>
17+
<p>A boolean which turns on or off a warning when deleting an item.</p>
18+
<h4>delete_image <em>filepath ("/javascripts/listable/images/delete.png")</em></h4>
19+
<p>Sets the file path for the delete icon.</p>
20+
<h4>depth <em>boolean (false)</em></h4>
21+
<p>A boolean which turns on or off the depth attribute for the listable items.</p>
22+
<h4>deeper_image <em>filepath ("/javascripts/listable/images/right_arrow.png")</em></h4>
23+
<p>Sets the file path for the deeper icon.</p>
24+
<h4>edit <em>boolean (true)</em></h4>
25+
<p>A boolean which turns on or off a listable's ability to edit items.</p>
26+
<h4>edit_image <em>filepath ("/javascripts/listable/images/edit.png")</em></h4>
27+
<p>Sets the file path for the edit icon.</p>
28+
<h4>fancybox_padding <em>integer (null)</em></h4>
29+
<p>Sets the padding amount between the FancyBox wrapper and its content.</p>
30+
<h4>field_dividers_enabled <em>boolean (true)</em></h4>
31+
<p>Sets the padding amount between the FancyBox wrapper and its content.</p>
32+
33+
<h3>Public variables</h3>
34+
<h4>$.fn.listable.current_listable</h4>
35+
<p>Sets the current_listable. Useful when saving changes to a listable on a page with multiple listables.</p>
36+
<h3>Methods</h3>
37+
<p>save(itemType [, option1, option2])</p>
38+
<p>&nbsp;</p>
39+
<p style="padding-left: 30px;">&nbsp;</p>

0 commit comments

Comments
 (0)