ButtonCol form hidden fields (#90)

Author: plumdog

README.md

@@ -263,8 +263,9 @@ the `button_attrs` kwarg.
 You can pass a dict of attributes to add to the form element with
 the `form_attrs` kwarg.
 
-[[Possible future work: make it so you can specify hidden fields to be
-added into the form.]]
+You can pass a dict of hidden fields to add into the form element with
+the `form_hidden_fields` kwargs. The keys will be used as the `name`
+attributes and the values as the `value` attributes.
 
 More about `NestedTableCol`
 ---------------------------

flask_table/columns.py

@@ -315,7 +315,7 @@ class ButtonCol(LinkCol):
 
     def __init__(self, name, endpoint, attr=None, attr_list=None,
                  url_kwargs=None, button_attrs=None, form_attrs=None,
-                 **kwargs):
+                 form_hidden_fields=None, **kwargs):
         super(ButtonCol, self).__init__(
             name,
             endpoint,
@@ -324,6 +324,7 @@ def __init__(self, name, endpoint, attr=None, attr_list=None,
             url_kwargs=url_kwargs, **kwargs)
         self.button_attrs = button_attrs or {}
         self.form_attrs = form_attrs or {}
+        self.form_hidden_fields = form_hidden_fields or {}
 
     def td_contents(self, item, attr_list):
         button_attrs = dict(self.button_attrs)
@@ -338,10 +339,21 @@ def td_contents(self, item, attr_list):
             method='post',
             action=self.url(item),
         ))
+        form_hidden_fields_elements = [
+            element(
+                'input',
+                attrs=dict(
+                    type='hidden',
+                    name=name,
+                    value=value))
+            for name, value in sorted(self.form_hidden_fields.items())]
         return element(
             'form',
             attrs=form_attrs,
-            content=button,
+            content=[
+                ''.join(form_hidden_fields_elements),
+                button
+            ],
             escape_content=False,
         )
 

flask_table/html.py

@@ -25,6 +25,8 @@ def _format_attrs(attrs, escape_attrs=True):
 
 
 def _format_content(content, escape_content=True):
+    if isinstance(content, (list, tuple)):
+        content = ''.join(content)
     if escape_content:
         return Markup.escape(content)
     return content

tests/__init__.py

@@ -657,6 +657,28 @@ def test_one(self):
             'button_form_attrs_test', 'test_one', items)
 
 
+class ButtonHiddenFieldsTest(FlaskTableTest):
+
+    class MyTable(Table):
+        name = Col('Name')
+        view = ButtonCol(
+            'Delete',
+            'delete',
+            url_kwargs=dict(id_='id'),
+            form_hidden_fields=dict(
+                name1='value1',
+                name2='value2',
+            )
+        )
+
+    maxDiff = None
+
+    def test_one(self):
+        items = [Item(name='one', id=1)]
+        self.assert_html_equivalent_from_file(
+            'button_hidden_fields_test', 'test_one', items)
+
+
 class BoolTest(TableTest):
 
     class MyTable(Table):

tests/html/button_hidden_fields_test/test_one.html

@@ -0,0 +1,20 @@
+<table>
+  <thead>
+    <tr>
+      <th>Name</th>
+      <th>Delete</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>one</td>
+      <td>
+	<form action="/delete/1" method="post">
+      <input name="name1" type="hidden" value="value1"></input>
+      <input name="name2" type="hidden" value="value2"></input>
+	  <button type="submit">Delete</button>
+	</form>
+      </td>
+    </tr>
+  </tbody>
+</table>