Feature/4717 accessibility improvements aria #4747

robinmolen · 2024-10-10T09:42:29Z

Changes

The site logo now provides a better textual alternative, the error message element now has the appropriate role and the PDF's are now screenreader friendly :)

Checklist

Check off the items that are completed or not relevant.

Impact on features
- Checked copying a form
- Checked import/export of a form
- Config checks in the configuration overview admin page
- Problem detection in the admin email digest is handled
Release management
- I have labelled the PR as "needs-backport" accordingly
I have updated the translations assets (you do NOT need to provide translations)
- Ran ./bin/makemessages_js.sh
- Ran ./bin/compilemessages_js.sh
Commit hygiene
- Commit messages refer to the relevant Github issue
- Commit messages explain the "why" of change, not the how

codecov · 2024-10-10T12:20:50Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.55%. Comparing base (4c53505) to head (b5daa22).
Report is 7 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #4747   +/-   ##
=======================================
  Coverage   96.55%   96.55%           
=======================================
  Files         748      748           
  Lines       25413    25417    +4     
  Branches     3358     3361    +3     
=======================================
+ Hits        24538    24542    +4     
  Misses        610      610           
  Partials      265      265

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

sergei-maertens · 2024-10-29T12:58:06Z

src/openforms/formio/rendering/tests/test_list_components.py

+        renderer = Renderer(self.submission, mode=RenderModes.pdf, as_html=True)
+        # set up mock registry without special fieldset/editgrid behaviour
+        register = Registry()
+
+        nodelist = []
+        with patch("openforms.formio.rendering.registry.register", new=register):
+            for component in self.step.form_step.form_definition.configuration[
+                "components"
+            ]:
+                if component["type"] == "selectboxes" or component["type"] == "radio":
+                    component_node = ChoicesNode(
+                        step_data=self.step.data, component=component, renderer=renderer
+                    )
+                elif component["type"] == "select":
+                    component_node = SelectNode(
+                        step_data=self.step.data, component=component, renderer=renderer
+                    )
+                elif component["type"] == "textfield":
+                    component_node = TextNode(
+                        step_data=self.step.data, component=component, renderer=renderer
+                    )
+                nodelist += list(component_node)


This is supposed to use our actual implemetnations, no? I don't understand why a separate registry is being set up and component nodes instantiated directly rather than that the factory ComponentNode.build_node(...) is used for each component which looks up the appropriate specialized class in the registry.

I'd also expect this test to be a test def test_render_mode_pdf_with_list_values(self) in openforms.formio.rendering.tests.test_component_node rather than its own class and file. Note that I also renamed that test case name in my PR because it was a bad copy paste, so if you apply that same change we shouldn't get any merge conflicts.

Yeah... this is a part of the value_list concept..
With my changes to remove the value_list and to add the expected html to the display_value, i've also changed this test

I don't fully understand your comment about the test case naming... but I think it should be fine now..

sergei-maertens · 2024-10-29T13:00:35Z

src/openforms/formio/rendering/tests/test_list_components.py

+    @classmethod
+    def setUpTestData(cls):
+        super().setUpTestData()


Preferably set up the test data inside the test itself rather than creating context switches. You only have a single test, so this test data is only relevant for that single test anyway.

Okay check, i'll keep that in mind.. 👍

src/openforms/submissions/templates/report/submission_report.html

src/openforms/submissions/tests/test_tasks_pdf.py

src/openforms/templates/includes/page-header.html

src/openforms/utils/pdf.py

src/openforms/ui/tests/test_header.py

src/openforms/submissions/tests/test_submission_report.py

src/openforms/formio/rendering/default.py

src/openforms/formio/formatters/base.py

src/openforms/formio/rendering/tests/test_component_node.py

src/openforms/templates/includes/page-header.html

src/openforms/submissions/tests/test_tasks_pdf.py

… html

robinmolen linked an issue Oct 10, 2024 that may be closed by this pull request

Accessibility improvements - Aria tags #4717

Closed

3 tasks

robinmolen force-pushed the feature/4717-accessibility-improvements-aria branch from 3754d30 to 588e215 Compare October 17, 2024 11:47

robinmolen marked this pull request as ready for review October 17, 2024 11:51

robinmolen force-pushed the feature/4717-accessibility-improvements-aria branch from 588e215 to 051122f Compare October 22, 2024 08:25

sergei-maertens requested changes Oct 29, 2024

View reviewed changes

robinmolen force-pushed the feature/4717-accessibility-improvements-aria branch 2 times, most recently from 8160754 to f3ac6c9 Compare November 4, 2024 16:12

robinmolen commented Nov 8, 2024

View reviewed changes

src/openforms/formio/formatters/base.py Outdated Show resolved Hide resolved

robinmolen commented Nov 8, 2024

View reviewed changes

src/openforms/formio/formatters/base.py Outdated Show resolved Hide resolved

robinmolen commented Nov 8, 2024

View reviewed changes

src/openforms/formio/rendering/tests/test_component_node.py Show resolved Hide resolved

robinmolen commented Nov 8, 2024

View reviewed changes

src/openforms/templates/includes/page-header.html Outdated Show resolved Hide resolved

robinmolen force-pushed the feature/4717-accessibility-improvements-aria branch from f3ac6c9 to 97fbb37 Compare November 11, 2024 11:50

sergei-maertens reviewed Nov 11, 2024

View reviewed changes

src/openforms/submissions/tests/test_tasks_pdf.py Outdated Show resolved Hide resolved

robinmolen added 2 commits November 11, 2024 14:32

♿ [#4717] Header logo textual content

defc524

♿ [#4717] Added role alert to ErrorMessage

f09205f

robinmolen force-pushed the feature/4717-accessibility-improvements-aria branch from 97fbb37 to 973f78d Compare November 11, 2024 13:34

robinmolen added 4 commits November 11, 2024 14:48

♿ [#4717] Render pdf as accessible html

60ac8b6

✅ [#4717] Added tests for components with multiple values rendered as…

cf118d4

… html

✅ [#4717] Fixed tests

aebf3aa

♿ [#4717] Added textual alternative to pdf logo content

b5daa22

robinmolen force-pushed the feature/4717-accessibility-improvements-aria branch from 973f78d to b5daa22 Compare November 11, 2024 13:49

sergei-maertens approved these changes Nov 12, 2024

View reviewed changes

sergei-maertens merged commit 6b715c6 into master Nov 12, 2024
34 checks passed

sergei-maertens deleted the feature/4717-accessibility-improvements-aria branch November 12, 2024 09:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/4717 accessibility improvements aria #4747

Feature/4717 accessibility improvements aria #4747

robinmolen commented Oct 10, 2024

codecov bot commented Oct 10, 2024 •

edited

Loading

sergei-maertens Oct 29, 2024

robinmolen Nov 6, 2024

robinmolen Nov 6, 2024

sergei-maertens Oct 29, 2024

robinmolen Nov 6, 2024

Feature/4717 accessibility improvements aria #4747

Feature/4717 accessibility improvements aria #4747

Conversation

robinmolen commented Oct 10, 2024

codecov bot commented Oct 10, 2024 • edited Loading

Codecov Report

sergei-maertens Oct 29, 2024

Choose a reason for hiding this comment

robinmolen Nov 6, 2024

Choose a reason for hiding this comment

robinmolen Nov 6, 2024

Choose a reason for hiding this comment

sergei-maertens Oct 29, 2024

Choose a reason for hiding this comment

robinmolen Nov 6, 2024

Choose a reason for hiding this comment

codecov bot commented Oct 10, 2024 •

edited

Loading