= S3 FilterForms =
[[TOC]]

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

== Framework ==

The framework for filter forms consists of 3 core components:

'''Client-side:'''
  - a '''filter script''' to collect all values from filter widgets and convert them into a URL query

'''Server-side:'''
  - the '''REST interface''' to interpret and apply the URL query as resource filter
  - a '''filter form builder''' to render the filter form and prepopulate it with the values from the URL query

[[Image(filterforms.png)]]
== Filter Widgets ==

  * ''tbw''

== Filter Forms ==

  * ''tbw''

== Development ==

=== Components ===

  * ''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''

----
- [wiki:S3 S3 API Guide]
- DeveloperGuidelines