Convert checkbox document elements to HTML checkboxes

mammoth/conversion.py

@@ -165,6 +165,15 @@ def visit_hyperlink(self, hyperlink, context):
         return [html.collapsible_element("a", attributes, nodes)]
 
 
+    def visit_checkbox(self, checkbox, context):
+        attributes = {"type": "checkbox"}
+
+        if checkbox.checked:
+            attributes["checked"] = "checked"
+
+        return [html.element("input", attributes)]
+
+
     def visit_bookmark(self, bookmark, context):
         element = html.collapsible_element(
             "a",

mammoth/documents.py

@@ -65,6 +65,12 @@ class Hyperlink(HasChildren):
     anchor = cobble.field()
     target_frame = cobble.field()
 
+@cobble.data
+class Checkbox(Element):
+    checked = cobble.field()
+
+checkbox = Checkbox
+
 @cobble.data
 class Table(HasChildren):
     style_id = cobble.field()

tests/conversion_tests.py

@@ -339,6 +339,20 @@ def test_hyperlink_target_frame_is_used_as_anchor_target():
     assert_equal('<a href="#start" target="_blank">Hello</a>', result.value)
 
 
+def test_unchecked_checkbox_is_converted_to_unchecked_checkbox_input():
+    result = convert_document_element_to_html(
+        documents.checkbox(checked=False),
+    )
+    assert_equal('<input type="checkbox" />', result.value)
+
+
+def test_checked_checkbox_is_converted_to_checked_checkbox_input():
+    result = convert_document_element_to_html(
+        documents.checkbox(checked=True),
+    )
+    assert_equal('<input checked="checked" type="checkbox" />', result.value)
+
+
 def test_bookmarks_are_converted_to_anchors_with_ids():
     result = convert_document_element_to_html(
         documents.bookmark(name="start"),