Version 20 (modified by Dominic König, 11 years ago) ( diff )


S3 FilterForms

Filter forms allow the user to apply filters to interactive views (e.g. data tables, data lists, reports etc.).


The framework for filter forms consists of 4 core elements:


  • filter widgets to facilitate user input of filter criteria
  • a filter script to collect all values from filter widgets and convert them into a URL query


  • the REST interface to interpret and apply the URL query as resource filter
  • a filter form builder to render the filter widgets and populate them with the values from the URL query

Filter Forms Framework

URL Queries

Filter Widgets


All filter widgets are subclasses of the S3FilterWidget class. This base class only defines the API, i.e. it does not render a filter widget - it's only used here to describe the common API of all filter widget classes.

For the configuration, a widget instance is created like:

instance = S3FilterWidget(field=None, **attr)
  • field is the field selector (list of field selectors) for the field(s) to filter by (required)
  • attr are keyword attributes for the widget, where those starting with an underscore are the HTML attributes, while all others are widget options (see the particular widget for details)

The widget is then rendered by calling it:

widget = instance(resource, get_vars=None, alias=None)
  • resource is the resource to filter (required)
  • get_vars is the dict of GET vars from the previous request (used to populate the widget, required but can be empty)
  • alias is the component alias to use for the URL query (optional, needed if resource is not the master resource of the request)

The base class S3FilterWidget and all its subclasses are defined in modules/s3/


S3TextFilter renders a text input field to filter text fields in the resource for strings.

instance = S3TextFilter(field, _class="class", _size=40, _name="name")
  • field is a field selector (or a list of field selectors) for the field(s) to filter by
  • _class is a custom CSS class to set for the widget
  • _size is the input field width in characters (HTML attribute)
  • _name is a name for the input field (HTML attribute)

Note: if multiple strings are entered by the user, each of them (AND) must appear in any of the fields (OR) specified by the field selectors. All fields must be type "string" or "text".


  • tbw


  • tbw

Filter Forms

Configuration of Filter Forms in S3CRUD

S3CRUD has filter forms integrated in the /datatable and /datalist pages (these methods are temporary until replaced by a new resource view page).

For these pages, the filter widgets are configured per resource as a list of filter widget instances in the "filter_widgets"-setting like:

                 S3TextFilter(["name", "email", "comments"],
                              comment=T("Search for office by text.")),
                                 comment=T("Search for office by organization."),

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
filter_submit_urlURL stringwhere to request filtered data fromURL of the current call
filter_ajax_urlURL stringwhere to request updated filter options fromURL of the current call with /filter method
filter_formstyleFormstyle functionAlternative formstyle for the filter formbuilt-in formstyle
filter_submitStringLabel for the submit button or tupel of (label, class) to also specify a CSS class for the buttonT("Search")



  • tbw

Python Classes

  • tbw

JavaScript Methods

  • tbw

Implementing Filter Widgets

  • tbw

Using Filter Forms in REST Method Handlers

  • tbw

Using Filter Forms in Custom Controllers

  • tbw

Attachments (5)

Download all attachments as: .zip

Note: See TracWiki for help on using the wiki.