Merge pull request #4385 from open-formulieren/fix/4363-checkboxes-ra…

…dio-value-description-not-translated [#4363] Missing translated description from the values of the components
open-formulieren · Jun 14, 2024 · 41eb77f · 41eb77f
2 parents 4079d14 + dd0e91d
commit 41eb77f
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 7 deletions.
diff --git a/src/openforms/formio/components/translations.py b/src/openforms/formio/components/translations.py
@@ -7,12 +7,18 @@ def translate_options(
     enabled: bool,
 ) -> None:
     for option in options:
-        if not (translations := option.get("openForms", {}).get("translations")):
+        if "openForms" not in option:
             continue
 
-        translated_label = translations.get(language_code, {}).get("label", "")
-        if enabled and translated_label:
-            option["label"] = translated_label
+        if not (translations := option["openForms"].get("translations")):
+            continue
+
+        if enabled and (_translations := translations.get(language_code)):
+            if translated_label := _translations.get("label"):
+                option["label"] = translated_label
+
+            if translated_description := _translations.get("description"):
+                option["description"] = translated_description
 
         # always clean up
-        del option["openForms"]["translations"]  # type: ignore
+        del option["openForms"]["translations"]
diff --git a/src/openforms/formio/tests/test_component_translations.py b/src/openforms/formio/tests/test_component_translations.py
@@ -553,7 +553,10 @@ def test_options_translated(self, lang_code, translation):
                     "label": "First option",
                     "openForms": {
                         "translations": {
-                            lang_code: {"label": translation},
+                            lang_code: {
+                                "label": translation,
+                                "description": translation,
+                            },
                         }
                     },
                 }
@@ -565,8 +568,11 @@ def test_options_translated(self, lang_code, translation):
         assert "values" in component
         opt1 = component["values"][0]
         assert "label" in opt1
+        assert "description" in opt1
         assert "openForms" in opt1
+
         self.assertEqual(opt1["label"], translation)
+        self.assertEqual(opt1["description"], translation)
         self.assertNotIn("translations", opt1["openForms"])
 
 
@@ -726,7 +732,10 @@ def test_options_translated(self, lang_code, translation):
                     "label": "First option",
                     "openForms": {
                         "translations": {
-                            lang_code: {"label": translation},
+                            lang_code: {
+                                "label": translation,
+                                "description": translation,
+                            },
                         }
                     },
                 }
@@ -738,8 +747,10 @@ def test_options_translated(self, lang_code, translation):
         assert "values" in component
         opt1 = component["values"][0]
         assert "label" in opt1
+        assert "description" in opt1
         assert "openForms" in opt1
         self.assertEqual(opt1["label"], translation)
+        self.assertEqual(opt1["description"], translation)
         self.assertNotIn("translations", opt1["openForms"])
 
 

diff --git a/src/openforms/formio/typing/base.py b/src/openforms/formio/typing/base.py
@@ -52,6 +52,7 @@ class OptionDict(TypedDict):
 
     value: str
     label: str
+    description: NotRequired[str]
     openForms: NotRequired[OpenFormsOptionExtension]