Changes between Version 12 and Version 13 of S3/FilterForms

Timestamp:

03/27/13 09:49:45 (12 years ago)

Author:

Dominic König

Comment:

--

S3/FilterForms

@@ -28 +28 @@
 == Filter Forms ==
 
-  * ''tbw''
+=== Configuration of Filter Forms in S3CRUD ===
 
+S3CRUD has filter forms integrated in the /datatable and /datalist pages.
+
+For these pages, the filter widgets are configured per resource with the "filter_widgets"-setting like:
+
+{{{
+s3db.configure(tablename,
+               filter_widgets=[
+                 S3TextFilter(["name", "email", "comments"],
+                              label=T("Search"),
+                              comment=T("Search for office by text.")),
+                 S3OptionsFilter("organisation_id",
+                                 label=messages.ORGANISATION,
+                                 comment=T("Search for office by organization."),
+                                 represent="%(name)s",
+                                 widget="multiselect"),
+                 S3OptionsFilter("location_id$L1",
+                                 location_level="L1",
+                                 widget="multiselect")
+               ])
+}}}
+
+The widgets appear in the form in list order.
+
+Additionally, there are a number of controller options for the s3_rest_controller call:
+
+{{{
+output = s3_rest_controller(prefix, resourcename,
+                            filter_submit_url = submit_url,
+                            filter_ajax_url = ajax_url,
+                            filter_formstyle = formstyle,
+                            filter_submit = submit
+                           )
+}}}
+
+||'''Option'''||'''Type'''||'''Function'''||'''Default'''||
+||filter_submit_url||URL string||where to request filtered data from||URL of the current call||
+||filter_ajax_url||URL string||where to request updated filter options from||URL of the current call with /filter method||
+||filter_formstyle||Formstyle function||Alternative formstyle for the filter form||built-in formstyle||
+||filter_submit||String||Label for the submit button or tupel of (label, class) to also specify a CSS class for the button||T("Search")||
 == Development ==