Added support for rendering hints on individual radio button choices, matching the existing checkbox functionality

Author: miriam-z

lung_cancer_screening/nhsuk_forms/jinja2/radios.jinja

@@ -6,11 +6,15 @@
 {% set ns = namespace(items=[]) %}
 {% for value, text in unbound_field.choices %}
   {% set conditional_html = field.conditional_html(value) %}
+  {% set hint_text = field.get_hint_for_choice(value) %}
   {% set ns.items = ns.items + [{
     "id": field.auto_id if loop.first,
     "value": value,
     "text": text,
     "checked": field.value() == value,
+    "hint": {
+      "text": hint_text
+    } if hint_text else undefined,
     "conditional": {
       "html": conditional_html
     } if conditional_html else undefined

lung_cancer_screening/nhsuk_forms/tests/unit/test_choice_field.py

@@ -1,7 +1,7 @@
 from django.test import TestCase
 from django.forms import Form
 
-from ...choice_field import ChoiceField
+from ...choice_field import ChoiceField, MultipleChoiceField
 
 class TestForm(Form):
     field = ChoiceField(
@@ -11,6 +11,13 @@ class TestForm(Form):
         hint="Pick either one",
     )
 
+class TestMultipleChoiceForm(Form):
+    field = MultipleChoiceField(
+        label="Select options",
+        choices=(("a", "Option A"), ("b", "Option B"), ("c", "Option C")),
+        hint="Select all that apply",
+    )
+
 class TestChoiceField(TestCase):
     def test_renders_nhs_radios(self):
         self.assertHTMLEqual(
@@ -74,3 +81,72 @@ class TestForm(Form):
             </div>
             """,
         )
+
+    def test_checkbox_field_with_choice_hints(self):
+        """Test that choice hints are rendered correctly for checkbox fields"""
+        form = TestMultipleChoiceForm()
+        bound_field = form["field"]
+
+        # Add hints for specific choices
+        bound_field.add_hint_for_choice("a", "This is hint for option A")
+        bound_field.add_hint_for_choice("b", "This is hint for option B")
+
+        rendered_html = bound_field.as_field_group()
+
+        # Verify the hints are rendered
+        self.assertIn('This is hint for option A', rendered_html)
+        self.assertIn('This is hint for option B', rendered_html)
+        self.assertIn('aria-describedby="id_field_0-item-hint"', rendered_html)
+        self.assertIn('aria-describedby="id_field_1-item-hint"', rendered_html)
+
+    def test_get_hint_for_choice_returns_correct_hint(self):
+        """Test that get_hint_for_choice returns the correct hint text"""
+        form = TestMultipleChoiceForm()
+        bound_field = form["field"]
+
+        # Add a hint
+        bound_field.add_hint_for_choice("a", "Hint for A")
+
+        # Verify the hint can be retrieved
+        self.assertEqual(bound_field.get_hint_for_choice("a"), "Hint for A")
+
+    def test_get_hint_for_choice_returns_none_when_no_hint(self):
+        """Test that get_hint_for_choice returns None when no hint is set"""
+        form = TestMultipleChoiceForm()
+        bound_field = form["field"]
+
+        # No hint added, should return None
+        self.assertIsNone(bound_field.get_hint_for_choice("a"))
+
+    def test_checkbox_field_renders_without_hints_when_none_added(self):
+        """Test that checkbox field renders correctly when no hints are added"""
+        form = TestMultipleChoiceForm()
+        rendered_html = form["field"].as_field_group()
+
+        # Should render without hint elements
+        self.assertNotIn('nhsuk-checkboxes__hint', rendered_html)
+
+    def test_radio_field_with_choice_hints(self):
+        """Test that choice hints are rendered correctly for radio fields"""
+        form = TestForm()
+        bound_field = form["field"]
+
+        # Add hints for specific choices
+        bound_field.add_hint_for_choice("a", "This is hint for option A")
+        bound_field.add_hint_for_choice("b", "This is hint for option B")
+
+        rendered_html = bound_field.as_field_group()
+
+        # Verify the hints are rendered
+        self.assertIn('This is hint for option A', rendered_html)
+        self.assertIn('This is hint for option B', rendered_html)
+        self.assertIn('aria-describedby="id_field-item-hint"', rendered_html)
+        self.assertIn('aria-describedby="id_field-2-item-hint"', rendered_html)
+
+    def test_radio_field_renders_without_hints_when_none_added(self):
+        """Test that radio field renders correctly when no hints are added"""
+        form = TestForm()
+        rendered_html = form["field"].as_field_group()
+
+        # Should render without hint elements for individual items
+        self.assertNotIn('nhsuk-radios__hint', rendered_html)