Changes between Version 12 and Version 13 of S3/DynamicTables

Timestamp:

02/22/17 11:28:57 (9 years ago)

Author:

Dominic König

Comment:

--

S3/DynamicTables

@@ -83 +83 @@
 ||component_key||boolean||default False||indicates that this field is a foreign key to link to the master table (see dynamic components), field must be a reference||
 ||component_alias||string||no||the alias to access the table as component||
+||component_tab||boolean||default False||expose the component on a tab||
+
 === Managing dynamic models through the web UI ===
 
@@ -212 +214 @@
 GET http://localhost:8000/eden/org/organisation/8/rating
 }}}
+
+=== Exposing Dynamic Components on Tabs ===
+
+To expose a dynamic component as a tab in the master record perspective, set component_tab=True for the component key:
+
+{{{#!python
+    # Component key
+    {"name": "organisation_id",
+     "field_type": "reference org_organisation",
+     "component_key": True,
+     "component_alias": "rating",
+
+     # Expose a component tab:
+     "component_tab": True,
+
+     },
+}}}
+
+The component alias will be used to generate a tab label. To override this, configure a {{{tab_label}}} in the field settings:
+
+{{{#!python
+    # Component key
+    {"name": "organisation_id",
+     "field_type": "reference org_organisation",
+     "component_key": True,
+     "component_alias": "rating",
+     "component_tab": True,
+
+     # Field settings to control the component tab:
+     "settings": {
+        "tab_label": "Performance Ratings",
+        },
+     },
+}}}
+
+The tab will be appended to the existing component tabs. To determine a tab position add a {{{tab_position}}} setting:
+
+{{{#!python
+    # Component key
+    {"name": "organisation_id",
+     "field_type": "reference org_organisation",
+     "component_key": True,
+     "component_alias": "rating",
+     "component_tab": True,
+
+     # Field settings to control the component tab:
+     "settings": {
+        "tab_label": "Performance Ratings",
+        "tab_position": 2,
+        },
+     },
+}}}
+