Skip to content

Commit a4cccc1

Browse files
committed
docs: options improvements
1 parent 13c3b3d commit a4cccc1

File tree

1 file changed

+18
-8
lines changed

1 file changed

+18
-8
lines changed

docs/options.php

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,20 +40,30 @@
4040

4141
<h2>Field options</h2>
4242
<dl>
43-
<dt>hint</dt>
44-
<dd>Description of the field</dd>
45-
<dt>confirm</dt>
46-
<dd>Buttons: adds a javascript confirmation prompt before submit/click</dd>
43+
<dt>hint <span class="label label-default">string</span></dt>
44+
<dd>Description of the field. (default: none)</dd>
4745
<dt>Other</dt>
4846
<dd>All other attributes is passed directly to field, allowing custom attributes such as <code>placeholder</code>, <code>title</code>, etc.</dd>
4947
</dl>
5048

5149
<h3 id="upload-field">Upload field</h3>
5250
<dl>
53-
<dt>remove</dt>
54-
<dd>Adds a removal checkbox (e.g. a user avatar which is set if file is uploaded but retained if nothing is sent and removed if checkbox is checked)</dd>
55-
<dt>current</dt>
56-
<dd>HTML to preview the current uploaded data, e.g. <code>&lt;img src="/user/123/avatar.png"/&gt;</code></dd>
51+
<dt>remove <span class="label label-default">boolean</span></dt>
52+
<dd>Adds a removal checkbox (e.g. a user avatar which is set if file is uploaded but retained if nothing is sent and removed if checkbox is checked) (default: false)</dd>
53+
<dt>current <span class="label label-default">html</span></dt>
54+
<dd>HTML to preview the current uploaded data, e.g. <code>&lt;img src="/user/123/avatar.png"/&gt;</code>. (default: none)</dd>
55+
</dl>
56+
57+
<h3 id="button">Button</h3>
58+
<dl>
59+
<dt>confirm <span class="label label-default">string</span></dt>
60+
<dd>Adds a javascript confirmation prompt before submit/click. (default: none)</dd>
61+
</dl>
62+
63+
<h3 id="select">Select</h3>
64+
<dl>
65+
<dt>postback <span class="label label-default">boolean</span></dt>
66+
<dd>Automatically submit form when value changes. (default: false)</dd>
5767
</dl>
5868

5969
<h2>Serialization</h2>

0 commit comments

Comments
 (0)