Changes between Version 21 and Version 22 of S3/FilterForms

Timestamp:

03/27/13 11:02:43 (12 years ago)

Author:

Dominic König

Comment:

--

S3/FilterForms

@@ -73 +73 @@
 === S3OptionsFilter ===
 
-  * tbw
+S3TextFilter renders checkboxes to select pre-determined options for a field in the resource.
 
+{{{
+instance = S3OptionsFilter(field, _class="class", _name="name", options=None, represent=None, widget=None)
+}}}
+
+Parameters:
+
+  - '''field''' is a field selector (or a list of field selectors) for the field(s) to filter by
+
+Options:
+
+  - '''options''' is a dict {value:label} of options for the widget, or a callable that returns such a dict
+  - '''represent''' is a callable to render a label for each option
+  - '''widget''' selects the widget, either "checkboxes" (S3 grouped checkboxes, default) or "multiselect" (jQuery UI Multiselect-Dropdown by Eric Hynds) or "multiselect-bootstrap" (Bootstrap Multiselect-Dropdown)
+  - '''comment''' is a help text or tooltip widget to render with the filter widget
+
+HTML Attributes:
+
+  - '''_class''' is the CSS class for the input field
+  - '''_size''' is the input field width in characters
+  - '''_name''' is a name for the input field
+
+Note: if no '''options''' are specified, the widget will determine the options from the field (=all unique values for this field currently available in the DB)
+Note: if no '''represent''' is specified, the widget will use the labels specified in '''options''', or otherwise use the field representation function
+Note: if the field is a foreign key, then '''represent''' can also be a string template for the referenced rows
 === S3DateFilter ===