Changes between Version 4 and Version 5 of S3/S3SQLForm

Timestamp:

09/03/12 11:41:28 (13 years ago)

Author:

Dominic König

Comment:

--

S3/S3SQLForm

@@ -107 +107 @@
 The first argument of S3SQLInlineComponent is the resource alias name (usually the tablename without module prefix).
 
-Where multiple sub-forms for the same component (e.g. with different filters) shall be embedded, they must each have a distinct "name" argument. (Filtering is not implemented yet - but will come soon). Otherwise this argument is optional.
+To filter an inline component by e.g. type, you can a {{{filterby}}} option like in:
+
+{{{
+    S3SQLInlineComponent(
+        "contact",
+        name="email",
+        label=T("Email Addresses"),
+        fields=["value"],
+        filterby = dict(
+            field = "contact_method",
+            options = "EMAIL"
+        )
+    ),
+}}}
+
+The filterby settings is a dict (or a list of dicts for multiple filters), containing:
+
+||'''Attribute'''||'''Explanation'''||
+||field||the name of field to filter by||
+||options||the allowed options for this field, a single value or a list of values||
+||invert||True to invert this filter (default False)||
+||default||default value for this field (if only one option is given and invert is False, then that option will automatically be the default value - unless you specify something else)||
+
+Where multiple sub-forms for the same component (but with different filters) shall be embedded, they must each have a distinct "name" argument. Otherwise this argument is optional.
 
 You can also specify a label (title) for the subform using the "label" argument (optional)
@@ -121 +144 @@
 - some form widgets may not yet be supported in inline-components (e.g. Autocompletes), or show unexpected behavior.
 - there is no specific CSS formatting for inline-components yet
-- Authorization of inline-components is incomplete
-- Filtering of inline-components is not implemented yet
+- ~~Authorization of inline-components is incomplete~~
+- ~~Filtering of inline-components is not implemented yet~~
 - Link-table components are not properly supported in inline-components yet